Skip to content

Commit 1feaeb4

Browse files
Add more info about intrinsic to TraceQL doc (grafana#5851)
1 parent 5030837 commit 1feaeb4

File tree

2 files changed

+20
-18
lines changed

2 files changed

+20
-18
lines changed

docs/sources/tempo/shared/trace-structure.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ labels:
77
- oss
88
---
99

10-
[//]: # 'This file explains trace structure.'
11-
[//]: # 'This shared file is included in these locations:'
12-
[//]: # '/grafana/docs/sources/datasources/tempo/traceql/trace-structure.md'
13-
[//]: # '/grafana/docs/sources/datasources/tempo/introduction/trace-structure.md'
14-
[//]: # '/explore-profiles/docs/concepts/trace-structure.md'
15-
[//]: # '/website/docs/grafana-cloud/send-data/traces/trace-structure.md'
10+
[//]: # "This file explains trace structure."
11+
[//]: # "This shared file is included in these locations:"
12+
[//]: # "/grafana/docs/sources/datasources/tempo/traceql/trace-structure.md"
13+
[//]: # "/grafana/docs/sources/datasources/tempo/introduction/trace-structure.md"
14+
[//]: # "/explore-profiles/docs/concepts/trace-structure.md"
15+
[//]: # "/website/docs/grafana-cloud/send-data/traces/trace-structure.md"
1616
[//]: #
17-
[//]: # 'If you make changes to this file, verify that the meaning and content are not changed in any place where the file is included.'
18-
[//]: # 'Any links should be fully qualified and not relative.'
17+
[//]: # "If you make changes to this file, verify that the meaning and content are not changed in any place where the file is included."
18+
[//]: # "Any links should be fully qualified and not relative."
1919

2020
<!-- Trace structure -->
2121

@@ -33,24 +33,26 @@ In the specific context of Tempo and [TraceQL query language](https://grafana.co
3333
- **kind**: enum: `{server, client, producer, consumer, internal, unspecified}`. For more details, refer to [OTel span kind](https://opentelemetry.io/docs/concepts/signals/traces/#span-kind) documentation.
3434
- Attributes
3535

36-
The first four properties are *intrinsics*.
37-
They are fundamental to the span.
36+
The first four properties are _intrinsics_.
37+
Intrinsics are the core, built-in fields that are fundamental to the identity and lifecycle of spans and traces.
38+
These fields are defined by the OpenTelemetry specification and are always present.
39+
They describe the essential structure of distributed tracing data.
3840

39-
*Attributes* are custom span metadata in the form of key-value pairs.
41+
_Attributes_ are custom span metadata in the form of key-value pairs.
4042
There are four types of attributes: span attributes, resource attributes, event attributes, and link attributes.
4143

42-
*Span attributes* are key-value pairs that contain metadata that you can use to annotate a span to carry information about the operation it's tracking.
44+
_Span attributes_ are key-value pairs that contain metadata that you can use to annotate a span to carry information about the operation it's tracking.
4345
For example, in an eCommerce application, if a span tracks an operation that adds an item to a user’s shopping cart, the user ID, added item ID and cart ID can be captured and attached to the span as span attributes.
4446

45-
A *resource attribute* represents information about an entity producing the span.
47+
A _resource attribute_ represents information about an entity producing the span.
4648
For example, a span created by a process running in a container deployed by Kubernetes could link a resource that specifies the cluster name, namespace, pod, and container name.
4749
Resource attributes are resource-related metadata (key-value pairs) that are describing the Resource.
4850

49-
An *event attribute* represents a unique point in the time during the span's duration. For more information, refer to [All about span events](https://grafana.com/blog/2024/08/15/all-about-span-events-what-they-are-and-how-to-query-them/#how-to-query-span-events-with-traceql) and [Span events](https://opentelemetry.io/docs/concepts/signals/traces/#span-events) in the OTEL documentation.
51+
An _event attribute_ represents a unique point in the time during the span's duration. For more information, refer to [All about span events](https://grafana.com/blog/2024/08/15/all-about-span-events-what-they-are-and-how-to-query-them/#how-to-query-span-events-with-traceql) and [Span events](https://opentelemetry.io/docs/concepts/signals/traces/#span-events) in the OTEL documentation.
5052

51-
A *link attribute* lets you query link data in a span.
53+
A _link attribute_ lets you query link data in a span.
5254
A span link associates one span with one or more other spans that are a causal relationship. For more information on span links, refer to the [Span Links](https://opentelemetry.io/docs/concepts/signals/traces/#span-links) documentation in the Open Telemetry project.
5355

5456
The OpenTelemetry specification defines Semantic Attributes for Spans and for Resources.
5557
Semantic Span Attributes are a set of naming schemes for attributes shared across languages, frameworks, and runtimes.
56-
For more details, refer to [Trace Semantic Conventions](https://opentelemetry.io/docs/specs/semconv/general/trace/) and [Resource Semantic Conventions](https://opentelemetry.io/docs/specs/semconv/resource/).
58+
For more details, refer to [Trace Semantic Conventions](https://opentelemetry.io/docs/specs/semconv/general/trace/) and [Resource Semantic Conventions](https://opentelemetry.io/docs/specs/semconv/resource/).

docs/sources/tempo/traceql/trace-structure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Learn about Trace structure and TraceQL
2+
title: Learn about trace structure and TraceQL
33
menuTitle: Learn about trace structure and TraceQL
44
description: Learn about trace structure and TraceQL queries.
55
weight: 250
@@ -8,7 +8,7 @@ keywords:
88
- TraceQL
99
---
1010

11-
# Learn aboutTrace structure and TraceQL
11+
# Learn about trace structure and TraceQL
1212

1313
[//]: # "Shared content for best practices for traces"
1414
[//]: # "This content is located in /tempo/docs/sources/shared/trace-structure.md"

0 commit comments

Comments
 (0)