Skip to content

Add Azure Monitor integration documentation (docs/azure-monitor.mdx) #997

@yashksaini-coder

Description

@yashksaini-coder

Summary

AzureMonitorLogsTool is a production-ready tool that queries Azure Log Analytics via the REST API, but it has no user-facing documentation. Every other major integration (Datadog, Grafana, Elasticsearch, Coralogix, etc.) has a matching docs/<name>.mdx file — Azure Monitor is missing one.

Context

The tool (app/tools/AzureMonitorLogsTool/) requires three credentials:

  • workspace_id — the Log Analytics Workspace ID (from Azure portal)
  • access_token — an Azure AD access token (OAuth2 Bearer) with Data.Read permission on the workspace
  • endpoint — defaults to https://api.loganalytics.io

It accepts KQL queries and enforces a max result limit of 200 rows.

What to write

Create docs/azure-monitor.mdx following the structure of an existing integration doc (e.g., docs/coralogix.mdx or docs/betterstack.mdx). Include:

  1. Overview — what Azure Monitor Log Analytics is, what the tool retrieves
  2. Prerequisites — Azure subscription, Log Analytics Workspace, service principal with Log Analytics Reader role
  3. Getting credentials — step-by-step: how to find the Workspace ID, how to generate an access token (Azure AD app registration + client credentials flow)
  4. Configuration — how to add the integration in opensre (env vars or opensre configure wizard), with an example config block
  5. Verification — how to confirm the integration is working (opensre doctor or equivalent)
  6. Example KQL queries — 2–3 practical examples (e.g., fetch recent errors, count by severity)
  7. Troubleshooting — common errors (401 Unauthorized, empty results, wrong endpoint)

Acceptance criteria

  • docs/azure-monitor.mdx created and follows the structure of existing integration docs
  • Covers prerequisites, credential setup, configuration, and verification
  • At least two KQL query examples included
  • Troubleshooting section covers 401 and empty-result scenarios
  • No broken links or malformed MDX syntax

References

  • Existing integration docs: docs/coralogix.mdx, docs/betterstack.mdx, docs/elasticsearch.mdx
  • Tool source (for accurate parameter names): app/tools/AzureMonitorLogsTool/__init__.py
  • Related: issue Add unit tests for AzureMonitorLogsTool #996 (unit tests for the same tool)

Metadata

Metadata

Assignees

Labels

docsDocumentation-focused workdocumentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions