Skip to content
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.

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

Update observability.md #124906

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

azarboon
Copy link
Contributor

@azarboon azarboon commented Nov 21, 2024

I've added some best practices that can help readers to better observe their API management instance. I believe it can be helpful, especially for beginners because it can give them actionable advice. Current page mainly shows an overview of existing services, and users have to read each service page then figure out maybe they should choose each service, and how.

Copy link
Contributor

@azarboon : Thanks for your contribution! The author(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit 039731b:

⚠️ Validation status: warnings

File Status Preview URL Details
articles/api-management/observability.md ⚠️Warning Details

articles/api-management/observability.md

  • Line 51, Column 31: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-app-insights?tabs=rest' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 49, Column 31: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/azure/api-management/api-management-howto-use-azure-monitor' will be broken in isolated environments. Replace with a relative link.
  • Line 50, Column 41: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/azure/azure-monitor/reference/supported-metrics/microsoft-apimanagement-service-metrics' will be broken in isolated environments. Replace with a relative link.
  • Line 51, Column 31: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-app-insights?tabs=rest' will be broken in isolated environments. Replace with a relative link.
  • Line 52, Column 27: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/rest/api/apimanagement/tag/assign-to-api' will be broken in isolated environments. Replace with a relative link.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit b7aab91:

⚠️ Validation status: warnings

File Status Preview URL Details
articles/api-management/observability.md ⚠️Warning Details

articles/api-management/observability.md

  • Line 52, Column 31: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-app-insights?tabs=rest' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 49, Column 31: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/azure/api-management/api-management-howto-use-azure-monitor' will be broken in isolated environments. Replace with a relative link.
  • Line 50, Column 100: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/kusto/query/percentiles-aggregation-function' will be broken in isolated environments. Replace with a relative link.
  • Line 51, Column 83: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/azure/azure-monitor/reference/supported-metrics/microsoft-apimanagement-service-metrics' will be broken in isolated environments. Replace with a relative link.
  • Line 52, Column 31: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-app-insights?tabs=rest' will be broken in isolated environments. Replace with a relative link.
  • Line 53, Column 27: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/rest/api/apimanagement/tag/assign-to-api' will be broken in isolated environments. Replace with a relative link.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@Jak-MS
Copy link
Contributor

Jak-MS commented Nov 21, 2024

@dlepow
Can you review the proposed changes?

Important: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator bot added the aq-pr-triaged tracking label for the PR review team label Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants