Skip to content

Add context to Azure integration documentation#3072

Merged
ellis-elastic merged 22 commits intoelastic:mainfrom
ellis-elastic:Azure-docs
Jun 23, 2022
Merged

Add context to Azure integration documentation#3072
ellis-elastic merged 22 commits intoelastic:mainfrom
ellis-elastic:Azure-docs

Conversation

@ellis-elastic
Copy link
Copy Markdown
Contributor

@ellis-elastic ellis-elastic commented Apr 12, 2022

Adds context to the Azure integration documentation

added links to Microsoft's documentation and tidied up the markdown
@ellis-elastic ellis-elastic requested a review from a team as a code owner April 12, 2022 09:13
@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Apr 12, 2022

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-06-22T23:04:53.748+0000

  • Duration: 13 min 52 sec

Test stats 🧪

Test Results
Failed 0
Passed 89
Skipped 0
Total 89

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@ellis-elastic ellis-elastic changed the title Update Azure_logs readme Update Azure readme Apr 12, 2022
@ellis-elastic ellis-elastic marked this pull request as draft April 13, 2022 15:11
@ellis-elastic ellis-elastic added the documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. label Apr 14, 2022
@ellis-elastic ellis-elastic marked this pull request as ready for review April 19, 2022 14:18
@ruflin ruflin added the Team:Cloud-Monitoring Label for the Cloud Monitoring team label Jun 8, 2022
removed spaces in links.
Copy link
Copy Markdown
Contributor

@tommyers-elastic tommyers-elastic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes look good! - can we get this rebased and merged?

ellis-elastic and others added 2 commits June 20, 2022 09:15
added links to supplier's documentation
@bmorelli25
Copy link
Copy Markdown
Member

Looks like this needs to be built again:

[2022-06-20T08:29:02.031Z] README.md is outdated. Rebuild the package with 'elastic-package build'

@bmorelli25
Copy link
Copy Markdown
Member

bmorelli25 commented Jun 21, 2022

Updated to match the new documentation guidelines for integrations (#3433). Also changed from a minor bump to a patch release.

@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Jun 21, 2022

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (6/6) 💚
Files 78.571% (11/14) 👎 -17.996
Classes 78.571% (11/14) 👎 -17.996
Methods 77.876% (88/113) 👎 -10.938
Lines 81.516% (1570/1926) 👎 -8.43
Conditionals 100.0% (0/0) 💚

Comment on lines 4 to 7
Use the Azure logs integration to collect logs from Azure.
Then visualize that data in Kibana, create alerts to notify you if something goes wrong,
and reference data when troubleshooting an issue.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewers: I'd love to add an example here. Can you help?

To assist, here's what we have for the system integration:

For example, if you wanted to be notified when less than 10% of the disk space is still available, you
could install the System integration to send file system metrics to Elastic.
Then, you could view real-time updates to disk space used on your system in Kibana's [Metrics System] Overview dashboard.
You could also set up a new rule in the Elastic Observability Metrics app to alert you when the percent free is
less than 10% of the total disk space.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if there is an Elastic style rule on this, but IMHO "you must" would be better than "you have to".
You could even use the RFC 2119 rules.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bmorelli25, for the example, I have a couple of ideas we can work on:

  • Azure sign-in logs are often used in security scenarios, like tracking the number of failed sign-in attempts and detecting possible brute force attacks.
  • Azure activity logs deliver information like a VM failed to start because we exceeded a quota limit. We want to keep track of these events to better plan our capacity and negotiations with Azure representatives.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zmoog these are perfect! Added. Let me know what you think.

@ellis-elastic agreed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bmorelli25 examples LGTM!

@bmorelli25 bmorelli25 dismissed their stale review June 22, 2022 21:06

outdated

@bmorelli25 bmorelli25 requested review from a team and colleenmcginnis June 22, 2022 21:07
@bmorelli25 bmorelli25 changed the title Update Azure readme Add context to Azure integration documentation Jun 22, 2022
Copy link
Copy Markdown
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a few comments about consistency!

@ellis-elastic ellis-elastic merged commit 0a8afd5 into elastic:main Jun 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Team:Cloud-Monitoring Label for the Cloud Monitoring team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants