Skip to content

Commit d57dced

Browse files
[DOC] Fix broken links in Tempo doc (#4827) (#4829)
* Fix broken links in Tempo doc * Update links to agent with AGENT_VERSION * Fix alias for grafana agent (cherry picked from commit 265188d) Co-authored-by: Kim Nylander <[email protected]>
1 parent fc462b5 commit d57dced

File tree

22 files changed

+66
-59
lines changed

22 files changed

+66
-59
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88
<a href="https://goreportcard.com/report/github.com/grafana/tempo"><img src="https://goreportcard.com/badge/github.com/grafana/tempo" alt="Go Report Card" /></a>
99
</p>
1010

11-
Grafana Tempo is an open source, easy-to-use, and high-scale distributed tracing backend. Tempo is cost-efficient, requiring only object storage to operate, and is deeply integrated with Grafana, Prometheus, and Loki.
11+
Grafana Tempo is an open source, easy-to-use, and high-scale distributed tracing backend. Tempo is cost-efficient, requiring only object storage to operate, and is deeply integrated with Grafana, Prometheus, and Loki.
1212

1313

1414
## Business value of distributed tracing
1515

1616
Distributed tracing helps teams quickly pinpoint performance issues and understand the flow of requests across services.
1717
The Traces Drilldown UI simplifies this process by offering a user-friendly interface to view and analyze trace data, making it easier to identify and resolve issues without needing to write complex queries.
1818

19-
Refer to [Use traces to find solutions](https://grafana.com/docs/tempo/latest/introduction/solutions-with-traces/) to learn more about how you can use distributed tracing to investigate and solve issues.
19+
Refer to [Use traces to find solutions](https://grafana.com/docs/tempo/latest/introduction/solutions-with-traces/) to learn more about how you can use distributed tracing to investigate and solve issues.
2020

2121
## Traces Drilldown UI: A better way to get value from your tracing data
2222
We are excited to introduce the [Traces Drilldown](https://github.com/grafana/traces-drilldown) (formerly Explore Traces) app as part of the Grafana Explore suite. This app provides a queryless and intuitive experience for analyzing tracing data, allowing teams to quickly identify performance issues, latency bottlenecks, and errors without needing to write complex queries or use TraceQL.
@@ -30,18 +30,17 @@ Key Features:
3030
![image](https://github.com/user-attachments/assets/991205df-1b27-489f-8ef0-1a05ee158996)
3131

3232
To learn more see the following links:
33-
- [Traces Drilldown repo](https://github.com/grafana/races-drilldown)
33+
- [Traces Drilldown repo](https://github.com/grafana/traces-drilldown)
3434
- [Traces Drilldown documentation](https://grafana.com/docs/grafana/latest/explore/simplified-exploration/traces/)
35-
- [Demo video](https://www.youtube.com/watch?v=a3uB1C2oHA4
36-
)
35+
- [Demo video](https://www.youtube.com/watch?v=a3uB1C2oHA4)
3736

3837
## TraceQL
3938

40-
Tempo implements [TraceQL](https://grafana.com/docs/tempo/latest/traceql/), a traces-first query language inspired by LogQL and PromQL, which enables targeted queries or rich UI-driven analyses.
39+
Tempo implements [TraceQL](https://grafana.com/docs/tempo/latest/traceql/), a traces-first query language inspired by LogQL and PromQL, which enables targeted queries or rich UI-driven analyses.
4140

42-
### TraceQL metrics
41+
### TraceQL metrics
4342

44-
[TraceQL metrics](https://grafana.com/docs/tempo/latest/traceql/metrics-queries/) is an experimental feature in Grafana Tempo that creates metrics from traces. Metric queries extend trace queries by applying a function to trace query results. This powerful feature allows for ad hoc aggregation of any existing TraceQL query by any dimension available in your traces, much in the same way that LogQL metric queries create metrics from logs.
43+
[TraceQL metrics](https://grafana.com/docs/tempo/latest/traceql/metrics-queries/) is an experimental feature in Grafana Tempo that creates metrics from traces. Metric queries extend trace queries by applying a function to trace query results. This powerful feature allows for ad hoc aggregation of any existing TraceQL query by any dimension available in your traces, much in the same way that LogQL metric queries create metrics from logs.
4544

4645
Tempo is Jaeger, Zipkin, Kafka, OpenCensus, and OpenTelemetry compatible. It ingests batches in any of the mentioned formats, buffers them, and then writes them to Azure, GCS, S3, or local disk. As such, it is robust, cheap, and easy to operate!
4746

@@ -57,6 +56,8 @@ Tempo is Jaeger, Zipkin, Kafka, OpenCensus, and OpenTelemetry compatible. It ing
5756

5857
To learn more about Tempo, consult the following documents & talks:
5958

59+
- [How to get started with Tmepo with Joe Elliot (video)](https://www.youtube.com/watch?v=zDrA7Ly3ovU)
60+
- [Grafana blog posts about Tempo](https://grafana.com/tags/tempo/)
6061
- [New in Grafana Tempo 2.0: Apache Parquet as the default storage format, support for TraceQL][tempo_20_announce]
6162
- [Get to know TraceQL: A powerful new query language for distributed tracing][traceql-post]
6263

docs/sources/tempo/api_docs/pushing-spans-with-http.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ The easiest way to get the trace is to execute a simple curl command to Tempo. T
109109

110110
### Use TraceQL to search for a trace
111111

112-
Alternatively, you can also use [TraceQL](../traceql) to search for the trace that was pushed.
112+
Alternatively, you can also use [TraceQL](https://grafana.com/docs/tempo/<TEMPO_VERSION>/traceql/) to search for the trace that was pushed.
113113
You can search by using the unique trace attributes that were set:
114114

115115
```bash

docs/sources/tempo/configuration/grafana-agent/_index.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ title: Grafana Agent
33
description: Configure the Grafana Agent to work with Tempo
44
weight: 600
55
aliases:
6-
- /docs/tempo/grafana-agent
6+
- /docs/tempo/grafana-agent
7+
- ../../grafana-agent # /docs/tempo/latest/grafana-agent
78
---
89

910
# Grafana Agent
@@ -35,22 +36,22 @@ leverages all the data that's processed in the pipeline.
3536

3637
Grafana Agent is available in two different variants:
3738

38-
* [Static mode](/docs/agent/latest/static): The original Grafana Agent.
39-
* [Flow mode](/docs/agent/latest/flow): The new, component-based Grafana Agent.
39+
* [Static mode](/docs/agent/<AGENT_VERSION>/static): The original Grafana Agent.
40+
* [Flow mode](/docs/agent/<AGENT_VERSION>/flow): The new, component-based Grafana Agent.
4041

41-
Grafana Agent Flow configuration files are [written in River](/docs/agent/latest/flow/concepts/config-language/).
42-
Static configuration files are [written in YAML](/docs/agent/latest/static/configuration/).
42+
Grafana Agent Flow configuration files are [written in River](/docs/agent/<AGENT_VERSION>/flow/concepts/config-language/).
43+
Static configuration files are [written in YAML](/docs/agent/<AGENT_VERSION>/static/configuration/).
4344
Examples in this document are for Flow mode.
4445

45-
For more information, refer to the [Introduction to Grafana Agent](/docs/agent/latest/about/).
46+
For more information, refer to the [Introduction to Grafana Agent](/docs/agent/<AGENT_VERSION>/about/).
4647

4748
## Architecture
4849

4950
The Grafana Agent can be configured to run a set of tracing pipelines to collect data from your applications and write it to Tempo.
5051
Pipelines are built using OpenTelemetry,
5152
and consist of `receivers`, `processors`, and `exporters`.
5253
The architecture mirrors that of the OTel Collector's [design](https://github.com/open-telemetry/opentelemetry-collector/blob/846b971758c92b833a9efaf742ec5b3e2fbd0c89/docs/design.md).
53-
See the [configuration reference](/agent/latest/static/configuration/traces-config/) for all available configuration options.
54+
See the [configuration reference](/agent/<AGENT_VERSION>/static/configuration/traces-config/) for all available configuration options.
5455

5556
<p align="center"><img src="https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector/846b971758c92b833a9efaf742ec5b3e2fbd0c89/docs/images/design-pipelines.png" alt="Tracing pipeline architecture"></p>
5657

@@ -75,13 +76,13 @@ The Grafana Agent processes tracing data as it flows through the pipeline to mak
7576

7677
The Agent supports batching of traces.
7778
Batching helps better compress the data, reduces the number of outgoing connections, and is a recommended best practice.
78-
To configure it, refer to the `batch` block in the [configuration reference](/docs/agent/latest/configuration/traces-config).
79+
To configure it, refer to the `batch` block in the [configuration reference](/docs/agent/<AGENT_VERSION>/configuration/traces-config).
7980

8081
#### Attributes manipulation
8182

8283
The Grafana Agent allows for general manipulation of attributes on spans that pass through this agent.
8384
A common use may be to add an environment or cluster variable.
84-
To configure it, refer to the `attributes` block in the [configuration reference](/docs/agent/latest/configuration/traces-config).
85+
To configure it, refer to the `attributes` block in the [configuration reference](/docs/agent/<AGENT_VERSION>/configuration/traces-config).
8586

8687
#### Attaching metadata with Prometheus Service Discovery
8788

@@ -113,7 +114,7 @@ All of Prometheus' [various service discovery mechanisms](https://prometheus.io/
113114
This means you can use the same `scrape_configs` between your metrics, logs, and traces to get the same set of labels,
114115
and easily transition between your observability data when moving from your metrics, logs, and traces.
115116

116-
Refer to the `scrape_configs` block in the [configuration reference](/docs/agent/latest/configuration/traces-config).
117+
Refer to the `scrape_configs` block in the [configuration reference](/docs/agent/<AGENT_VERSION>/configuration/traces-config).
117118

118119
#### Trace discovery through automatic logging
119120

@@ -156,4 +157,4 @@ Aside from endpoint and authentication, the exporter also provides mechanisms fo
156157
and implements a queue buffering mechanism for transient failures, such as networking issues.
157158

158159
To see all available options,
159-
refer to the `remote_write` block in the [Agent configuration reference](/docs/agent/latest/configuration/traces-config).
160+
refer to the `remote_write` block in the [Agent configuration reference](/docs/agent/<AGENT_VERSION>/configuration/traces-config).

docs/sources/tempo/configuration/grafana-agent/automatic-logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ For more information, refer to [Migrate to Alloy](https://grafana.com/docs/tempo
5151

5252
To configure automatic logging, you need to select your preferred backend and the trace data to log.
5353

54-
To see all the available configuration options, refer to the [configuration reference](https://grafana.com/docs/agent/latest/configuration/traces-config).
54+
To see all the available configuration options, refer to the [configuration reference](https://grafana.com/docs/agent/<AGENT_VERSION>/configuration/traces-config).
5555

5656
This simple example logs trace roots to `stdout` and is a good way to get started using automatic logging:
5757
```yaml

docs/sources/tempo/configuration/grafana-agent/service-graphs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ traces:
4747
enabled: true
4848
```
4949
50-
To see all the available configuration options, refer to the [configuration reference](/docs/agent/latest/configuration/traces-config).
50+
To see all the available configuration options, refer to the [configuration reference](/docs/agent/<AGENT_VERSION>/configuration/traces-config).
5151
5252
Metrics are registered in the Agent's default registerer.
5353
Therefore, they are exposed at `/metrics` in the Agent's server port (default `12345`).

docs/sources/tempo/configuration/grafana-agent/tail-based-sampling.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Probabilistic sampling strategies are easy to implement,
1818
but also run the risk of discarding relevant data that you'll later want.
1919

2020
Tail-based sampling works with Grafana Agent in Flow or static modes.
21-
Flow mode configuration files are [written in River](/docs/agent/latest/flow/concepts/config-language).
22-
Static mode configuration files are [written in YAML](/docs/agent/latest/static/configuration).
23-
Examples in this document are for Flow mode. You can also use the [Static mode Kubernetes operator](/docs/agent/latest/operator).
21+
Flow mode configuration files are [written in River](/docs/agent/<AGENT_VERSION>/flow/concepts/config-language).
22+
Static mode configuration files are [written in YAML](/docs/agent/<AGENT_VERSION>/static/configuration).
23+
Examples in this document are for Flow mode. You can also use the [Static mode Kubernetes operator](/docs/agent/<AGENT_VERSION>/operator).
2424

2525
## How tail-based sampling works
2626

@@ -57,7 +57,7 @@ This overhead increases with the number of Agent instances that share the same t
5757
To start using tail-based sampling, define a sampling policy.
5858
If you're using a multi-instance deployment of the agent,
5959
add load balancing and specify the resolving mechanism to find other Agents in the setup.
60-
To see all the available configuration options, refer to the [configuration reference](/docs/agent/latest/configuration/traces-config/).
60+
To see all the available configuration options, refer to the [configuration reference](/docs/agent/<AGENT_VERSION>/configuration/traces-config/).
6161

6262
{{< admonition type="note">}}
6363
Grafana Alloy provides tooling to convert your Agent Static or Flow configuration files into a format that can be used by Alloy.
@@ -67,10 +67,10 @@ For more information, refer to [Migrate to Alloy](https://grafana.com/docs/tempo
6767

6868
### Example for Grafana Agent Flow
6969

70-
[Grafana Agent Flow](/docs/agent/latest/flow/) is a component-based revision of Grafana Agent with a focus on ease-of-use, debuggability, and ability to adapt to the needs of power users.
70+
[Grafana Agent Flow](/docs/agent/<AGENT_VERSION>/flow/) is a component-based revision of Grafana Agent with a focus on ease-of-use, debuggability, and ability to adapt to the needs of power users.
7171
Flow configuration files are written in River instead of YAML.
7272

73-
Grafana Agent Flow uses the [`otelcol.processor.tail_sampling component`](/docs/agent/latest/flow/reference/components/otelcol.processor.tail_sampling/)` for tail-based sampling.
73+
Grafana Agent Flow uses the [`otelcol.processor.tail_sampling component`](/docs/agent/<ALLOY_VERSION>/flow/reference/components/otelcol/otelcol.processor.tail_sampling/)` for tail-based sampling.
7474

7575
```river
7676
otelcol.receiver.otlp "otlp_receiver" {

docs/sources/tempo/configuration/grafana-alloy/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Alloy is flexible, and you can easily configure it to fit your needs in on-prem,
1818
It's commonly used as a tracing pipeline, offloading traces from the
1919
application and forwarding them to a storage backend.
2020

21-
Grafana Alloy configuration files are written in the [Alloy configuration syntax](https://grafana.com/docs/alloy/latest/concepts/configuration-syntax/).
21+
Grafana Alloy configuration files are written in the [Alloy configuration syntax](https://grafana.com/docs/alloy/<ALLOY_VERSION>/get-started/configuration-syntax/).
2222

2323
For more information, refer to the [Introduction to Grafana Alloy](https://grafana.com/docs/alloy/latest/introduction).
2424

@@ -52,13 +52,13 @@ Grafana Alloy processes tracing data as it flows through the pipeline to make th
5252

5353
Alloy supports batching of traces.
5454
Batching helps better compress the data, reduces the number of outgoing connections, and is a recommended best practice.
55-
To configure it, refer to the `otelcol.processor.batch` block in the [components reference](https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.batch/).
55+
To configure it, refer to the `otelcol.processor.batch` block in the [components reference](https://grafana.com/docs/alloy/<ALLOY_VERSION>/reference/components/otelcol/otelcol.processor.batch/).
5656

5757
#### Attributes manipulation
5858

5959
Grafana Alloy allows for general manipulation of attributes on spans that pass through it.
6060
A common use may be to add an environment or cluster variable.
61-
There are several processors that can manipulate attributes, some examples include: the `otelcol.processor.attributes` block in the [component reference](https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.attributes/) and the `otelcol.processor.transform` block [component reference](https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.transform/)
61+
There are several processors that can manipulate attributes, some examples include: the `otelcol.processor.attributes` block in the [component reference](https://grafana.com/docs/alloy/<ALLOY_VERSION>/reference/components/otelcol/otelcol.processor.attributes/) and the `otelcol.processor.transform` block [component reference](https://grafana.com/docs/alloy/<ALLOY_VERSION>/reference/components/otelcol/otelcol.processor.transform/)
6262

6363
#### Attaching metadata with Prometheus Service Discovery
6464

@@ -97,7 +97,7 @@ otelcol.exporter.otlp "default" {
9797
}
9898
```
9999

100-
Refer to the `otelcol.processor.k8sattributes` block in the [components reference](https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.k8sattributes/).
100+
Refer to the `otelcol.processor.k8sattributes` block in the [components reference](https://grafana.com/docs/alloy/<ALLOY_VERSION>/reference/components/otelcol/otelcol.processor.k8sattributes/).
101101

102102
#### Trace discovery through automatic logging
103103

@@ -138,4 +138,4 @@ Aside from endpoint and authentication, the exporter also provides mechanisms fo
138138
and implements a queue buffering mechanism for transient failures, such as networking issues.
139139

140140
To see all available options,
141-
refer to the `otelcol.exporter.otlp` block in the [Alloy configuration reference](https://grafana.com/docs/alloy/latest/reference/components/otelcol.exporter.otlp/) and the `otelcol.exporter.otlphttp` block in the [Alloy configuration reference](https://grafana.com/docs/alloy/latest/reference/components/otelcol.exporter.otlphttp/).
141+
refer to the `otelcol.exporter.otlp` block in the [Alloy configuration reference](https://grafana.com/docs/alloy/<ALLOY_VERSION>/reference/components/otelcol/otelcol.exporter.otlp/) and the `otelcol.exporter.otlphttp` block in the [Alloy configuration reference](https://grafana.com/docs/alloy/<ALLOY_VERSION>/reference/components/otelcol/otelcol.exporter.otlphttp/).

docs/sources/tempo/configuration/grafana-alloy/automatic-logging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ pipeline. This allows for automatically building a mechanism for trace discovery
2525
On top of that, you can also get metrics from traces using a logs source, and
2626
allow quickly jumping from a log message to the trace view in Grafana.
2727

28-
While this approach is useful, it isn't as powerful as TraceQL.
28+
While this approach is useful, it isn't as powerful as TraceQL.
2929
If you are here because you know you want to log the
3030
trace ID, to enable jumping from logs to traces, then read on.
3131

@@ -47,7 +47,7 @@ This allows searching by those key-value pairs in Loki.
4747
To configure automatic logging, you need to configure the `otelcol.connector.spanlogs` connector with
4848
appropriate options.
4949

50-
To see all the available configuration options, refer to the `otelcol.connector.spanlogs` [components reference](https://grafana.com/docs/alloy/latest/reference/components/otelcol.connector.spanlogs/).
50+
To see all the available configuration options, refer to the `otelcol.connector.spanlogs` [components reference](https://grafana.com/docs/alloy/<ALLOY_VERSION>/reference/components/otelcol/otelcol.connector.spanlogs/).
5151

5252
This simple example logs trace roots before exporting them to the Grafana OTLP gateway,
5353
and is a good way to get started using automatic logging:

docs/sources/tempo/configuration/grafana-alloy/service-graphs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ otelcol.exporter.otlp "default" {
6363
}
6464
```
6565

66-
To see all the available configuration options, refer to the [component reference](https://grafana.com/docs/alloy/latest/reference/components/otelcol.connector.servicegraph/).
66+
To see all the available configuration options, refer to the [component reference](https://grafana.com/docs/alloy/<ALLOY_VERSION>/reference/components/otelcol/otelcol.connector.servicegraph/).
6767

6868
### Grafana
6969

docs/sources/tempo/configuration/grafana-alloy/tail-sampling/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ There are a number of ways to lower trace volume, including varying sampling str
1414

1515
Sampling is the process of determining which traces to store (in Tempo or Grafana Cloud Traces) and which to discard. Sampling comes in two different strategy types: head and tail sampling.
1616

17-
Sampling functionality exists in both [Grafana Alloy](https://grafana.com/docs/alloy/) and the OpenTelemetry Collector. Alloy can collect, process, and export telemetry signals, with configuration files written in [Alloy configuration syntax](https://grafana.com/docs/alloy/<ALLOY_VERSION>/concepts/configuration-syntax/).
17+
Sampling functionality exists in both [Grafana Alloy](https://grafana.com/docs/alloy/) and the OpenTelemetry Collector. Alloy can collect, process, and export telemetry signals, with configuration files written in [Alloy configuration syntax](https://grafana.com/docs/alloy/<ALLOY_VERSION>/get-started/configuration-syntax/).
1818

19-
Refer to [Enable tail sampling](https://grafana.com/docs/tempo/<TEMPO_VERSION>/configuration/grafana-alloy/enable-tail-sampling/) for instructions on how to enable tail sampling.
19+
Refer to [Enable tail sampling](https://grafana.com/docs/tempo/<TEMPO_VERSION>/configuration/grafana-alloy/tail-sampling/enable-tail-sampling/) for instructions.
2020

2121
## Head and tail sampling
2222

0 commit comments

Comments
 (0)