Skip to content

feat: support apisix.tracing configuration#270

Open
guoqqqi wants to merge 1 commit intomainfrom
feat/support-apisix-tracing
Open

feat: support apisix.tracing configuration#270
guoqqqi wants to merge 1 commit intomainfrom
feat/support-apisix-tracing

Conversation

@guoqqqi
Copy link
Contributor

@guoqqqi guoqqqi commented Mar 26, 2026

Summary

  • Add apisix.tracing configuration parameter to gateway helm chart
  • Default value: false
  • When enabled, provides comprehensive request lifecycle tracing (SSL/SNI, rewrite, access, header_filter, body_filter, and log)
  • When disabled, OpenTelemetry collects only a single span per request

Closes #269

Changes

  • values.yaml: Added apisix.tracing: false with helm-docs annotation
  • configmap.yaml: Added template rendering for tracing value
  • Chart.yaml: Bumped chart version from 0.2.57 to 0.2.58
  • README.md: Regenerated via helm-docs

References

Summary by CodeRabbit

  • New Features

    • Added configurable tracing parameter to control request lifecycle tracing behavior. When enabled, provides comprehensive tracing across SSL/SNI, rewrite, access, filter, and logging phases. Default setting (disabled) limits OpenTelemetry to single-span collection per request.
  • Chores

    • Chart version updated to 0.2.58.

@coderabbitai
Copy link

coderabbitai bot commented Mar 26, 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: 9003aad4-e99d-4a1c-b425-228cc4a2a138

📥 Commits

Reviewing files that changed from the base of the PR and between a73c426 and ee0cd7b.

📒 Files selected for processing (4)
  • charts/gateway/Chart.yaml
  • charts/gateway/README.md
  • charts/gateway/templates/configmap.yaml
  • charts/gateway/values.yaml

📝 Walkthrough

Walkthrough

Adds configurable apisix.tracing parameter to the gateway Helm chart, allowing users to control request lifecycle tracing behavior. Updates chart version, adds parameter documentation, default value, and ConfigMap template rendering.

Changes

Cohort / File(s) Summary
Chart Metadata
charts/gateway/Chart.yaml
Bumped Helm chart version from 0.2.57 to 0.2.58.
Configuration & Documentation
charts/gateway/values.yaml, charts/gateway/README.md, charts/gateway/templates/configmap.yaml
Added new apisix.tracing boolean parameter (default false) to Helm values, documented its behavior (comprehensive lifecycle tracing when enabled, single span per request when disabled), and integrated it into the APISIX ConfigMap template.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A tracing toggle hops into the chart so fine,
Request lifecycles dance when enabled—a sign!
Version bumped and values set true,
APISIX now traces what requests do! ✨

🚥 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 'feat: support apisix.tracing configuration' clearly and concisely summarizes the main change: adding support for configurable apisix.tracing parameter in the Helm chart.
Linked Issues check ✅ Passed The pull request fully implements the requirements from issue #269: adds apisix.tracing configuration parameter to values.yaml, integrates it into configmap.yaml template, and documents it in README.md.
Out of Scope Changes check ✅ Passed All changes are directly related to implementing the apisix.tracing configuration feature; chart version bump is a standard practice and no unrelated modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/support-apisix-tracing

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.

@guoqqqi guoqqqi requested review from nic-6443 March 26, 2026 10:41
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.

feat: support configurable apisix.tracing in gateway helm chart

1 participant