Skip to content

Update observability.md #124906

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+11 −1
Open

Update observability.md #124906

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
039731b
Update observability.md
azarboon Nov 21, 2024
b7aab91
Update observability.md
azarboon Nov 21, 2024
7371f22
Merge branch 'main' into patch-1843
v-dirichards May 22, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update observability.md
  • Loading branch information
@azarboon
azarboon authored Nov 21, 2024
commit b7aab9132e151e4a118467dc0d02b43d5c0247ac
5 changes: 3 additions & 2 deletions articles/api-management/observability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,9 @@ The table below summarizes all the observability capabilities supported by API M
## Best practices

The following practices can enhance your API observability:
- Granular monitoring: Enable [per-method metrics](https://learn.microsoft.com/azure/api-management/api-management-howto-use-azure-monitor) for detailed insights into response times and error rates.
- Proactive alerting: Set up per-method [alerts](https://learn.microsoft.com/azure/azure-monitor/reference/supported-metrics/microsoft-apimanagement-service-metrics) for latency, error rates, and low success rates, using rates instead of counts to avoid skewing.
- Granular monitoring: Enable [per-method](https://learn.microsoft.com/azure/api-management/api-management-howto-use-azure-monitor) metrics for detailed insights into response times and error rates.
- Tail latency monitoring: Configure per-method alerts for tail latency (e.g., 90th, 95th, or 99th [percentile](https://learn.microsoft.com/kusto/query/percentiles-aggregation-function)), as average latency can be misleading. To implement this, use Kusto Query Language (KQL) to forward logs to a Log Analytics workspace.
- Proactive Alerting: Establish per-method alerts for error rates and low success [rates](https://learn.microsoft.com/azure/azure-monitor/reference/supported-metrics/microsoft-apimanagement-service-metrics) , utilizing rates instead of counts to ensure accuracy.
- Distributed tracing: Enable [tracing](https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-app-insights?tabs=rest) to identify performance bottlenecks and troubleshoot issues.
- Resource tagging: Apply [tags to APIs](https://learn.microsoft.com/rest/api/apimanagement/tag/assign-to-api) for accurate cost tracking and allocation.

Expand Down