Skip to content

docs: update OTLP tracing examples#1049

Merged
jranson merged 1 commit into
trickstercache:mainfrom
houyuwushang:docs-otlp-http-examples-381
Jul 3, 2026
Merged

docs: update OTLP tracing examples#1049
jranson merged 1 commit into
trickstercache:mainfrom
houyuwushang:docs-otlp-http-examples-381

Conversation

@houyuwushang

Copy link
Copy Markdown
Contributor

Description

Related to #381.

This updates the tracing docs and examples to match the current OTLP exporter behavior. Trickster currently uses OTLP over HTTP (otlptracehttp), but several examples still pointed at Jaeger's legacy collector/agent endpoints (14268/api/traces, 6831) or old provider: jaeger options.

This PR:

  • points Jaeger OTLP examples at http://...:4318/v1/traces
  • exposes Jaeger's OTLP HTTP port (4318) in the docker-compose demo/dev services
  • removes old Jaeger agent/provider config snippets from the Kubernetes example
  • updates docs/tracing.md to link to the current example config instead of the old v1.1.2 example

No runtime behavior changes are intended.

Validation:

  • rg -n "provider:\s*jaeger|jaeger\.endpoint_type|jaeger:6831|127\.0\.0\.1:6831|14268/api/traces|jaeger agent|jager agent|otlp agent backend|endpoint_type|jc1|ja1|blob/v1\.1\.2/examples/conf/example\.full\.yaml" docs examples deploy README.md pkg -g "*.md" -g "*.yaml" -g "*.yml" -g "*.go" returns no stale Trickster tracing examples
  • go run ./cmd/trickster -validate-config -config examples\docker-compose\docker-compose-data\trickster-config\trickster.yaml
  • go run ./cmd/trickster -validate-config -config docs\developer\environment\trickster-config\trickster.yaml
  • go test ./pkg/observability/tracing/... -count=1
  • git diff --check

Not run locally:

  • docker compose config, because Docker CLI is not installed in my local environment.

Type of Change

    • Bug fix
    • New feature
    • Optimization
    • Test coverage
    • Documentation
    • Infrastructure

AI Disclosure

    • This contribution DOES NOT include AI-generated changes
    • This contribution DOES include AI-generated changes, and I have reviewed the relevant contributing guidelines.

- 5778:5778
- 16686:16686
- 4318:4318
- 14268:14268

@jranson jranson Jul 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

is 14268 port mapping still needed? would be a good idea to git grep 14268 from the project root to identify all remaining usage and address any other holdovers.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done. I removed the remaining 14268:14268 mappings from both compose files because Trickster no longer references that endpoint in these examples.

I also reran git grep 14268 from the project root and it now returns no matches.

Validation after the update:

  • git grep -n 14268 returns no matches
  • go run ./cmd/trickster -validate-config -config examples\docker-compose\docker-compose-data\trickster-config\trickster.yaml
  • go run ./cmd/trickster -validate-config -config docs\developer\environment\trickster-config\trickster.yaml
  • go test ./pkg/observability/tracing/... -count=1
  • git diff --check

Signed-off-by: houyuwushang <liuluoqianqiu@outlook.com>
@houyuwushang houyuwushang force-pushed the docs-otlp-http-examples-381 branch from 172436a to 7ecc98f Compare July 3, 2026 13:42
@jranson jranson merged commit a7762d0 into trickstercache:main Jul 3, 2026
8 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