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
90 changes: 76 additions & 14 deletions javascript/sentry-conventions/src/attributes.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
// This is an auto-generated file. Do not edit!

// Path: model/attributes/address.json

/**
* The destination hostname or IP address for a TCP connection. `address`
*
* Attribute Value Type: `string` {@link ADDRESS_TYPE}
*
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
*
* Aliases: {@link SERVER_ADDRESS} `server.address`, {@link HTTP_SERVER_NAME} `http.server_name`, {@link NET_HOST_NAME} `net.host.name`, {@link HTTP_HOST} `http.host`, {@link SERVER_NAME} `server_name`
*
* @deprecated Use {@link SERVER_ADDRESS} (server.address) instead - Old namespace-less attribute, to be replaced with server.address for span-first future
* @example "example.com"
*/
export const ADDRESS = 'address';

/**
* Type for {@link ADDRESS} address
*/
export type ADDRESS_TYPE = string;

// Path: model/attributes/ai/ai__citations.json

/**
Expand Down Expand Up @@ -8794,7 +8818,7 @@ export type HTTP_FRAGMENT_TYPE = string;
* Attribute defined in OTEL: Yes
* Visibility: public
*
* Aliases: {@link SERVER_ADDRESS} `server.address`, {@link CLIENT_ADDRESS} `client.address`, {@link HTTP_SERVER_NAME} `http.server_name`, {@link NET_HOST_NAME} `net.host.name`, {@link SERVER_NAME} `server_name`
* Aliases: {@link ADDRESS} `address`, {@link SERVER_ADDRESS} `server.address`, {@link CLIENT_ADDRESS} `client.address`, {@link HTTP_SERVER_NAME} `http.server_name`, {@link NET_HOST_NAME} `net.host.name`, {@link SERVER_NAME} `server_name`
*
* @deprecated Use {@link SERVER_ADDRESS} (server.address) instead - Deprecated, use one of `server.address` or `client.address`, depending on the usage
* @example "example.com"
Expand Down Expand Up @@ -9493,7 +9517,7 @@ export type HTTP_SCHEME_TYPE = string;
* Attribute defined in OTEL: Yes
* Visibility: public
*
* Aliases: {@link SERVER_ADDRESS} `server.address`, {@link NET_HOST_NAME} `net.host.name`, {@link HTTP_HOST} `http.host`, {@link SERVER_NAME} `server_name`
* Aliases: {@link ADDRESS} `address`, {@link SERVER_ADDRESS} `server.address`, {@link NET_HOST_NAME} `net.host.name`, {@link HTTP_HOST} `http.host`, {@link SERVER_NAME} `server_name`
*
* @deprecated Use {@link SERVER_ADDRESS} (server.address) instead
* @example "example.com"
Expand Down Expand Up @@ -11852,7 +11876,7 @@ export type NET_HOST_IP_TYPE = string;
* Attribute defined in OTEL: Yes
* Visibility: public
*
* Aliases: {@link SERVER_ADDRESS} `server.address`, {@link HTTP_SERVER_NAME} `http.server_name`, {@link HTTP_HOST} `http.host`, {@link SERVER_NAME} `server_name`
* Aliases: {@link ADDRESS} `address`, {@link SERVER_ADDRESS} `server.address`, {@link HTTP_SERVER_NAME} `http.server_name`, {@link HTTP_HOST} `http.host`, {@link SERVER_NAME} `server_name`
*
* @deprecated Use {@link SERVER_ADDRESS} (server.address) instead
* @example "example.com"
Expand Down Expand Up @@ -15173,7 +15197,7 @@ export type SENTRY_USER_USERNAME_TYPE = string;
* Attribute defined in OTEL: Yes
* Visibility: public
*
* Aliases: {@link HTTP_SERVER_NAME} `http.server_name`, {@link NET_HOST_NAME} `net.host.name`, {@link HTTP_HOST} `http.host`, {@link SERVER_NAME} `server_name`
* Aliases: {@link ADDRESS} `address`, {@link HTTP_SERVER_NAME} `http.server_name`, {@link NET_HOST_NAME} `net.host.name`, {@link HTTP_HOST} `http.host`, {@link SERVER_NAME} `server_name`
*
* @example "example.com"
*/
Expand All @@ -15196,7 +15220,7 @@ export type SERVER_ADDRESS_TYPE = string;
* Attribute defined in OTEL: No
* Visibility: public
*
* Aliases: {@link SERVER_ADDRESS} `server.address`, {@link HTTP_SERVER_NAME} `http.server_name`, {@link NET_HOST_NAME} `net.host.name`, {@link HTTP_HOST} `http.host`
* Aliases: {@link ADDRESS} `address`, {@link SERVER_ADDRESS} `server.address`, {@link HTTP_SERVER_NAME} `http.server_name`, {@link NET_HOST_NAME} `net.host.name`, {@link HTTP_HOST} `http.host`
*
* @deprecated Use {@link SERVER_ADDRESS} (server.address) instead - This attribute is being deprecated in favor of server.address, which is the OTel-aligned replacement.
* @example "example.com"
Expand Down Expand Up @@ -17283,6 +17307,7 @@ export interface AttributeMetadata {
}

export const ATTRIBUTE_TYPE: Record<string, AttributeType> = {
address: 'string',
'ai.citations': 'string[]',
'ai.completion_tokens.used': 'integer',
'ai.documents': 'string[]',
Expand Down Expand Up @@ -18061,6 +18086,7 @@ export const ATTRIBUTE_TYPE: Record<string, AttributeType> = {
};

export type AttributeName =
| typeof ADDRESS
| typeof AI_CITATIONS
| typeof AI_COMPLETION_TOKENS_USED
| typeof AI_DOCUMENTS
Expand Down Expand Up @@ -18838,6 +18864,24 @@ export type AttributeName =
| typeof VERCEL_STATUS_CODE;

export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
address: {
brief: 'The destination hostname or IP address for a TCP connection.',
type: 'string',
applyScrubbing: {
key: 'manual',
},
isInOtel: false,
visibility: 'public',
example: 'example.com',
examples: ['example.com'],
deprecation: {
replacement: 'server.address',
reason: 'Old namespace-less attribute, to be replaced with server.address for span-first future',
status: 'backfill',
},
aliases: ['server.address', 'http.server_name', 'net.host.name', 'http.host', 'server_name'],
changelog: [{ version: 'next', prs: [534], description: 'Added address attribute' }],
},
'ai.citations': {
brief: 'References or sources cited by the AI model in its response.',
type: 'string[]',
Expand Down Expand Up @@ -24425,8 +24469,12 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
replacement: 'server.address',
reason: 'Deprecated, use one of `server.address` or `client.address`, depending on the usage',
},
aliases: ['server.address', 'client.address', 'http.server_name', 'net.host.name', 'server_name'],
changelog: [{ version: '0.1.0', prs: [61, 108, 127] }, { version: '0.0.0' }],
aliases: ['address', 'server.address', 'client.address', 'http.server_name', 'net.host.name', 'server_name'],
changelog: [
{ version: 'next', description: 'Added address as an alias' },
{ version: '0.1.0', prs: [61, 108, 127] },
{ version: '0.0.0' },
],
},
'http.method': {
brief: 'The HTTP method used.',
Expand Down Expand Up @@ -24847,8 +24895,12 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
deprecation: {
replacement: 'server.address',
},
aliases: ['server.address', 'net.host.name', 'http.host', 'server_name'],
changelog: [{ version: '0.1.0', prs: [61, 108, 127] }, { version: '0.0.0' }],
aliases: ['address', 'server.address', 'net.host.name', 'http.host', 'server_name'],
changelog: [
{ version: 'next', description: 'Added address as an alias' },
{ version: '0.1.0', prs: [61, 108, 127] },
{ version: '0.0.0' },
],
},
'http.server.request.time_in_queue': {
brief:
Expand Down Expand Up @@ -26334,8 +26386,12 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
deprecation: {
replacement: 'server.address',
},
aliases: ['server.address', 'http.server_name', 'http.host', 'server_name'],
changelog: [{ version: '0.1.0', prs: [61, 108, 127] }, { version: '0.0.0' }],
aliases: ['address', 'server.address', 'http.server_name', 'http.host', 'server_name'],
changelog: [
{ version: 'next', description: 'Added address as an alias' },
{ version: '0.1.0', prs: [61, 108, 127] },
{ version: '0.0.0' },
],
},
'net.host.port': {
brief: 'Server port number.',
Expand Down Expand Up @@ -28334,8 +28390,12 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
isInOtel: true,
visibility: 'public',
example: 'example.com',
aliases: ['http.server_name', 'net.host.name', 'http.host', 'server_name'],
changelog: [{ version: '0.1.0', prs: [108, 127] }, { version: '0.0.0' }],
aliases: ['address', 'http.server_name', 'net.host.name', 'http.host', 'server_name'],
changelog: [
{ version: 'next', description: 'Added address as an alias' },
{ version: '0.1.0', prs: [108, 127] },
{ version: '0.0.0' },
],
},
server_name: {
brief:
Expand All @@ -28352,8 +28412,9 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
reason: 'This attribute is being deprecated in favor of server.address, which is the OTel-aligned replacement.',
status: 'backfill',
},
aliases: ['server.address', 'http.server_name', 'net.host.name', 'http.host'],
aliases: ['address', 'server.address', 'http.server_name', 'net.host.name', 'http.host'],
changelog: [
{ version: 'next', description: 'Added address as an alias' },
{
version: '0.16.0',
prs: [477],
Expand Down Expand Up @@ -29535,6 +29596,7 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
export type AttributeValue = string | number | boolean | Array<string> | Array<number> | Array<boolean>;

export type Attributes = {
[ADDRESS]?: ADDRESS_TYPE;
[AI_CITATIONS]?: AI_CITATIONS_TYPE;
[AI_COMPLETION_TOKENS_USED]?: AI_COMPLETION_TOKENS_USED_TYPE;
[AI_DOCUMENTS]?: AI_DOCUMENTS_TYPE;
Expand Down
24 changes: 24 additions & 0 deletions model/attributes/address.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"key": "address",
"brief": "The destination hostname or IP address for a TCP connection.",
"type": "string",
"apply_scrubbing": {
"key": "manual"
},
"is_in_otel": false,
"visibility": "public",
"examples": ["example.com"],
"alias": ["server.address", "http.server_name", "net.host.name", "http.host", "server_name"],
"deprecation": {
"replacement": "server.address",
"reason": "Old namespace-less attribute, to be replaced with server.address for span-first future",
"_status": "backfill"
},
"changelog": [
{
"version": "next",
"prs": [534],
"description": "Added address attribute"
}
]
}
6 changes: 5 additions & 1 deletion model/attributes/http/http__host.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,18 @@
},
"is_in_otel": true,
"example": "example.com",
"alias": ["server.address", "client.address", "http.server_name", "net.host.name", "server_name"],
"alias": ["address", "server.address", "client.address", "http.server_name", "net.host.name", "server_name"],
"deprecation": {
"_status": null,
"replacement": "server.address",
"reason": "Deprecated, use one of `server.address` or `client.address`, depending on the usage"
},
"visibility": "public",
"changelog": [
{
"version": "next",
"description": "Added address as an alias"
},
{
"version": "0.1.0",
"prs": [61, 108, 127]
Expand Down
6 changes: 5 additions & 1 deletion model/attributes/http/http__server_name.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,17 @@
},
"is_in_otel": true,
"example": "example.com",
"alias": ["server.address", "net.host.name", "http.host", "server_name"],
"alias": ["address", "server.address", "net.host.name", "http.host", "server_name"],
"deprecation": {
"_status": null,
"replacement": "server.address"
},
"visibility": "public",
"changelog": [
{
"version": "next",
"description": "Added address as an alias"
},
{
"version": "0.1.0",
"prs": [61, 108, 127]
Expand Down
6 changes: 5 additions & 1 deletion model/attributes/net/net__host__name.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,17 @@
},
"is_in_otel": true,
"example": "example.com",
"alias": ["server.address", "http.server_name", "http.host", "server_name"],
"alias": ["address", "server.address", "http.server_name", "http.host", "server_name"],
"deprecation": {
"_status": null,
"replacement": "server.address"
},
"visibility": "public",
"changelog": [
{
"version": "next",
"description": "Added address as an alias"
},
{
"version": "0.1.0",
"prs": [61, 108, 127]
Expand Down
6 changes: 5 additions & 1 deletion model/attributes/server/server__address.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,13 @@
},
"is_in_otel": true,
"example": "example.com",
"alias": ["http.server_name", "net.host.name", "http.host", "server_name"],
"alias": ["address", "http.server_name", "net.host.name", "http.host", "server_name"],
"visibility": "public",
"changelog": [
{
"version": "next",
"description": "Added address as an alias"
},
{
"version": "0.1.0",
"prs": [108, 127]
Expand Down
6 changes: 5 additions & 1 deletion model/attributes/server_name.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,18 @@
},
"is_in_otel": false,
"example": "example.com",
"alias": ["server.address", "http.server_name", "net.host.name", "http.host"],
"alias": ["address", "server.address", "http.server_name", "net.host.name", "http.host"],
"deprecation": {
"_status": "backfill",
"replacement": "server.address",
"reason": "This attribute is being deprecated in favor of server.address, which is the OTel-aligned replacement."
},
"visibility": "public",
"changelog": [
{
"version": "next",
"description": "Added address as an alias"
},
{
"version": "0.16.0",
"prs": [477],
Expand Down
Loading
Loading