Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 142 additions & 0 deletions javascript/sentry-conventions/src/attributes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10904,6 +10904,90 @@ export const MESSAGING_DESTINATION_NAME = 'messaging.destination.name';
*/
export type MESSAGING_DESTINATION_NAME_TYPE = string;

// Path: model/attributes/messaging/messaging__destination__partition__id.json

/**
* The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name. `messaging.destination.partition.id`
*
* Attribute Value Type: `string` {@link MESSAGING_DESTINATION_PARTITION_ID_TYPE}
*
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: Yes
* Visibility: public
*
* @example "1"
*/
export const MESSAGING_DESTINATION_PARTITION_ID = 'messaging.destination.partition.id';

/**
* Type for {@link MESSAGING_DESTINATION_PARTITION_ID} messaging.destination.partition.id
*/
export type MESSAGING_DESTINATION_PARTITION_ID_TYPE = string;

// Path: model/attributes/messaging/messaging__kafka__message__key.json

/**
* Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition. They differ from messaging.message.id in that they're not unique. If the key is null, the attribute MUST NOT be set. `messaging.kafka.message.key`
*
* Attribute Value Type: `string` {@link MESSAGING_KAFKA_MESSAGE_KEY_TYPE}
*
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: Yes
* Visibility: public
*
* @example "myKey"
*/
export const MESSAGING_KAFKA_MESSAGE_KEY = 'messaging.kafka.message.key';

/**
* Type for {@link MESSAGING_KAFKA_MESSAGE_KEY} messaging.kafka.message.key
*/
export type MESSAGING_KAFKA_MESSAGE_KEY_TYPE = string;

// Path: model/attributes/messaging/messaging__kafka__message__tombstone.json

/**
* A boolean that is true if the message is a tombstone. `messaging.kafka.message.tombstone`
*
* Attribute Value Type: `boolean` {@link MESSAGING_KAFKA_MESSAGE_TOMBSTONE_TYPE}
*
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: Yes
* Visibility: public
*
* @example true
*/
export const MESSAGING_KAFKA_MESSAGE_TOMBSTONE = 'messaging.kafka.message.tombstone';

/**
* Type for {@link MESSAGING_KAFKA_MESSAGE_TOMBSTONE} messaging.kafka.message.tombstone
*/
export type MESSAGING_KAFKA_MESSAGE_TOMBSTONE_TYPE = boolean;

// Path: model/attributes/messaging/messaging__kafka__offset.json

/**
* The offset of a record in the corresponding Kafka partition. `messaging.kafka.offset`
*
* Attribute Value Type: `number` {@link MESSAGING_KAFKA_OFFSET_TYPE}
*
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: Yes
* Visibility: public
*
* @example 42
*/
export const MESSAGING_KAFKA_OFFSET = 'messaging.kafka.offset';

/**
* Type for {@link MESSAGING_KAFKA_OFFSET} messaging.kafka.offset
*/
export type MESSAGING_KAFKA_OFFSET_TYPE = number;

// Path: model/attributes/messaging/messaging__message__body__size.json

/**
Expand Down Expand Up @@ -17438,6 +17522,10 @@ export const ATTRIBUTE_TYPE: Record<string, AttributeType> = {
'messaging.destination.connection': 'string',
'messaging.destination_kind': 'string',
'messaging.destination.name': 'string',
'messaging.destination.partition.id': 'string',
'messaging.kafka.message.key': 'string',
'messaging.kafka.message.tombstone': 'boolean',
'messaging.kafka.offset': 'integer',
'messaging.message.body.size': 'integer',
'messaging.message.conversation_id': 'string',
'messaging.message.envelope.size': 'integer',
Expand Down Expand Up @@ -18202,6 +18290,10 @@ export type AttributeName =
| typeof MESSAGING_DESTINATION_CONNECTION
| typeof MESSAGING_DESTINATION_KIND
| typeof MESSAGING_DESTINATION_NAME
| typeof MESSAGING_DESTINATION_PARTITION_ID
| typeof MESSAGING_KAFKA_MESSAGE_KEY
| typeof MESSAGING_KAFKA_MESSAGE_TOMBSTONE
| typeof MESSAGING_KAFKA_OFFSET
| typeof MESSAGING_MESSAGE_BODY_SIZE
| typeof MESSAGING_MESSAGE_CONVERSATION_ID
| typeof MESSAGING_MESSAGE_ENVELOPE_SIZE
Expand Down Expand Up @@ -25351,6 +25443,52 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
{ version: '0.0.0' },
],
},
'messaging.destination.partition.id': {
brief:
'The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name.',
type: 'string',
applyScrubbing: {
key: 'manual',
},
isInOtel: true,
visibility: 'public',
example: '1',
changelog: [{ version: 'next', prs: [474], description: 'Added messaging.destination.partition.id attribute' }],
},
'messaging.kafka.message.key': {
brief:
"Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition. They differ from messaging.message.id in that they're not unique. If the key is null, the attribute MUST NOT be set.",
type: 'string',
applyScrubbing: {
key: 'manual',
},
isInOtel: true,
visibility: 'public',
example: 'myKey',
changelog: [{ version: 'next', prs: [474], description: 'Added messaging.kafka.message.key attribute' }],
},
'messaging.kafka.message.tombstone': {
brief: 'A boolean that is true if the message is a tombstone.',
type: 'boolean',
applyScrubbing: {
key: 'manual',
},
isInOtel: true,
visibility: 'public',
example: true,
changelog: [{ version: 'next', prs: [474], description: 'Added messaging.kafka.message.tombstone attribute' }],
},
'messaging.kafka.offset': {
brief: 'The offset of a record in the corresponding Kafka partition.',
type: 'integer',
applyScrubbing: {
key: 'manual',
},
isInOtel: true,
visibility: 'public',
example: 42,
changelog: [{ version: 'next', prs: [474], description: 'Added messaging.kafka.offset attribute' }],
},
'messaging.message.body.size': {
brief: 'The size of the message body in bytes.',
type: 'integer',
Expand Down Expand Up @@ -29369,6 +29507,10 @@ export type Attributes = {
[MESSAGING_DESTINATION_CONNECTION]?: MESSAGING_DESTINATION_CONNECTION_TYPE;
[MESSAGING_DESTINATION_KIND]?: MESSAGING_DESTINATION_KIND_TYPE;
[MESSAGING_DESTINATION_NAME]?: MESSAGING_DESTINATION_NAME_TYPE;
[MESSAGING_DESTINATION_PARTITION_ID]?: MESSAGING_DESTINATION_PARTITION_ID_TYPE;
[MESSAGING_KAFKA_MESSAGE_KEY]?: MESSAGING_KAFKA_MESSAGE_KEY_TYPE;
[MESSAGING_KAFKA_MESSAGE_TOMBSTONE]?: MESSAGING_KAFKA_MESSAGE_TOMBSTONE_TYPE;
[MESSAGING_KAFKA_OFFSET]?: MESSAGING_KAFKA_OFFSET_TYPE;
[MESSAGING_MESSAGE_BODY_SIZE]?: MESSAGING_MESSAGE_BODY_SIZE_TYPE;
[MESSAGING_MESSAGE_CONVERSATION_ID]?: MESSAGING_MESSAGE_CONVERSATION_ID_TYPE;
[MESSAGING_MESSAGE_ENVELOPE_SIZE]?: MESSAGING_MESSAGE_ENVELOPE_SIZE_TYPE;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "messaging.destination.partition.id",
"brief": "The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name.",
"type": "string",
"apply_scrubbing": {
"key": "manual"
},
"is_in_otel": true,
"visibility": "public",
"example": "1",
"changelog": [
{
"version": "next",
"prs": [474],
"description": "Added messaging.destination.partition.id attribute"
}
]
}
18 changes: 18 additions & 0 deletions model/attributes/messaging/messaging__kafka__message__key.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "messaging.kafka.message.key",
"brief": "Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition. They differ from messaging.message.id in that they're not unique. If the key is null, the attribute MUST NOT be set.",
"type": "string",
"apply_scrubbing": {
"key": "manual"
},
"is_in_otel": true,
"visibility": "public",
"example": "myKey",
"changelog": [
{
"version": "next",
"prs": [474],
"description": "Added messaging.kafka.message.key attribute"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "messaging.kafka.message.tombstone",
"brief": "A boolean that is true if the message is a tombstone.",
"type": "boolean",
"apply_scrubbing": {
"key": "manual"
},
"is_in_otel": true,
"visibility": "public",
"example": true,
"changelog": [
{
"version": "next",
"prs": [474],
"description": "Added messaging.kafka.message.tombstone attribute"
}
]
}
18 changes: 18 additions & 0 deletions model/attributes/messaging/messaging__kafka__offset.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "messaging.kafka.offset",
"brief": "The offset of a record in the corresponding Kafka partition.",
"type": "integer",
"apply_scrubbing": {
"key": "manual"
},
"is_in_otel": true,
"visibility": "public",
"example": 42,
"changelog": [
{
"version": "next",
"prs": [474],
"description": "Added messaging.kafka.offset attribute"
}
]
}
Loading
Loading