[chore] Use consistent approach for overrides (#2813)

Author: thompson-tomo

docs/cli/cli-spans.md

@@ -27,8 +27,8 @@ This span describes CLI (Command Line Interfaces) program execution from a calle
 Instrumentations that have additional context about executed commands MAY use
 a different low-cardinality span name format and SHOULD document it.
 
-**Span status** SHOULD be set to Error if {process.exit.code} is not 0. Refer to
-the [Recording Errors](/docs/general/recording-errors.md) document for details on how to record span status.
+**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
+An Error is defined as when the `{process.exit.code}` attribute is not 0.
 
 **Span kind** SHOULD be `INTERNAL`.
 
@@ -93,8 +93,8 @@ This span describes CLI (Command Line Interfaces) program execution from a calle
 Instrumentations that have additional context about executed commands MAY use
 a different low-cardinality span name format and SHOULD document it.
 
-**Span status** SHOULD be set to Error if {process.exit.code} is not 0. Refer to
-the [Recording Errors](/docs/general/recording-errors.md) document for details on how to record span status.
+**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
+An Error is defined as when the `{process.exit.code}` attribute is not 0.
 
 **Span kind** SHOULD be `CLIENT`.
 

docs/database/database-spans.md

@@ -106,9 +106,8 @@ It's RECOMMENDED to use `CLIENT` kind when database system being instrumented us
 runs in a different process than its client or when database calls happen over
 instrumented protocol such as HTTP.
 
-**Span status** Refer to the [Recording Errors](/docs/general/recording-errors.md)
-document for details on how to record span status. Semantic conventions for
-individual systems SHOULD specify which values of `db.response.status_code`
+**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
+Semantic conventions for individual systems SHOULD specify which values of `db.response.status_code`
 classify as errors.
 
 **Attributes:**

docs/faas/aws-lambda.md

@@ -58,7 +58,7 @@ and the [cloud resource conventions][cloud].
 **Span name** MUST be set to the function name from the Lambda `Context`
 unless stated otherwise.
 
-**Span kind** MUST be set to `SERVER` unless stated otherwise.
+**Span kind** MUST be `SERVER` unless stated otherwise.
 
 **Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
 

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

@@ -183,7 +183,8 @@ Instrumentations SHOULD document the list of errors they report.
 Describes GenAI agent invocation.
 
 The `gen_ai.operation.name` SHOULD be `invoke_agent`.
-The **span name** SHOULD be `invoke_agent {gen_ai.agent.name}` if `gen_ai.agent.name` is readily available.
+
+**Span name** SHOULD be `invoke_agent {gen_ai.agent.name}` if `gen_ai.agent.name` is readily available.
 When `gen_ai.agent.name` is not available, it SHOULD be `invoke_agent`.
 Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format.
 

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

@@ -60,7 +60,7 @@ This span represents a client call to Generative AI model or service that genera
 Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format
 and MUST follow the overall [guidelines for span names](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.37.0/specification/trace/api.md#span).
 
-**Span kind** SHOULD be `CLIENT`and MAY be set to `INTERNAL` on spans representing
+**Span kind** SHOULD be `CLIENT` and MAY be set to `INTERNAL` on spans representing
 call to models running in the same process. It's RECOMMENDED to use `CLIENT` kind
 when the GenAI system being instrumented usually runs in a different process than its
 client or when the GenAI call happens over instrumented protocol such as HTTP.

model/aws/lambda-spans.yaml

@@ -12,7 +12,7 @@ groups:
       **Span name** MUST be set to the function name from the Lambda `Context`
       unless stated otherwise.
 
-      **Span kind** MUST be set to `SERVER` unless stated otherwise.
+      **Span kind** MUST be `SERVER` unless stated otherwise.
     attributes:
       - ref: aws.lambda.invoked_arn
         requirement_level: recommended

model/cli/spans.yaml

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

model/database/spans.yaml

@@ -130,9 +130,8 @@ groups:
       runs in a different process than its client or when database calls happen over
       instrumented protocol such as HTTP.
 
-      **Span status** Refer to the [Recording Errors](/docs/general/recording-errors.md)
-      document for details on how to record span status. Semantic conventions for
-      individual systems SHOULD specify which values of `db.response.status_code`
+      **Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
+      Semantic conventions for individual systems SHOULD specify which values of `db.response.status_code`
       classify as errors.
     span_kind: client
     extends: trace.db.common.full

model/gen-ai/spans.yaml

@@ -110,7 +110,7 @@ groups:
       Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format
       and MUST follow the overall [guidelines for span names](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.37.0/specification/trace/api.md#span).
 
-      **Span kind** SHOULD be `CLIENT`and MAY be set to `INTERNAL` on spans representing
+      **Span kind** SHOULD be `CLIENT` and MAY be set to `INTERNAL` on spans representing
       call to models running in the same process. It's RECOMMENDED to use `CLIENT` kind
       when the GenAI system being instrumented usually runs in a different process than its
       client or when the GenAI call happens over instrumented protocol such as HTTP.
@@ -255,7 +255,8 @@ groups:
       Describes GenAI agent invocation.
     note: |
       The `gen_ai.operation.name` SHOULD be `invoke_agent`.
-      The **span name** SHOULD be `invoke_agent {gen_ai.agent.name}` if `gen_ai.agent.name` is readily available.
+
+      **Span name** SHOULD be `invoke_agent {gen_ai.agent.name}` if `gen_ai.agent.name` is readily available.
       When `gen_ai.agent.name` is not available, it SHOULD be `invoke_agent`.
       Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format.