Skip to content

Commit 72199d2

Browse files
yoannrobinyoannrobin
committed
Add APM naming conv description
1 parent 74331e6 commit 72199d2

File tree

1 file changed

+38
-22
lines changed

1 file changed

+38
-22
lines changed

‎content/en/tracing/trace_explorer/tracing_naming_convention.md

Lines changed: 38 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,27 @@
1-
### Default standard attribute list
1+
---
2+
title: Span tags naming convention
3+
kind: documentation
4+
further_reading:
5+
- link: 'logs/log_configuration/attributes_naming_convention'
6+
tag: 'Documentation'
7+
text: 'Log Management Standard Attributes'
8+
- link: '/real_user_monitoring/browser/data_collected'
9+
tag: 'Documentation'
10+
text: 'RUM Browser Datad Collected'
11+
- link: '/tracing/trace_explorer/query_syntax/'
12+
tag: 'Documentation'
13+
text: 'Learn how to explore your traces'
14+
---
15+
16+
# Overview
17+
[Datadog tracing libraries][3] provide out-of-the-box support for instrumenting a variety of libraries.
18+
These instrumentations generate spans to represent logical unit of work in distributed systems.
19+
Each span consists of [span tags][4] providing extra layers of information on the unit of work happening on the system. The naming convention describe the name and content that can be used in span events.
20+
21+
# Span tags naming convention
22+
## Core
23+
The following span tags relates to the core concepts to describe the instrumentation used and the kind of operation performed.
224

3-
// TODO
4-
5-
#### General
6-
7-
// TODO
825
| **Name** | **Type** | **Description** |
926
|-------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1027
| `language` | `string` | The client SDK language used to generate the span. Can be one of `cpp`, `dotnet`, `go`, `jvm`, `javascript`, `php`, `python`, `ruby` |
@@ -13,8 +30,9 @@
1330
| `span.kind` | `string` | String representing the type of work unit handled by the span. Can be one of `server`, `client`, `producer`, `consumer` or `internal`.<br>More information from [OpenTelemetry SpanKind documentation][1] |
1431
| `component` | `string` | The name of the library/integration which created the span |
1532

16-
#### Network communications
17-
// TODO
33+
## Network communications
34+
The following span tags can be used to describe work units corresponding to network communications:
35+
1836
| **Fullname** | **Type** | **Description** |
1937
|---------------------------------|----------|---------------------------------------------------------------------------|
2038
| `network.client.ip` | `string` | The IP address of the client that initiated the inbound connection |
@@ -28,7 +46,8 @@
2846
| `network.client.transport` | `string` | Transport protocol used to make the inbound connection |
2947
| `network.destination.transport` | `string` | Transport protocol used to make the outbound connection |
3048

31-
#### HTTP requests
49+
## HTTP requests
50+
The following span tags can be used to describe HTTP client and server spans:
3251

3352
| **Fullname** | **Type** | **Description** |
3453
|---------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -46,9 +65,8 @@
4665
| `http.response.headers.*` | `string` | The response HTTP headers. None are collected by default but can optionally be configured with `DD_TRACE_HEADER_TAGS`. |
4766

4867

49-
#### Database & Cache
50-
51-
// TODO
68+
## Database
69+
The following span tags can be used to describe Databases spans:
5270

5371
| **Fullname** | **Type** | **Description** |
5472
|------------------------|----------|--------------------------------------------------------------------------------------------------------------|
@@ -63,9 +81,8 @@
6381

6482
Additional attributes for specific database technologies will use the prefix `db.<db.system>`.
6583

66-
#### Message Queue
67-
68-
// TODO
84+
## Message Queue
85+
The following span tags can be used to describe spans corresponding to messaging systems:
6986

7087
| **Fullname** | **Type** | **Description** |
7188
|----------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -83,20 +100,17 @@ Additional attributes for specific database technologies will use the prefix `db
83100

84101
Additional attributes for specific database technologies will use the prefix `messaging.<messaging.system>`.
85102

86-
#### Remote procedure calls
87-
88-
// TODO
103+
## Remote procedure calls
104+
The following span tags can be used to describe spans corresponding to remote procedure calls such as RMI or gRPC:
89105

90106
| **Fullname** | **Type** | **Description** |
91107
|---------------|----------|--------------------------------------|
92108
| `rpc.system` | `string` | Identifier of the remoting system |
93109
| `rpc.service` | `string` | The name of the service being called |
94110
| `rpc.method` | `string` | The name of the method being called |
95111

96-
97-
#### Errors
98-
99-
// TODO
112+
## Errors
113+
The following span tags can be used to describe errors associated with spans:
100114

101115
| **Fullname** | **Type** | **Description** |
102116
|-----------------|----------|------------------------------------------------------------------|
@@ -107,3 +121,5 @@ Additional attributes for specific database technologies will use the prefix `me
107121

108122
[1]: https://opentelemetry.io/docs/reference/specification/trace/api/#spankind
109123
[2]: /tracing/setup_overview/configure_data_security/
124+
[3]: /tracing/setup_overview/
125+
[4]: /tracing/visualization/#span-tags

0 commit comments

Comments
 (0)