Skip to content

add doc about ingress-nginx otel#766

Merged
jing2uo merged 1 commit into
alauda:mainfrom
woodgear:feat/ACP-52885
May 22, 2026
Merged

add doc about ingress-nginx otel#766
jing2uo merged 1 commit into
alauda:mainfrom
woodgear:feat/ACP-52885

Conversation

@woodgear
Copy link
Copy Markdown
Contributor

@woodgear woodgear commented May 22, 2026

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guide on enabling, verifying, and disabling OpenTelemetry tracing for Ingress NGINX (v4.3.x+), including configuration patching and reconciliation verification steps.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 22, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 67177261-4012-48fb-a3c0-4859232dd7d6

📥 Commits

Reviewing files that changed from the base of the PR and between 5129fdb and 60368a4.

📒 Files selected for processing (1)
  • docs/en/solutions/How_to_Enable_OpenTelemetry_for_Ingress_NGINX.md

Walkthrough

This PR adds a user guide documenting how to enable, verify, and disable OpenTelemetry tracing for the ACP Ingress NGINX controller (v4.3.x+). The guide provides step-by-step kubectl commands to patch the IngressNginx custom resource, validate successful reconciliation and module loading, and remove the feature when needed.

Changes

OpenTelemetry Ingress NGINX User Guide

Layer / File(s) Summary
Enable OpenTelemetry
docs/en/solutions/How_to_Enable_OpenTelemetry_for_Ingress_NGINX.md
Document metadata and Chapter 1 instructions for identifying the IngressNginx resource, patching spec.controller.config with OpenTelemetry and OTLP endpoint/sampler/operation-name settings, and confirming expected ConfigMap keys and ownership.
Verify and disable OpenTelemetry
docs/en/solutions/How_to_Enable_OpenTelemetry_for_Ingress_NGINX.md
Chapter 2 commands to verify IngressNginx reconciliation status and confirm NGINX/OpenTelemetry module loading via kubectl exec with expected log/config snippets. Chapter 3 shows how to disable OpenTelemetry by patching enable-opentelemetry to "false" and describes the resulting NGINX reload behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A guide hops into the warren,
With steps to trace through Nginx chains,
Enable, verify, disable—
Clear pathways through observability plains! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'add doc about ingress-nginx otel' directly and accurately describes the main change: adding documentation about OpenTelemetry support for Ingress NGINX.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jing2uo jing2uo merged commit bd2c643 into alauda:main May 22, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants