Skip to content

Commit a988085

Browse files
committed
Use consistent approach for overrides
1 parent 3c9bf46 commit a988085

File tree

9 files changed

+20
-20
lines changed

9 files changed

+20
-20
lines changed

docs/cli/cli-spans.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ This span describes CLI (Command Line Interfaces) program execution from a calle
2727
Instrumentations that have additional context about executed commands MAY use
2828
a different low-cardinality span name format and SHOULD document it.
2929

30-
**Span status** SHOULD be set to Error if {process.exit.code} is not 0. Refer to
31-
the [Recording Errors](/docs/general/recording-errors.md) document for details on how to record span status.
30+
**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
31+
An Error is defined as when the `{process.exit.code}` attribute is not 0.
3232

3333
**Span kind** SHOULD be `INTERNAL`.
3434

@@ -91,8 +91,8 @@ This span describes CLI (Command Line Interfaces) program execution from a calle
9191
Instrumentations that have additional context about executed commands MAY use
9292
a different low-cardinality span name format and SHOULD document it.
9393

94-
**Span status** SHOULD be set to Error if {process.exit.code} is not 0. Refer to
95-
the [Recording Errors](/docs/general/recording-errors.md) document for details on how to record span status.
94+
**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
95+
An Error is defined as when the `{process.exit.code}` attribute is not 0.
9696

9797
**Span kind** SHOULD be `CLIENT`.
9898

docs/database/database-spans.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,8 @@ It's RECOMMENDED to use `CLIENT` kind when database system being instrumented us
106106
runs in a different process than its client or when database calls happen over
107107
instrumented protocol such as HTTP.
108108

109-
**Span status** Refer to the [Recording Errors](/docs/general/recording-errors.md)
110-
document for details on how to record span status. Semantic conventions for
111-
individual systems SHOULD specify which values of `db.response.status_code`
109+
**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
110+
Semantic conventions for individual systems SHOULD specify which values of `db.response.status_code`
112111
classify as errors.
113112

114113
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |

docs/faas/aws-lambda.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ and the [cloud resource conventions][cloud].
5858
**Span name** MUST be set to the function name from the Lambda `Context`
5959
unless stated otherwise.
6060

61-
**Span kind** MUST be set to `SERVER` unless stated otherwise.
61+
**Span kind** MUST be `SERVER` unless stated otherwise.
6262

6363
**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
6464

docs/gen-ai/gen-ai-agent-spans.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,8 @@ Instrumentations SHOULD document the list of errors they report.
181181
Describes GenAI agent invocation and is usually applicable when working with remote agent services.
182182

183183
The `gen_ai.operation.name` SHOULD be `invoke_agent`.
184-
The **span name** SHOULD be `invoke_agent {gen_ai.agent.name}` if `gen_ai.agent.name` is readily available.
184+
185+
**Span name** SHOULD be `invoke_agent {gen_ai.agent.name}` if `gen_ai.agent.name` is readily available.
185186
When `gen_ai.agent.name` is not available, it SHOULD be `invoke_agent`.
186187
Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format.
187188

docs/gen-ai/gen-ai-spans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ This span represents a client call to Generative AI model or service that genera
6060
Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format
6161
and MUST follow the overall [guidelines for span names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.37.0/specification/trace/api.md#span).
6262

63-
**Span kind** SHOULD be `CLIENT`and MAY be set to `INTERNAL` on spans representing
63+
**Span kind** SHOULD be `CLIENT` and MAY be set to `INTERNAL` on spans representing
6464
call to models running in the same process. It's RECOMMENDED to use `CLIENT` kind
6565
when the GenAI system being instrumented usually runs in a different process than its
6666
client or when the GenAI call happens over instrumented protocol such as HTTP.

model/aws/lambda-spans.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ groups:
1212
**Span name** MUST be set to the function name from the Lambda `Context`
1313
unless stated otherwise.
1414
15-
**Span kind** MUST be set to `SERVER` unless stated otherwise.
15+
**Span kind** MUST be `SERVER` unless stated otherwise.
1616
attributes:
1717
- ref: aws.lambda.invoked_arn
1818
requirement_level: recommended

model/cli/spans.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ groups:
2929
Instrumentations that have additional context about executed commands MAY use
3030
a different low-cardinality span name format and SHOULD document it.
3131
32-
**Span status** SHOULD be set to Error if {process.exit.code} is not 0. Refer to
33-
the [Recording Errors](/docs/general/recording-errors.md) document for details on how to record span status.
32+
**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
33+
An Error is defined as when the `{process.exit.code}` attribute is not 0.
3434
extends: attributes.cli.common
3535

3636
- id: span.cli.client
@@ -44,6 +44,6 @@ groups:
4444
Instrumentations that have additional context about executed commands MAY use
4545
a different low-cardinality span name format and SHOULD document it.
4646
47-
**Span status** SHOULD be set to Error if {process.exit.code} is not 0. Refer to
48-
the [Recording Errors](/docs/general/recording-errors.md) document for details on how to record span status.
47+
**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
48+
An Error is defined as when the `{process.exit.code}` attribute is not 0.
4949
extends: attributes.cli.common

model/database/spans.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,9 +130,8 @@ groups:
130130
runs in a different process than its client or when database calls happen over
131131
instrumented protocol such as HTTP.
132132
133-
**Span status** Refer to the [Recording Errors](/docs/general/recording-errors.md)
134-
document for details on how to record span status. Semantic conventions for
135-
individual systems SHOULD specify which values of `db.response.status_code`
133+
**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
134+
Semantic conventions for individual systems SHOULD specify which values of `db.response.status_code`
136135
classify as errors.
137136
span_kind: client
138137
extends: trace.db.common.full

model/gen-ai/spans.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ groups:
110110
Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format
111111
and MUST follow the overall [guidelines for span names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.37.0/specification/trace/api.md#span).
112112
113-
**Span kind** SHOULD be `CLIENT`and MAY be set to `INTERNAL` on spans representing
113+
**Span kind** SHOULD be `CLIENT` and MAY be set to `INTERNAL` on spans representing
114114
call to models running in the same process. It's RECOMMENDED to use `CLIENT` kind
115115
when the GenAI system being instrumented usually runs in a different process than its
116116
client or when the GenAI call happens over instrumented protocol such as HTTP.
@@ -256,7 +256,8 @@ groups:
256256
with remote agent services.
257257
note: |
258258
The `gen_ai.operation.name` SHOULD be `invoke_agent`.
259-
The **span name** SHOULD be `invoke_agent {gen_ai.agent.name}` if `gen_ai.agent.name` is readily available.
259+
260+
**Span name** SHOULD be `invoke_agent {gen_ai.agent.name}` if `gen_ai.agent.name` is readily available.
260261
When `gen_ai.agent.name` is not available, it SHOULD be `invoke_agent`.
261262
Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format.
262263
extends: attributes.gen_ai.inference.client

0 commit comments

Comments
 (0)