Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions docs/sources/tempo/api_docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Agent, OpenTelemetry Collector, or Jaeger Agent.
| Jaeger | GRPC | [Link](https://www.jaegertracing.io/docs/latest/apis/#span-reporting-apis) |
| Zipkin | HTTP | [Link](https://zipkin.io/zipkin-api/) |

For information on how to use the Zipkin endpoint with curl (for debugging purposes), refer to [Pushing spans with HTTP]({{< relref "./pushing-spans-with-http" >}}).
For information on how to use the Zipkin endpoint with curl (for debugging purposes), refer to [Pushing spans with HTTP](pushing-spans-with-http/).

### Query

Expand Down Expand Up @@ -146,7 +146,7 @@ but if it can also send OpenTelemetry proto if `Accept: application/protobuf` is
### Search

The Tempo Search API finds traces based on span and process attributes (tags and values). Note that search functionality is **not** available on
[v2 blocks]({{< relref "../configuration/parquet#choose-a-different-block-format" >}}).
[v2 blocks](../configuration/parquet/#choose-a-different-block-format).

When performing a search, Tempo does a massively parallel search over the given time range, and takes the first N results. Even identical searches differs due to things like machine load and network latency. TraceQL follows the same behavior.

Expand All @@ -163,7 +163,7 @@ The URL query parameters support the following values:

**Parameters for TraceQL Search**

- `q = (TraceQL query)`: Url encoded [TraceQL query]({{< relref "../traceql" >}}).
- `q = (TraceQL query)`: Url encoded [TraceQL query](../traceql/).

**Parameters for Tag Based Search**

Expand All @@ -176,7 +176,7 @@ The URL query parameters support the following values:
**Parameters supported for all searches**

- `limit = (integer)`
Optional. Limit the number of search results. Default is 20, but this is configurable in the querier. Refer to [Configuration]({{< relref "../configuration#querier" >}}).
Optional. Limit the number of search results. Default is 20, but this is configurable in the querier. Refer to [Configuration](../configuration/#querier).
- `start = (unix epoch seconds)`
Optional. Along with `end` define a time range from which traces should be returned.
- `end = (unix epoch seconds)`
Expand Down Expand Up @@ -411,7 +411,7 @@ Parameters:

This endpoint retrieves all discovered values and their data types for the given TraceQL identifier.
The endpoint is available in the query frontend service in a microservices deployment, or the Tempo endpoint in a monolithic mode deployment. This endpoint is similar to `/api/search/tag/<tag>/values` but operates on TraceQL identifiers and types.
See [TraceQL]({{< relref "../traceql" >}}) documentation for more information.
See [TraceQL](../traceql/) documentation for more information.

#### Example

Expand Down Expand Up @@ -449,7 +449,7 @@ This endpoint can also receive `start` and `end` optional parameters. These para
#### Filtered tag values

The `autocomplete_filtering_enabled` configuration parameter is set to `true` by default. This provides an optional URL query parameter, `q`, to your request.
The `q` parameter is a URL-encoded [TraceQL query]({{< relref "../traceql" >}}).
The `q` parameter is a URL-encoded [TraceQL query](../traceql/).
If provided, the tag values returned by the API are filtered to only return values seen on spans matching your filter parameters.

Queries can be incomplete: for example, `{ .cluster = }`. Tempo extracts only the valid matchers and build a valid query.
Expand Down Expand Up @@ -480,7 +480,7 @@ Meant to be used in a Query Visualization UI like Grafana to test that the Tempo

### Overrides API

For more information about user-configurable overrides API, refer to the [user-configurable overrides]({{< relref "../operations/user-configurable-overrides#api" >}}) documentation.
For more information about user-configurable overrides API, refer to the [user-configurable overrides](../operations/user-configurable-overrides/#api) documentation.

### Flush

Expand Down Expand Up @@ -512,7 +512,7 @@ This is usually used at the time of scaling down a cluster.
### Distributor ring status

{{< admonition type="note" >}}
This endpoint is only available when Tempo is configured with [the global override strategy]({{< relref "../configuration#overrides" >}}).
This endpoint is only available when Tempo is configured with [the global override strategy](../configuration/#overrides).
{{% /admonition %}}

```
Expand All @@ -522,7 +522,7 @@ GET /distributor/ring
Displays a web page with the distributor hash ring status, including the state, healthy, and last heartbeat time of each
distributor.

_For more information, check the page on [consistent hash ring]({{< relref "../operations/consistent_hash_ring" >}})._
_For more information, check the page on [consistent hash ring](../operations/consistent_hash_ring/)._

### Ingesters ring status

Expand All @@ -532,7 +532,7 @@ GET /ingester/ring

Displays a web page with the ingesters hash ring status, including the state, healthy, and last heartbeat time of each ingester.

_For more information, check the page on [consistent hash ring]({{< relref "../operations/consistent_hash_ring" >}}).
_For more information, check the page on [consistent hash ring](../operations/consistent_hash_ring/).

### Metrics-generator ring status

Expand All @@ -542,9 +542,9 @@ GET /metrics-generator/ring

Displays a web page with the metrics-generator hash ring status, including the state, health, and last heartbeat time of each metrics-generator.

This endpoint is only available when the metrics-generator is enabled. Refer to [metrics-generator]({{< relref "../configuration#metrics-generator" >}}).
This endpoint is only available when the metrics-generator is enabled. Refer to [metrics-generator](../configuration/#metrics-generator).

For more information, refer to [consistent hash ring]({{< relref "../operations/consistent_hash_ring" >}}).
For more information, refer to [consistent hash ring](../operations/consistent_hash_ring/).

### Compactor ring status

Expand All @@ -554,7 +554,7 @@ GET /compactor/ring

Displays a web page with the compactor hash ring status, including the state, healthy and last heartbeat time of each compactor.

For more information, refer to [consistent hash ring]({{< relref "../operations/consistent_hash_ring" >}}).
For more information, refer to [consistent hash ring](../operations/consistent_hash_ring/).

### Status

Expand Down
4 changes: 2 additions & 2 deletions docs/sources/tempo/api_docs/pushing-spans-with-http.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To use this procedure, you need to have Docker and `docker compose` installed.

## Start Tempo using the quick start

Use the instructions in the [Quick start for Tempo documentation]({{< relref "../getting-started/docker-example" >}}) to start a local instance of Tempo and Grafana.
Use the instructions in the [Quick start for Tempo documentation](../../getting-started/docker-example/) to start a local instance of Tempo and Grafana.

## Push spans with OTLP

Expand Down Expand Up @@ -110,7 +110,7 @@ The easiest way to get the trace is to execute a simple curl command to Tempo. T

### Use TraceQL to search for a trace

Alternatively, you can also use [TraceQL]({{< relref "../traceql" >}}) to search for the trace that was pushed.
Alternatively, you can also use [TraceQL](../../traceql/) to search for the trace that was pushed.
You can search by using the unique trace attributes that were set:

```bash
Expand Down
14 changes: 7 additions & 7 deletions docs/sources/tempo/configuration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The Tempo configuration options include:
- [Usage-report](#usage-report)
- [Cache](#cache)

Additionally, you can review [TLS]({{< relref "./network/tls" >}}) to configure the cluster components to communicate over TLS, or receive traces over TLS.
Additionally, you can review [TLS](network/tls/) to configure the cluster components to communicate over TLS, or receive traces over TLS.

## Use environment variables in the configuration

Expand Down Expand Up @@ -274,7 +274,7 @@ ingester:
For more information on configuration options, refer to [this file](https://github.com/grafana/tempo/blob/main/modules/generator/config.go).

The metrics-generator processes spans and write metrics using the Prometheus remote write protocol.
For more information on the metrics-generator, refer to the [Metrics-generator documentation]({{< relref "../metrics-generator" >}}).
For more information on the metrics-generator, refer to the [Metrics-generator documentation](../metrics-generator/).

Metrics-generator processors are disabled by default. To enable it for a specific tenant, set `metrics_generator.processors` in the [overrides](#overrides) section.

Expand Down Expand Up @@ -731,10 +731,10 @@ The storage block configures TempoDB.
The following example shows common options.
For further platform-specific information, refer to the following:

* [GCS]({{< relref "./hosted-storage/gcs" >}})
* [S3]({{< relref "./hosted-storage/s3" >}})
* [Azure]({{< relref "./hosted-storage/azure" >}})
* [Parquet]({{< relref "./parquet" >}})
* [GCS](hosted-storage/gcs/)
* [S3](hosted-storage/s3/)
* [Azure](hosted-storage/azure/)
* [Parquet](parquet/)

```yaml
# Storage configuration for traces
Expand Down Expand Up @@ -1550,7 +1550,7 @@ overrides:

These tenant-specific overrides are stored in an object store and can be modified using API requests.
User-configurable overrides have priority over runtime overrides.
Refer to [user-configurable overrides]{{< relref "../operations/user-configurable-overrides" >}} for more details.
Refer to [user-configurable overrides]../operations/user-configurable-overrides/ for more details.

#### Override strategies

Expand Down
8 changes: 4 additions & 4 deletions docs/sources/tempo/configuration/grafana-agent/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,22 +119,22 @@ Refer to the `scrape_configs` block in the [configuration reference](/docs/agent

Automatic logging writes well formatted log lines to help with trace discovery.

For a closer look into the feature, visit [Automatic logging]({{< relref "./automatic-logging" >}}).
For a closer look into the feature, visit [Automatic logging](automatic-logging/).

#### Tail-based sampling

The Agent implements tail-based sampling for distributed tracing systems and multi-instance Agent deployments.
With this feature, sampling decisions can be made based on data from a trace, rather than exclusively with probabilistic methods.

For a detailed description, go to [Tail-based sampling]({{< relref "./tail-based-sampling" >}}).
For a detailed description, go to [Tail-based sampling](tail-based-sampling/).

For additional information, refer to the blog post, [An introduction to trace sampling with Grafana Tempo and Grafana Agent](/blog/2022/05/11/an-introduction-to-trace-sampling-with-grafana-tempo-and-grafana-agent).

#### Generating metrics from spans

The Agent can take advantage of the span data flowing through the pipeline to generate Prometheus metrics.

Go to [Span metrics]({{< relref "./span-metrics" >}}) for a more detailed explanation of the feature.
Go to [Span metrics](span-metrics/) for a more detailed explanation of the feature.

#### Service graph metrics

Expand All @@ -144,7 +144,7 @@ This service graphs processor builds a map of services by analyzing traces, with
Edges are spans with a parent-child relationship, that represent a jump, such as a request, between two services.
The amount of requests and their duration are recorded as metrics, which are used to represent the graph.

To read more about this processor, go to its [section]({{< relref "./service-graphs" >}}).
To read more about this processor, go to its [section](service-graphs/).

### Exporting spans

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ and the connections and dependencies between its components.

The same service graph metrics can also be generated by Tempo.
This is more efficient and recommended for larger installations.
For a deep look into service graphs, visit [this section]({{< relref "../../metrics-generator/service_graphs" >}}).
For a deep look into service graphs, visit [this section](../../../metrics-generator/service_graphs/).

Service graphs are also used in the application performance management dashboard.
For more information, refer to the [service graph view documentation]({{< relref "../../metrics-generator/service-graph-view" >}}).
For more information, refer to the [service graph view documentation](../../../metrics-generator/service-graph-view/).

## Before you begin

Expand Down Expand Up @@ -70,4 +70,4 @@ metrics:
The same service graph metrics can also be generated by Tempo.
This is more efficient and recommended for larger installations.

For additional information about viewing service graph metrics in Grafana and calculating cardinality, refer to the [server side documentation]({{< relref "../../metrics-generator/service_graphs/enable-service-graphs" >}}).
For additional information about viewing service graph metrics in Grafana and calculating cardinality, refer to the [server side documentation](../../../metrics-generator/service_graphs/enable-service-graphs/).
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ For more information, refer to [Migrate to Alloy](https://grafana.com/docs/tempo

The same span metrics can also be generated by Tempo.
This is more efficient and recommended for larger installations.
For a deep look into span metrics, visit [this section]({{< relref "../../metrics-generator/span_metrics" >}}).
For a deep look into span metrics, visit [this section](../../../metrics-generator/span_metrics/).

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ aliases:

Tempo provides additional hosted storage configuration options discussed on the pages below. These options relate to providers such as Google Cloud, AWS S3, and Azure.

For additional details about storage configuration, refer to [Storage configuration]({{< relref "../../configuration#storage" >}}).
For additional details about storage configuration, refer to [Storage configuration](../#storage).

{{< section withDescriptions="true">}}
2 changes: 1 addition & 1 deletion docs/sources/tempo/configuration/hosted-storage/gcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ aliases:

# Google Cloud Storage

For configuration options, check the storage section on the [configuration]({{< relref "../../configuration#storage" >}}) page.
For configuration options, check the storage section on the [configuration](../../#storage) page.

## Permissions

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/tempo/configuration/hosted-storage/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aliases:

# Amazon S3 permissions

For configuration options, refer to the storage section on the [configuration]({{< relref "../../configuration#storage" >}}) page.
For configuration options, refer to the storage section on the [configuration](../../#storage) page.

The following authentication methods are supported:
- AWS environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/tempo/configuration/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ weight: 110

This document is a reference for all Tempo options and their defaults. If you are just getting
started with Tempo, refer to [Tempo examples](https://github.com/grafana/tempo/tree/main/example/docker-compose)
and other [configuration documentation]({{< relref "../configuration" >}}). Most installations will require only setting 10 to 20 of these options.
and other [configuration documentation](../). Most installations will require only setting 10 to 20 of these options.

It was generated by running Tempo with a minimal configuration and accessing the `/status/config` endpoint:
```
Expand Down
8 changes: 4 additions & 4 deletions docs/sources/tempo/configuration/parquet.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ weight: 300
# Apache Parquet block format


Tempo has a default columnar block format based on Apache Parquet. This format is required for tags-based search as well as [TraceQL]({{< relref "../traceql" >}}), the query language for traces. The columnar block format improves search performance and enables a large ecosystem of tools to access the underlying trace data.
Tempo has a default columnar block format based on Apache Parquet. This format is required for tags-based search as well as [TraceQL](../../traceql/), the query language for traces. The columnar block format improves search performance and enables a large ecosystem of tools to access the underlying trace data.

For more information, refer to the [Parquet design document](https://github.com/grafana/tempo/blob/main/docs/design-proposals/2022-04%20Parquet.md) and [Issue 1480](https://github.com/grafana/tempo/issues/1480).
Additionally, there is now a [Parquet v3 design document](https://github.com/grafana/tempo/blob/main/docs/design-proposals/2023-05%20vParquet3.md).
Expand All @@ -26,7 +26,7 @@ Block formats based on Parquet require more CPU and memory resources than the pr
The default block format is `vParquet3`, which is the latest iteration of the Parquet-based columnar block format in Tempo.
It introduces dedicated attribute columns, which improve query performance by storing attributes in own columns,
rather than in the generic attribute key-value list.
For more information, see [Dedicated attribute columns]({{< relref "../operations/tempo_cli" >}}).
For more information, see [Dedicated attribute columns](../../operations/tempo_cli/).

You can also use the latest more experimental version `vParquet4`.
To enable it, set the block version option to `vParquet4` in the Storage section of the configuration file.
Expand All @@ -48,7 +48,7 @@ To re-enable the default `vParquet3` format, remove the block version option fro
## Parquet configuration parameters

Some parameters in the Tempo configuration are specific to Parquet.
For more information, refer to the [storage configuration documentation]({{< relref "../configuration#storage" >}}).
For more information, refer to the [storage configuration documentation](../#storage).

### Trace search parameters

Expand All @@ -73,4 +73,4 @@ The `cache_control` section contains the follow parameters for Parquet metadata

If you have used an earlier version of the Parquet format, you can use `tempo-cli` to convert a Parquet file from its existing schema to the one used in Tempo 2.0.

For instructions, refer to the [Parquet convert command documentation]({{< relref "../operations/tempo_cli#parquet-convert-command" >}}).
For instructions, refer to the [Parquet convert command documentation](../../operations/tempo_cli/#parquet-convert-command).
2 changes: 1 addition & 1 deletion docs/sources/tempo/configuration/polling.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ storage:
[blocklist_poll_stale_tenant_index: <duration>]
```

Due to the mechanics of the [tenant index]({{< relref "../operations/monitor/polling" >}}), the blocklist will be stale by
Due to the mechanics of the [tenant index](../../operations/monitor/polling/), the blocklist will be stale by
at most 2 times the configured `blocklist_poll` duration. There are two configuration options that need to be balanced
against the `blockist_poll` to handle this:

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/tempo/configuration/use-trace-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Grafana Cloud comes pre-configured with a Tempo data source.
If you are using Grafana on-prem, you need to [set up the Tempo data source](/docs/grafana/<GRAFANA_VERSION>/datasources/tempo).

{{< admonition type="tip" >}}
If you want to explore tracing data in Grafana, try the [Intro to Metrics, Logs, Traces, and Profiling example]({{< relref "../getting-started/docker-example" >}}).
If you want to explore tracing data in Grafana, try the [Intro to Metrics, Logs, Traces, and Profiling example](../../getting-started/docker-example/).
{{% /admonition %}}

This video explains how to add data sources, including Loki, Tempo, and Mimir, to Grafana and Grafana Cloud. Tempo data source set up starts at 4:58 in the video.
Expand Down
Loading
Loading