Skip to content

Commit

Permalink
Fix typo; deep link to tracing in example.conf
Browse files Browse the repository at this point in the history
  • Loading branch information
James Ranson authored Jun 24, 2020
1 parent c36c1bf commit a93e6a1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ As OpenTelemetry evolves to support additional exporter formats, we will work to
## Supported Tracing Backends

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

## Configuration

Trickster allows the operator to configure multiple tracing configurations, which can be associated into each Origin configuration by name.

The [example config](../cmd/trickster/conf/example.conf) has exhaustive examples of configuring Trickster for distributed tracing.
The [example config](https://github.com/tricksterproxy/trickster/blob/v1.1.2/cmd/trickster/conf/example.conf#L508) has exhaustive examples of configuring Trickster for distributed tracing.

## Span List

Expand All @@ -35,7 +35,7 @@ Trickster can insert several spans to the traces that it captures, depending upo

## Tags / Attributes

Trickster supports adding custom tags to every span via the configuration. Depending upon your preferred tracing backend, these may be referred to as attributes. See the [example config](../cmd/trickster/conf/example.conf) for examples of adding custom attributes.
Trickster supports adding custom tags to every span via the configuration. Depending upon your preferred tracing backend, these may be referred to as attributes. See the [example config](https://github.com/tricksterproxy/trickster/blob/v1.1.2/cmd/trickster/conf/example.conf#L548) for examples of adding custom attributes.

Trickster also supports omitting any tags that Trickster inserts by default. The list of default tags are below. For example on the "request" span, an `http.url` tag is attached with the current full URL. In deployments where that tag may introduce too much cardinality in your backend trace storage system, you may wish to omit that tag and rely on the more concise `path` tag. Each tracer config can be provided a string list of tags to omit from traces.

Expand All @@ -58,4 +58,4 @@ Trickster also supports omitting any tags that Trickster inserts by default. The

### Attributes added to the FetchObject span

- `isPCF` - is true if the origin is configured for [Progressive Collapsed Forwarding](./collapsed-forwarding.md#progressive-collapsed-forwarding)
- `isPCF` - is true if the origin is configured for [Progressive Collapsed Forwarding](./collapsed-forwarding.md#progressive-collapsed-forwarding)

0 comments on commit a93e6a1

Please sign in to comment.