-
Notifications
You must be signed in to change notification settings - Fork 487
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[release-v2.4] [DOC] Tempo landing page for docs (#3549)
* [DOC] Tempo landing page for docs (#3540) * Tempo landing page for docs * Fix missing period on API docs (cherry picked from commit 4357c52) * Update docs/sources/tempo/_index.md --------- Co-authored-by: Kim Nylander <[email protected]>
- Loading branch information
1 parent
7333160
commit dd34700
Showing
2 changed files
with
42 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,56 @@ | ||
--- | ||
title: Tempo documentation | ||
title: Grafana Tempo | ||
description: Grafana Tempo is an open source distributed tracing backend. | ||
aliases: | ||
- /docs/tempo/ | ||
cascade: | ||
GRAFANA_VERSION: next | ||
hero: | ||
title: Grafana Tempo | ||
level: 1 | ||
image: /static/assets/img/blog/tempo.png | ||
width: 110 | ||
height: 110 | ||
description: >- | ||
Grafana Tempo is an open-source, easy-to-use, and high-scale distributed tracing backend. Tempo lets you search for traces, generate metrics from spans, and link your tracing data with logs and metrics. | ||
cards: | ||
title_class: pt-0 lh-1 | ||
items: | ||
- title: Learn about tracing | ||
href: /docs/tempo/latest/getting-started/ | ||
description: What is distributed tracing? Learn about traces and how you can use them, how you can instrument your app for tracing, and how you can visualize tracing data in Grafana. | ||
- title: Set up Tempo | ||
href: /docs/tempo/latest/setup/ | ||
description: Plan your deployment to meet your needs, deploy Tempo, test your installation, and configure Tempo services. | ||
- title: Manage Tempo | ||
href: /docs/tempo/latest/operations/ | ||
description: Learn about Tempo architecture, best practices, Parquet backend, dedicated attribute columns, metrics from traces, and more. | ||
- title: Metrics and tracing | ||
href: /docs/tempo/latest/metrics-generator/ | ||
description: Use metrics-generator to derive metrics from ingested traces. The metrics-generator processes spans and writes metrics to a Prometheus data source using the Prometheus remote write protocol. | ||
- title: Query with TraceQL | ||
href: /docs/tempo/latest/traceql/ | ||
description: Inspired by PromQL and LogQL, TraceQL is a query language desßigned for selecting traces in Tempo. This query language lets you precisely and easily select spans and jump directly to the spans fulfilling the specified conditions. | ||
--- | ||
|
||
# Tempo documentation | ||
{{< docs/hero-simple key="hero" >}} | ||
|
||
<p align="center"><img src="logo_and_name.png" alt="Tempo Logo"></p> | ||
--- | ||
|
||
Grafana Tempo is an open source, easy-to-use, and high-volume distributed tracing backend. Tempo is cost-efficient, and only requires an object storage to operate. Tempo is deeply integrated with Grafana, Mimir, Prometheus, and Loki. You can use Tempo with open-source tracing protocols, including Jaeger, Zipkin, or OpenTelemetry. | ||
## Overview | ||
|
||
Tempo implements [TraceQL](/docs/tempo/latest/traceql), a traces-first query language inspired by LogQL and PromQL. This query language allows users to very precisely and easily select spans and jump directly to the spans fulfilling the specified conditions. | ||
Distributed tracing visualizes the lifecycle of a request as it passes through a set of applications. | ||
|
||
Tempo integrates well with a number of existing open source tools: | ||
Tempo is cost-efficient, and only requires an object storage to operate. Tempo is deeply integrated with Grafana, Mimir, Prometheus, and Loki. You can use Tempo with open source tracing protocols, including Jaeger, Zipkin, or OpenTelemetry. | ||
<p align="center"><img src="getting-started/assets/trace_custom_metrics_dash.png" alt="Trace visualization in Grafana "></p> | ||
|
||
- **Grafana** ships with native support for Tempo using the built-in [Tempo data source](/docs/grafana/latest/datasources/tempo/). | ||
- **Grafana Loki**, with its powerful query language [LogQL v2](/blog/2020/10/28/loki-2.0-released-transform-logs-as-youre-querying-them-and-set-up-alerts-within-loki/) allows you to filter requests that you care about, and jump to traces using the [Derived fields support in Grafana](/docs/grafana/latest/datasources/loki/#derived-fields). | ||
- **Prometheus exemplars** let you jump from Prometheus metrics to Tempo traces by clicking on recorded exemplars. Read more about this integration in the blog post [Intro to exemplars, which enable Grafana Tempo’s distributed tracing at massive scale](/blog/2021/03/31/intro-to-exemplars-which-enable-grafana-tempos-distributed-tracing-at-massive-scale/). | ||
Tempo integrates well with a number of existing open source tools: | ||
|
||
<p align="center"><img src="getting-started/assets/trace_custom_metrics_dash.png" alt="Trace visualization in Grafana "></p> | ||
- **Grafana** ships with native support using the built-in [Tempo data source](/docs/grafana/latest/datasources/tempo/). | ||
- **Grafana Loki**, with its powerful query language LogQL v2 lets you filter requests that you care about, and jump to traces using the [Derived fields support in Grafana](/docs/grafana/latest/datasources/loki/#derived-fields). | ||
- **Prometheus exemplars** let you jump from Prometheus metrics to Tempo traces by clicking on recorded exemplars. | ||
|
||
Grafana Tempo builds an index from the high-cardinality trace-id field. Because Tempo uses an object store as a backend, Tempo can query many blocks simultaneously, so queries are highly parallelized. | ||
For more information, see [Architecture]({{< relref "./operations/architecture" >}}). | ||
## Explore | ||
|
||
## Learn more about Tempo | ||
{{< card-grid key="cards" type="simple" >}} | ||
|
||
{{< section >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters