[Bug]: Tracing docs say the gateway-controller exports traces
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- documentation
Research direction
The issue identifies three tracing documentation locations: api-gateway/next/observability/tracing/overview.md and ai-gateway/next/logging-and-tracing/tracing.md (lines 36 and 84). Read those passages and update the wording to distinguish which components export spans from the gateway's role in configuring router tracing. Done when all three passages describe that distinction accurately.
Written by the indexing model from the issue text.
Description
Description
The tracing docs say the gateway-controller exports traces:
- api-gateway/next/observability/tracing/overview.md L34: "Gateway components (gateway-controller, policy-engine, router) are configured to export traces via OTLP"
- ai-gateway/next/logging-and-tracing/tracing.md L36 and L84: the same statement
The gateway-controller has no tracer. It only generates Envoy's tracing configuration (createTracingConfig in translator.go L2896-L2962). Only the router (Envoy) and the policy-engine export spans, so readers looking for gateway-controller spans in Jaeger will find none.
Suggested fix: state that the router and policy-engine export traces, and that the gateway-controller configures the router's tracing.
Version
next
- Dominant language
- CSS
- Stars
- 3
- Forks
- 68
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 27
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from wso2/docs-api-platform
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
wso2/docs-api-platform#500 ·
Maintainers usually reply within 1 day
-
[Bug]: Local development setup fails on a fresh clone due to missing setuptools pinPossibly taken @Dimagidhp claimed this 29 days ago. OpenType/Bug
Difficulty 1/5 Under an hour Newbie friendliness 92/100
wso2/docs-api-platform#492 ·
Maintainers usually reply within 1 day
-
Priority/Normal Severity/Major Type/Docs Type/Improvement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
wso2/docs-api-platform#455 ·
Maintainers usually reply within 1 day
-
API Gateway Docs - Setup instructions appear before the Quick StartPossibly taken @kavishannip claimed this 85 days ago. OpenPriority/Highest Severity/Critical
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
wso2/docs-api-platform#330 · 1 comment ·
Maintainers usually reply within 1 day
-
Doc Feedback: Chart config in "Bottom-Up (Gateway → On-Prem APIM)"May be free again @Krishmal2004 claimed this 41 days ago, and no pull request is open. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
wso2/docs-api-platform#277 · 1 comment ·
Maintainers usually reply within 1 day
All issues in wso2/docs-api-platform
Similar issues
-
docs hacktoberfest help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
pacocartones/free-llm-api-hub#347 ·
Maintainers usually reply within 1 day
-
customer-reported question
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Azure/azure-sdk-for-python#49548 · 1 comment · 1 reaction ·
Maintainers usually reply within 1 day
-
source mismatchOpen
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
OpenLiberty/docs#8579 ·
Maintainers usually reply within 1 day
-
Add the Yahoo chart API duplicate last-day row (yfinance#573) to incidents.md (about 1 hour)Possibly taken A pull request linked to this issue is open or already merged. Opendata docs good first issue
Difficulty 1/5 Under an hour Newbie friendliness 80/100
pacocartones/market-data-sanity-checker#160 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
nodejs/node#66743 · 1 reaction ·
Maintainers usually reply within 1 day