Skip to content

Commit 8587b6e

Browse files
[v2.5.x] Remove relref shortcodes (#4823)
* relref replace - tempo * Update docs/sources/tempo/api_docs/_index.md --------- Co-authored-by: Kim Nylander <[email protected]>
1 parent 500e730 commit 8587b6e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+242
-243
lines changed

docs/sources/tempo/api_docs/_index.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Agent, OpenTelemetry Collector, or Jaeger Agent.
9393
| Jaeger | GRPC | [Link](https://www.jaegertracing.io/docs/latest/apis/#span-reporting-apis) |
9494
| Zipkin | HTTP | [Link](https://zipkin.io/zipkin-api/) |
9595

96-
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" >}}).
96+
For information on how to use the Zipkin endpoint with curl (for debugging purposes), refer to [Pushing spans with HTTP](pushing-spans-with-http/).
9797

9898
### Query
9999

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

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

151151
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.
152152

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

164164
**Parameters for TraceQL Search**
165165

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

168168
**Parameters for Tag Based Search**
169169

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

178178
- `limit = (integer)`
179-
Optional. Limit the number of search results. Default is 20, but this is configurable in the querier. Refer to [Configuration]({{< relref "../configuration#querier" >}}).
179+
Optional. Limit the number of search results. Default is 20, but this is configurable in the querier. Refer to [Configuration](../configuration/#querier).
180180
- `start = (unix epoch seconds)`
181181
Optional. Along with `end` define a time range from which traces should be returned.
182182
- `end = (unix epoch seconds)`
@@ -411,7 +411,7 @@ Parameters:
411411
412412
This endpoint retrieves all discovered values and their data types for the given TraceQL identifier.
413413
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.
414-
See [TraceQL]({{< relref "../traceql" >}}) documentation for more information.
414+
See [TraceQL](../traceql/) documentation for more information.
415415
416416
#### Example
417417
@@ -449,7 +449,7 @@ This endpoint can also receive `start` and `end` optional parameters. These para
449449
#### Filtered tag values
450450
451451
The `autocomplete_filtering_enabled` configuration parameter is set to `true` by default. This provides an optional URL query parameter, `q`, to your request.
452-
The `q` parameter is a URL-encoded [TraceQL query]({{< relref "../traceql" >}}).
452+
The `q` parameter is a URL-encoded [TraceQL query](../traceql/).
453453
If provided, the tag values returned by the API are filtered to only return values seen on spans matching your filter parameters.
454454
455455
Queries can be incomplete: for example, `{ .cluster = }`. Tempo extracts only the valid matchers and build a valid query.
@@ -480,7 +480,7 @@ Meant to be used in a Query Visualization UI like Grafana to test that the Tempo
480480
481481
### Overrides API
482482
483-
For more information about user-configurable overrides API, refer to the [user-configurable overrides]({{< relref "../operations/user-configurable-overrides#api" >}}) documentation.
483+
For more information about user-configurable overrides API, refer to the [user-configurable overrides](../operations/user-configurable-overrides/#api) documentation.
484484
485485
### Flush
486486
@@ -512,7 +512,7 @@ This is usually used at the time of scaling down a cluster.
512512
### Distributor ring status
513513
514514
{{< admonition type="note" >}}
515-
This endpoint is only available when Tempo is configured with [the global override strategy]({{< relref "../configuration#overrides" >}}).
515+
This endpoint is only available when Tempo is configured with [the global override strategy](../configuration/#overrides).
516516
{{% /admonition %}}
517517
518518
```
@@ -522,7 +522,7 @@ GET /distributor/ring
522522
Displays a web page with the distributor hash ring status, including the state, healthy, and last heartbeat time of each
523523
distributor.
524524
525-
_For more information, check the page on [consistent hash ring]({{< relref "../operations/consistent_hash_ring" >}})._
525+
_For more information, check the page on [consistent hash ring](../operations/consistent_hash_ring/)._
526526
527527
### Ingesters ring status
528528
@@ -532,7 +532,7 @@ GET /ingester/ring
532532
533533
Displays a web page with the ingesters hash ring status, including the state, healthy, and last heartbeat time of each ingester.
534534
535-
_For more information, check the page on [consistent hash ring]({{< relref "../operations/consistent_hash_ring" >}}).
535+
_For more information, check the page on [consistent hash ring](../operations/consistent_hash_ring/).
536536
537537
### Metrics-generator ring status
538538
@@ -542,9 +542,9 @@ GET /metrics-generator/ring
542542
543543
Displays a web page with the metrics-generator hash ring status, including the state, health, and last heartbeat time of each metrics-generator.
544544
545-
This endpoint is only available when the metrics-generator is enabled. Refer to [metrics-generator]({{< relref "../configuration#metrics-generator" >}}).
545+
This endpoint is only available when the metrics-generator is enabled. Refer to [metrics-generator](../configuration/#metrics-generator).
546546
547-
For more information, refer to [consistent hash ring]({{< relref "../operations/consistent_hash_ring" >}}).
547+
For more information, refer to [consistent hash ring](../operations/consistent_hash_ring/).
548548
549549
### Compactor ring status
550550
@@ -554,7 +554,7 @@ GET /compactor/ring
554554
555555
Displays a web page with the compactor hash ring status, including the state, healthy and last heartbeat time of each compactor.
556556
557-
For more information, refer to [consistent hash ring]({{< relref "../operations/consistent_hash_ring" >}}).
557+
For more information, refer to [consistent hash ring](../operations/consistent_hash_ring/).
558558
559559
### Status
560560

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To use this procedure, you need to have Docker and `docker compose` installed.
2020

2121
## Start Tempo using the quick start
2222

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

2525
## Push spans with OTLP
2626

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

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

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

116116
```bash

docs/sources/tempo/configuration/_index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The Tempo configuration options include:
4040
- [Usage-report](#usage-report)
4141
- [Cache](#cache)
4242

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

4545
## Use environment variables in the configuration
4646

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

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

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

@@ -731,10 +731,10 @@ The storage block configures TempoDB.
731731
The following example shows common options.
732732
For further platform-specific information, refer to the following:
733733
734-
* [GCS]({{< relref "./hosted-storage/gcs" >}})
735-
* [S3]({{< relref "./hosted-storage/s3" >}})
736-
* [Azure]({{< relref "./hosted-storage/azure" >}})
737-
* [Parquet]({{< relref "./parquet" >}})
734+
* [GCS](hosted-storage/gcs/)
735+
* [S3](hosted-storage/s3/)
736+
* [Azure](hosted-storage/azure/)
737+
* [Parquet](parquet/)
738738
739739
```yaml
740740
# Storage configuration for traces
@@ -1550,7 +1550,7 @@ overrides:
15501550

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

15551555
#### Override strategies
15561556

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,22 +119,22 @@ Refer to the `scrape_configs` block in the [configuration reference](/docs/agent
119119

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

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

124124
#### Tail-based sampling
125125

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

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

131131
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).
132132

133133
#### Generating metrics from spans
134134

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

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

139139
#### Service graph metrics
140140

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

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

149149
### Exporting spans
150150

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ and the connections and dependencies between its components.
1717

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

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

2525
## Before you begin
2626

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

73-
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" >}}).
73+
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/).

docs/sources/tempo/configuration/grafana-agent/span-metrics.md

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

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

4545
## Example
4646

docs/sources/tempo/configuration/hosted-storage/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ aliases:
1111

1212
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.
1313

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

1616
{{< section withDescriptions="true">}}

docs/sources/tempo/configuration/hosted-storage/gcs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ aliases:
77

88
# Google Cloud Storage
99

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

1212
## Permissions
1313

docs/sources/tempo/configuration/hosted-storage/s3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ aliases:
88

99
# Amazon S3 permissions
1010

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

1313
The following authentication methods are supported:
1414
- AWS environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`

docs/sources/tempo/configuration/manifest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 110
88

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

1313
It was generated by running Tempo with a minimal configuration and accessing the `/status/config` endpoint:
1414
```

0 commit comments

Comments
 (0)