Skip to content

feat: Add OpenTelemetry documentation #824

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

Merged
merged 13 commits into from
Jul 18, 2025
Merged

Conversation

ADubhlaoich
Copy link
Contributor

Proposed changes

This pull request adds OpenTelemetry documentation for NGINX Ingress Controller, converting an example hidden in the code repository. It adds it to the "Logging and monitoring" section, where the prior OpenTracing document has also been moved.

The latter document has had an explicit warning call-out added to the top directing users to the new document, and the release page now links directly to the new configuration document for context.

Some page titles and metadata in the section have also been updated as part of this work, to ensure the user experience is more consistent.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

This commit adds OpenTelemetry documentation for NGINX Ingress
Controller, coverting an example hidden in the code repository. It adds
it to the "Logging and monitoring" section, where the prior OpenTracing
document has also been moved.

The latter document has had an explicit warning call-out added to the
top directing users to the new document, and the release page now links
directly to the new configuration document for context.

Some page titles and metadata in the section have also been updated as
part of this work, to ensure the user experience is more consistent.
@ADubhlaoich ADubhlaoich requested review from a team as code owners July 16, 2025 13:30
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nic Issues related to NGINX Ingress Controller labels Jul 16, 2025
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/824/

@ADubhlaoich ADubhlaoich force-pushed the nic/otel-instructions branch from 37e4e16 to c4e8ec4 Compare July 17, 2025 12:44
ADubhlaoich added a commit to nginx/kubernetes-ingress that referenced this pull request Jul 17, 2025
This commit replaces the example text for OpenTelemetry with the
production website URL, creating one single source of truth for
instruction in a place more easily discoverable to users.

It is follow-up work from the documentation PR:

nginx/documentation#824
@ADubhlaoich ADubhlaoich linked an issue Jul 17, 2025 that may be closed by this pull request
@ADubhlaoich ADubhlaoich requested review from vepatel and a team July 18, 2025 14:46
@ADubhlaoich ADubhlaoich merged commit 43fd0cb into main Jul 18, 2025
10 checks passed
@ADubhlaoich ADubhlaoich deleted the nic/otel-instructions branch July 18, 2025 15:51
ADubhlaoich added a commit to nginx/kubernetes-ingress that referenced this pull request Jul 18, 2025
This commit replaces the example text for OpenTelemetry with the
production website URL, creating one single source of truth for
instruction in a place more easily discoverable to users.

It is follow-up work from the documentation PR:

nginx/documentation#824

---------

Co-authored-by: Venktesh Shivam Patel <ve.patel@f5.com>
github-actions bot pushed a commit to nginx/kubernetes-ingress that referenced this pull request Jul 18, 2025
This commit replaces the example text for OpenTelemetry with the
production website URL, creating one single source of truth for
instruction in a place more easily discoverable to users.

It is follow-up work from the documentation PR:

nginx/documentation#824

---------

Co-authored-by: Venktesh Shivam Patel <ve.patel@f5.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation product/nic Issues related to NGINX Ingress Controller
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a tutorial around Opentelemetry
4 participants