Update monitoring.md with latest changes from review of PR 967 #972
Conversation
Signed-off-by: ADITYATIWARI342005 <[email protected]>
✅ Deploy Preview for romantic-neumann-1959d7 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Jaeger v2 monitoring documentation to provide comprehensive guidance on observability configuration and operational monitoring. The changes restructure the documentation with improved organization and add detailed configuration examples.
- Adds structured internal observability configuration covering logs, metrics, traces, and health checks
- Expands monitoring guidance with specific metrics to track and troubleshooting workflows
- Includes practical examples for Prometheus integration and alerting best practices
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
- Add #logging and #metrics anchors to monitoring.md sections - Update troubleshooting.md to use correct anchor references - Fix note formatting consistency Closes link checker validation errors in check-links step. Signed-off-by: ADITYATIWARI342005 <[email protected]>
|
I have fixed the missing period issue, but the other two issues are contradictory to usual practices, |
|
Hi @jkowall , |
1 participant
This pull request introduces revisions to the documentation, specifically targeting the monitoring guide. The modifications include:
Incorporation of the Internal_observability section.
Restructuring of the overall documentation hierarchy to improve readability and alignment with project standards.
Adjustments made in accordance with prior review feedback.
These changes enhance the coherence of the documentation set, ensuring consistency across related guides.
✅ npm run check:spelling
✅ cross checked all configurations from .yml
✅ checked for relevant sections
✅ changes made on branch not on main
Structure and organisation check from previous review- { checked by AI }
✅ Clear hierarchy: Overview → Configure → Monitor → Integrate → Troubleshoot
✅ Logical flow: Natural operational progression
✅ Good separation: Configuration vs monitoring guidance appropriately separated
✅ Minimal repetition: Information reuse is justified and contextual
closes #762
@yurishkuro
I have updated the branch and resolved the conflicts, I have also checked for potential issues from previous review, I hope you can review it for further changes.