Skip to content

Commit

Permalink
Merge branch 'main' into agent-sc
Browse files Browse the repository at this point in the history
  • Loading branch information
gyliu513 authored Jan 15, 2025
2 parents c7fa834 + 8d9d4a1 commit f4c961a
Show file tree
Hide file tree
Showing 9 changed files with 139 additions and 32 deletions.
4 changes: 4 additions & 0 deletions .chloggen/rabbitmq-destination-name.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
change_type: breaking
component: messaging
note: "RabbitMQ: Specify how to populate `messaging.destination.name`"
issues: [1529]
2 changes: 1 addition & 1 deletion docs/database/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ database metrics and logs.
> metric and span names, and unit of measure.
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
> in the existing major version which is a comma-separated list of values.
> If the list of values includes:
> The list of values includes:
> * `database` - emit the new, stable database conventions,
> and stop emitting the old experimental database conventions
> that the instrumentation emitted previously.
Expand Down
2 changes: 1 addition & 1 deletion docs/database/database-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ linkTitle: Metrics
> metric and span names, and unit of measure.
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
> in the existing major version which is a comma-separated list of values.
> If the list of values includes:
> The list of values includes:
> * `database` - emit the new, stable database conventions,
> and stop emitting the old experimental database conventions
> that the instrumentation emitted previously.
Expand Down
2 changes: 1 addition & 1 deletion docs/database/database-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ linkTitle: Client Calls
> metric and span names, and unit of measure.
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
> in the existing major version which is a comma-separated list of values.
> If the list of values includes:
> The list of values includes:
> * `database` - emit the new, stable database conventions,
> and stop emitting the old experimental database conventions
> that the instrumentation emitted previously.
Expand Down
47 changes: 26 additions & 21 deletions docs/messaging/rabbitmq.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,6 @@ The Semantic Conventions for [RabbitMQ](https://www.rabbitmq.com/) extend and ov

## RabbitMQ attributes

In RabbitMQ, the destination is defined by an *exchange* and a *routing key*.
`messaging.destination.name` MUST be set to the name of the exchange. This will be an empty string if the default exchange is used.

<!-- semconv messaging.rabbitmq -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
Expand All @@ -52,21 +49,34 @@ In RabbitMQ, the destination is defined by an *exchange* and a *routing key*.

| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [1] | `direct_logs:warning`; `logs` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [2] | `MyQueue`; `MyTopic` | `Conditionally Required` [3] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [4] | `create`; `send`; `receive` | `Conditionally Required` If applicable. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [2] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [3] | `create`; `send`; `receive` | `Conditionally Required` If applicable. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`messaging.rabbitmq.destination.routing_key`](/docs/attributes-registry/messaging.md) | string | RabbitMQ message routing key. | `myKey` | `Conditionally Required` If not empty. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`messaging.rabbitmq.message.delivery_tag`](/docs/attributes-registry/messaging.md) | int | RabbitMQ message delivery tag | `123` | `Conditionally Required` When available. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [5] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Conditionally Required` If available. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [4] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Conditionally Required` If available. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| [`messaging.message.conversation_id`](/docs/attributes-registry/messaging.md) | string | Message [correlation Id](https://www.rabbitmq.com/tutorials/tutorial-six-java#correlation-id) property. | `MyConversationId` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`messaging.message.id`](/docs/attributes-registry/messaging.md) | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | `Recommended` If span describes operation on a single message. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`network.peer.address`](/docs/attributes-registry/network.md) | string | Peer address of the network connection - IP address or Unix domain socket name. [6] | `10.1.2.80`; `/tmp/my.sock` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| [`network.peer.address`](/docs/attributes-registry/network.md) | string | Peer address of the network connection - IP address or Unix domain socket name. [5] | `10.1.2.80`; `/tmp/my.sock` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| [`network.peer.port`](/docs/attributes-registry/network.md) | int | Peer port number of the network connection. | `65123` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [7] | `80`; `8080`; `443` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| [`messaging.message.body.size`](/docs/attributes-registry/messaging.md) | int | The size of the message body in bytes. [8] | `1439` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [6] | `80`; `8080`; `443` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| [`messaging.message.body.size`](/docs/attributes-registry/messaging.md) | int | The size of the message body in bytes. [7] | `1439` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[1] `messaging.destination.name`:** In RabbitMQ, the destination is defined by an *exchange*, a *routing key* and for consumers, a *queue*.

`messaging.destination.name` SHOULD be set to:

- **On the producer side**: `{exchange}:{routing key}` when both values are present and non-empty.
When only one is available, only that value SHOULD be used. E.g., `{exchange}` or `{routing key}`.
Otherwise: `amq.default` when the default exchange is used and no routing key is provided

**[1] `error.type`:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
- **On the consumer side**: `{exchange}:{routing key}:{queue}` when all values are present and non-empty.
If any has an empty value (e.g., the default exchange is used) it SHOULD be omitted.
For cases when `{routing key}` and `{queue}` are equal, only one of them SHOULD
be used, e.g., `{exchange}:{routing key}`.

**[2] `error.type`:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality.

When `error.type` is set to a type (e.g., an exception type), its
canonical class name identifying the type within the artifact SHOULD be used.
Expand All @@ -86,20 +96,15 @@ it's RECOMMENDED to:
- Use a domain-specific attribute
- Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not.

**[2] `messaging.destination.name`:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.

**[3] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch.

**[4] `messaging.operation.type`:** If a custom value is used, it MUST be of low cardinality.
**[3] `messaging.operation.type`:** If a custom value is used, it MUST be of low cardinality.

**[5] `server.address`:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
**[4] `server.address`:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.

**[6] `network.peer.address`:** If an operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used.
**[5] `network.peer.address`:** If an operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used.

**[7] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.
**[6] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.

**[8] `messaging.message.body.size`:** This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed
**[7] `messaging.message.body.size`:** This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed
body size should be used.

The following attributes can be important for making sampling decisions
Expand Down
5 changes: 3 additions & 2 deletions internal/tools/go.mod
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
module github.com/open-telemetry/opentelemetry-specification/internal/tools

go 1.22
toolchain go1.22.5
go 1.22.0

toolchain go1.23.4

require (
github.com/client9/misspell v0.3.4
Expand Down
16 changes: 16 additions & 0 deletions model/messaging/spans.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,22 @@ groups:
Message [correlation Id](https://www.rabbitmq.com/tutorials/tutorial-six-java#correlation-id) property.
- ref: messaging.message.body.size
requirement_level: opt_in
- ref: messaging.destination.name
note: |
In RabbitMQ, the destination is defined by an *exchange*, a *routing key* and for consumers, a *queue*.
`messaging.destination.name` SHOULD be set to:
- **On the producer side**: `{exchange}:{routing key}` when both values are present and non-empty.
When only one is available, only that value SHOULD be used. E.g., `{exchange}` or `{routing key}`.
Otherwise: `amq.default` when the default exchange is used and no routing key is provided
- **On the consumer side**: `{exchange}:{routing key}:{queue}` when all values are present and non-empty.
If any has an empty value (e.g., the default exchange is used) it SHOULD be omitted.
For cases when `{routing key}` and `{queue}` are equal, only one of them SHOULD
be used, e.g., `{exchange}:{routing key}`.
examples: ['direct_logs:warning', 'logs']
requirement_level: required

- id: messaging.kafka
type: attribute_group
Expand Down
9 changes: 4 additions & 5 deletions policies/compatibility.rego
Original file line number Diff line number Diff line change
Expand Up @@ -211,15 +211,14 @@ deny contains back_comp_violation(description, group_id, attr.name) if {
description := sprintf("Enum '%s' had stable value '%s', but is now '%s'", [attr.name, member.value, nmember.value])
}

# Rule: Detect Stable Enum members missing
# Rule: Detect missing Enum members
#
# This rule checks for enum values that were stable in the baseline registry
# but are no longer have the same values in the current registry. Once stable,
# enum values remain forever but may be deprecated.
# This rule checks for missing enum values that were present in the baseline registry
# but no longer exist in the current registry. Once added, regardless of their stability,
# enum values must remain in the registry but may be marked as deprecated.
deny contains back_comp_violation(description, group_id, attr.name) if {
# Find data we need to enforce: Enums in baseline/current.
some attr in baseline_attributes
attr.stability == "stable"
some nattr in registry_attributes
attr.name == nattr.name
is_enum(attr)
Expand Down
84 changes: 83 additions & 1 deletion policies_test/compatibility_test.rego
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ test_attribute_enum_member_value_change if {
}
}

# Check stable attribute enum member values changing
# Check enum member missing for attributes of any stability level
test_attribute_enum_member_missing if {
count(deny) > 0 with data.semconv as {
"registry_baseline_groups": [{
Expand Down Expand Up @@ -429,6 +429,88 @@ test_attribute_enum_member_missing if {
"test.missing": "registry.test"
}
}
count(deny) > 0 with data.semconv as {
"registry_baseline_groups": [{
"id": "registry.test",
"type": "attribute_group",
"attributes": [{
"name": "test.missing",
"stability": "stable",
"type": {
"members": [{
"id": "test",
"value": "test",
"stability": "experimental",
}, {
"id": "missing",
"value": "missing",
"stability": "experimental",
}]
},
}]
}],
"registry_groups": [{
"id": "registry.test",
"type": "attribute_group",
"attributes": [{
"name": "test.missing",
"stability": "stable",
"type": {
"members": [{
"id": "test",
"value": "test",
"stability": "experimental",
}]
},
}]
}],
"baseline_group_ids_by_attribute": {
"test.missing": "registry.test"
}
}
count(deny) == 0 with data.semconv as {
"registry_baseline_groups": [{
"id": "registry.test",
"type": "attribute_group",
"attributes": [{
"name": "test.missing",
"stability": "stable",
"type": {
"members": [{
"id": "test",
"value": "test",
"stability": "experimental",
}, {
"id": "missing",
"value": "missing",
"stability": "experimental",
}]
},
}]
}],
"registry_groups": [{
"id": "registry.test",
"type": "attribute_group",
"attributes": [{
"name": "test.missing",
"stability": "stable",
"type": {
"members": [{
"id": "test",
"value": "test",
"stability": "experimental",
}, {
"id": "missing",
"value": "missing",
"stability": "experimental",
}]
},
}]
}],
"baseline_group_ids_by_attribute": {
"test.missing": "registry.test"
}
}
}

# Check that metrics cannot be removed.
Expand Down

0 comments on commit f4c961a

Please sign in to comment.