Skip to content

Commit

Permalink
update documentation for jaeger -> otlp
Browse files Browse the repository at this point in the history
  • Loading branch information
jranson committed Aug 15, 2024
1 parent 85811fb commit 88e0a26
Show file tree
Hide file tree
Showing 9 changed files with 52 additions and 236 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Trickster is a fully-featured HTTP Reverse Proxy Cache for HTTP applications lik
* [Negative Caching](./docs/negative-caching.md) to prevent domino effect outages
* High-performance [Collapsed Forwarding](./docs/collapsed-forwarding.md)
* Best-in-class [Byte Range Request caching and acceleration](./docs/range_request.md).
* [Distributed Tracing](./docs/tracing.md) via OpenTelemetry, supporting Jaeger and Zipkin
* [Distributed Tracing](./docs/tracing.md) via OpenTelemetry, supporting OTLP and Zipkin
* Rules engine for custom request routing and rewriting

## Time Series Database Accelerator
Expand Down
31 changes: 19 additions & 12 deletions deploy/kube/configmap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -505,24 +505,31 @@ data:
# default:
# # provider specifies the type of backend tracing system where traces are sent (in that format)
# # options are: jaeger, zipkin, stdout or none. none is the default
# # options are: otlp, zipkin, stdout or none. none is the default
# provider: none
# # service_name specifies the service name under which the traces are registered by this tracer
# # default is trickster
# service_name: trickster
# # collector_url is the URL of the tracing backend
# # required for zipkin and jaeger, unused for stdout
# collector_url: http://jaeger:14268/api/traces
# # endpoint is the URL, URI or Path to the tracing backend
# # required for Zipkin and OTLP, unused for stdout
# endpoint: http://jaeger:14268/api/traces
# # collector_user is the username credential for authenticating with the tracing backend
# # optional jaeger; unused for zipkin and stdout
# collector_user: ''
# # timeout_ms is the amount of time in milliseconds for the tracing post
# # to wait for a response before timing out
# # default is no timeout set
# timeout_ms: 5000
# # collector_pass is the username credential for authenticating with the tracing backend
# # optional jaeger; unused for zipkin and stdout
# collector_pass: ''
# # headers is a list of http headers to include in the tracing post
# # default is none
# headers:
# "Header-Name-1": "header value 1"
# "Header-Name-2": "header value 2"
# # disable_compression should be set to true if tracing posts should not be compressed
# # default is false
# disable_compression: false
# # sample_rate sets the probability that a span will be recorded.
# # A floating point value of 0.0 to 1.0 (inclusive) is permitted
Expand Down Expand Up @@ -556,15 +563,15 @@ data:
# # another example tracing config named example using jaeger agent backend and a 50% sample rate
# example:
# provider: jaeger
# collector_url: jaeger:6831
# endpoint: jaeger:6831
# sample_rate: 0.5
# jaeger:
# endpoint_type: agent
# # another example tracing config named zipkin-example using zipkin backend and a 10% sample rate
# zipkin-example:
# provider: zipkin
# collector_url: https://zipkin.example.com:9411/api/v2/spans
# endpoint: https://zipkin.example.com:9411/api/v2/spans
# sample_rate: 0.1
Expand Down
10 changes: 4 additions & 6 deletions docs/chunked_caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,18 +103,16 @@ rules:
tracing:
jc1:
tracer_type: jaeger
collector_url: 'http://127.0.0.1:14268/api/traces'
tracer_type: otlp
endpoint: 'http://127.0.0.1:14268/api/traces'
tags:
testTag: testTagValue
testTag2: testTag2Value
ja1:
tracer_type: jaeger
collector_url: '127.0.0.1:6831'
tracer_type: otlp
endpoint: '127.0.0.1:6831'
omit_tags:
- http.url
jaeger:
endpoint_type: agent
backends:
prom1:
Expand Down
103 changes: 0 additions & 103 deletions docs/developer/tracing.md

This file was deleted.

5 changes: 2 additions & 3 deletions docs/tracing.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
# Distributed Tracing via OpenTelemetry

Trickster instruments Distributed Tracing with [OpenTelemetry](http://opentelemetry.io/), which is a currently emergent, comprehensive observability stack that is in Public Beta. We import the [OpenTelemetry golang packages](https://github.com/open-telemetry/opentelemetry-go) to instrument support for tracing.
Trickster instruments Distributed Tracing with [OpenTelemetry](http://opentelemetry.io/). We import the [OpenTelemetry golang packages](https://github.com/open-telemetry/opentelemetry-go) to instrument support for tracing.

As OpenTelemetry evolves to support additional exporter formats, we will work to extend Trickster to support those as quickly as possible. We also make a best effort to update our otel package imports to the latest releases, whenever we publish a new Trickster release. You can check the [go.mod](../go.mod) file to see which release of opentelemetry-go we are is using. In this view, to see which version of otel a specific Trickster release imports, use the branch selector dropdown to switch to the tag corresponding to that version of Trickster.

## Supported Tracing Backends

- Jaeger
- Jaeger Agent
- Jaeger (via OTLP)
- Zipkin
- Console/Stdout (printed locally by the Trickster process)

Expand Down
43 changes: 21 additions & 22 deletions examples/conf/example.full.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -601,24 +601,31 @@ backends:
# default:

# # provider specifies the type of backend tracing system where traces are sent (in that format)
# # options are: jaeger, zipkin, stdout or none. none is the default
# # options are: otlp, zipkin, stdout or none. none is the default
# provider: none

# # service_name specifies the service name under which the traces are registered by this tracer
# # default is trickster
# service_name: trickster

# # collector_url is the URL of the tracing backend
# # required for zipkin and jaeger, unused for stdout
# collector_url: http://jaeger:14268/api/traces
# # endpoint is the URL, URI or Path to the tracing backend
# # required for Zipkin and OTLP, unused for stdout
# endpoint: http://jaeger:14268/api/traces

# # collector_user is the username credential for authenticating with the tracing backend
# # optional jaeger; unused for zipkin and stdout
# collector_user: ''
# # timeout_ms is the amount of time in milliseconds for the tracing post
# # to wait for a response before timing out
# # default is no timeout set
# timeout_ms: 5000

# # collector_pass is the username credential for authenticating with the tracing backend
# # optional jaeger; unused for zipkin and stdout
# collector_pass: ''
# # headers is a list of http headers to include in the tracing post
# # default is none
# headers:
# "Header-Name-1": "header value 1"
# "Header-Name-2": "header value 2"

# # disable_compression should be set to true if tracing posts should not be compressed
# # default is false
# disable_compression: false

# # sample_rate sets the probability that a span will be recorded.
# # A floating point value of 0.0 to 1.0 (inclusive) is permitted
Expand All @@ -637,30 +644,22 @@ backends:
# key1: "value1"
# key2: "value2"

# # configurations for this tracer, specific to jaeger
# jaeger:
# # endpoint_type indicates whether the jaeger tracing backend is a collector or agent
# # default is collector
# endpoint_type: collector

# # configurations for this tracer, specific to stdout
# stdout:
# # pretty_print indicates whether the output to stdout is formatted better human readability
# # default is false
# pretty_print: false

# # another example tracing config named example using jaeger agent backend and a 50% sample rate
# # another example tracing config named example using otlp agent backend and a 50% sample rate
# example:
# provider: jaeger
# collector_url: jaeger:6831
# provider: otlp
# endpoint: jaeger:6831
# sample_rate: 0.5
# jaeger:
# endpoint_type: agent

# # another example tracing config named zipkin-example using zipkin backend and a 10% sample rate
# zipkin-example:
# provider: zipkin
# collector_url: https://zipkin.example.com:9411/api/v2/spans
# endpoint: https://zipkin.example.com:9411/api/v2/spans
# sample_rate: 0.1


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,13 @@ tracing:
pretty_print: true
zip1:
provider: zipkin
collector_url: 'http://zipkin:9411/api/v2/spans'
endpoint: 'http://zipkin:9411/api/v2/spans'
jc1:
provider: jaeger # jaeger collector
collector_url: 'http://jaeger:14268/api/traces'
provider: otlp # jaeger collector
endpoint: 'http://jaeger:14268/api/traces'
ja1:
provider: jaeger # jaeger agent
collector_url: 'jaeger:6831'
jaeger:
endpoint_type: agent
provider: otlp # jaeger agent
endpoint: 'jaeger:6831'
backends:
prom1: # prometheus cached with a memory cache, traces sent to stdout
provider: prometheus
Expand Down
38 changes: 0 additions & 38 deletions testdata/test.tracing-recorder.conf

This file was deleted.

44 changes: 0 additions & 44 deletions testdata/test.tracing.conf

This file was deleted.

0 comments on commit 88e0a26

Please sign in to comment.