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

[DOCS] Add docs for logs and traces correlation #1115

Open
Calm-Rock opened this issue Jan 24, 2025 · 0 comments
Open

[DOCS] Add docs for logs and traces correlation #1115

Calm-Rock opened this issue Jan 24, 2025 · 0 comments
Labels

Comments

@Calm-Rock
Copy link
Member

Calm-Rock commented Jan 24, 2025

Add Steps for Correlating Logs with Traces in Documentation

Current State

  • Documentation in the logs section does not include steps for correlating logs with traces.
  • Documentation in the traces section does not include steps for correlating traces with logs.

Scope of Work

Documentation Updates

  1. Logs Section:

    • Add steps to correlate logs with traces in each logs-related documentation.
    • Ensure examples are included for better understanding.
    • Validate if logs contain trace IDs and how to link them.
  2. Traces Section:

    • Add steps to correlate traces with logs in each traces-related documentation.
    • Provide commands or UI-based instructions for linking traces back to logs.
    • Include OpenTelemetry configurations (if applicable) to ensure trace-aware logging.

Deliverables

  • Updated logs documentation with steps to correlate logs with traces.
  • Updated traces documentation with steps to correlate traces with logs.
  • Examples & Configurations where necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant