Skip to content

Conversation

@zmoog
Copy link
Contributor

@zmoog zmoog commented May 9, 2025

Proposed commit message

Add a table with all the supported log categories and the destination dataset. It also highlights that the integration indexes the unsupported log categories using the azure.platformlogs dataset.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

How to test this PR locally

cd azure/packages elastic-package build && elastic-package stack up -d -v --version 8.17.0 

Screenshots

CleanShot 2025-05-09 at 20 12 01@2x

@zmoog zmoog self-assigned this May 9, 2025
@zmoog zmoog added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:azure Azure Logs Team:obs-ds-hosted-services Observability Hosted Services team [elastic/obs-ds-hosted-services] Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] labels May 9, 2025
@elastic-vault-github-plugin-prod
Copy link

elastic-vault-github-plugin-prod bot commented May 9, 2025

🚀 Benchmarks report

Package azure 👍(8) 💚(2) 💔(1)

Expand to view
Data stream Previous EPS New EPS Diff (%) Result
identity_protection 4166.67 3508.77 -657.9 (-15.79%) 💔

To see the full report comment with /test benchmark fullreport

@zmoog zmoog added the Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations] label May 9, 2025
@zmoog zmoog marked this pull request as ready for review May 9, 2025 10:36
@zmoog zmoog requested review from a team as code owners May 9, 2025 10:36
@elasticmachine
Copy link

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)

@zmoog zmoog requested a review from alaudazzi May 9, 2025 18:13
zmoog and others added 2 commits May 9, 2025 20:54
Co-authored-by: kaiyan-sheng <kaiyan.sheng@elastic.co>
@elastic-sonarqube
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@elasticmachine
Copy link

💚 Build Succeeded

History

cc @zmoog

Comment on lines +72 to +76
Use the following table to identify the target data streams for each log category. For example, if the integration receives a log event with the `NonInteractiveUserSignInLogs` category, it will infer `azure.signinlogs` as dataset, indexing the log into `logs-azure.signinlogs-default` data stream.

| Data Stream | Log Category |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `logs-azure.activitylogs-*` | Administrative, Security, ServiceHealth, Alert, Recommendation, Policy, Autoscale, ResourceHealth |
Copy link
Contributor

@efd6 efd6 May 11, 2025

Choose a reason for hiding this comment

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

I'm wondering about the typeface agreement between the text in the description and the text in the table; in the description we have NonInteractiveUserSignInLogs, but in the table we have NonInteractiveUserSignInLogs. 99.9999% of people won't notice this, but it did confuse me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, after I looked at the last screenshot, I had a similar thought. Your comment confirms to me that it's not something I should overlook.

Copy link
Contributor

@efd6 efd6 left a comment

Choose a reason for hiding this comment

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

Query about typesetting, but you can ignore it if you do not think it is important.

@zmoog zmoog merged commit c0c77f7 into elastic:main May 12, 2025
7 checks passed
@zmoog
Copy link
Contributor Author

zmoog commented May 12, 2025

I merged this PR earlier than planned. I'll open another PR to align the typefaces and update the changelog.

@zmoog zmoog deleted the zmoog/docs/log-categories-routing-rules branch May 12, 2025 15:50
@elastic-vault-github-plugin-prod

Package azure - 1.23.3 containing this change is available at https://epr.elastic.co/package/azure/1.23.3/

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. Integration:azure Azure Logs Team:obs-ds-hosted-services Observability Hosted Services team [elastic/obs-ds-hosted-services] Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations]

6 participants