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.

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

Jump to bottom

Add tracing how-to guide #2026

Merged
merged 9 commits into from
May 30, 2024
Merged

Add tracing how-to guide #2026

merged 9 commits into from
May 30, 2024

Conversation

sjberman
Copy link
Contributor

Problem: As a user, I want to know how to configure tracing, so I can observe and debug my requests.

Solution: Add a how-to guide that describes how to configure tracing.

Closes #1912

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

NONE

@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 23, 2024
pleshakov
pleshakov reviewed May 24, 2024
View reviewed changes
Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good stuff!

site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
site/static/otel-collector.yaml Show resolved Hide resolved
@sjberman sjberman requested a review from ADubhlaoich May 29, 2024 14:40
@sjberman
Add tracing how-to guide
ec9096a 
Problem: As a user, I want to know how to configure tracing, so I can observe and debug my requests.

Solution: Add a how-to guide that describes how to configure tracing.
@sjberman sjberman marked this pull request as ready for review May 30, 2024 14:24
@sjberman sjberman requested review from a team as code owners May 30, 2024 14:24
@sjberman
Copy link
Contributor Author

@ADubhlaoich If you wouldn't mind taking a look. Thanks!

ADubhlaoich
ADubhlaoich approved these changes May 30, 2024
View reviewed changes
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, but I have a lot of edit suggestions.

I don't think a user would be led astray if it's merged as-is, but my suggestions revolve around clarifying tone.

site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
@sjberman sjberman enabled auto-merge (squash) May 30, 2024 16:44
@sjberman sjberman merged commit cb72c25 into nginxinc:main May 30, 2024
40 checks passed
@sjberman sjberman deleted the docs/tracing branch May 30, 2024 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bjee19 bjee19 bjee19 left review comments

@kate-osborn kate-osborn kate-osborn approved these changes

@ciarams87 ciarams87 ciarams87 approved these changes

@ADubhlaoich ADubhlaoich ADubhlaoich approved these changes

@pleshakov pleshakov pleshakov approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
NGINX Gateway Fabric
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Write documentation on how to monitor NGF using tracing
6 participants
@sjberman @pleshakov @ADubhlaoich @ciarams87 @kate-osborn @bjee19