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: 80 additions & 10 deletions javascript/sentry-conventions/src/attributes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13426,7 +13426,7 @@ export type OTEL_STATUS_DESCRIPTION_TYPE = string;
*
* Has Dynamic Suffix: true
*
* Aliases: {@link URL_PATH_PARAMETER_KEY} `url.path.parameter.<key>`
* Aliases: {@link URL_PATH_PARAMETER_KEY} `url.path.parameter.<key>`, {@link URL_PATH_PARAMS_KEY} `url.path.params.<key>`
*
* @example "params.id='123'"
*/
Expand Down Expand Up @@ -17130,7 +17130,7 @@ export type URL_PATH_TYPE = string;
*
* Has Dynamic Suffix: true
*
* Aliases: {@link PARAMS_KEY} `params.<key>`
* Aliases: {@link PARAMS_KEY} `params.<key>`, {@link URL_PATH_PARAMS_KEY} `url.path.params.<key>`
*
* @example "url.path.parameter.id='123'"
*/
Expand All @@ -17146,6 +17146,39 @@ export const URL_PATH_PARAMETER_KEY_BASE = 'url.path.parameter';
*/
export type URL_PATH_PARAMETER_KEY_TYPE = string;

// Path: model/attributes/url/url__path__params__[key].json

/**
* Decoded parameters extracted from a URL path. Usually added by client-side routing frameworks like vue-router. `url.path.params.<key>`
*
* Attribute Value Type: `string` {@link URL_PATH_PARAMS_KEY_TYPE}
*
* Apply Scrubbing: auto
*
* Attribute defined in OTEL: No
* Visibility: public
*
* Has Dynamic Suffix: true
*
* Aliases: {@link URL_PATH_PARAMETER_KEY} `url.path.parameter.<key>`, {@link PARAMS_KEY} `params.<key>`
*
* @deprecated Use {@link URL_PATH_PARAMETER_KEY} (url.path.parameter.<key>) instead - This attribute is being deprecated in favor of url.path.parameter.<key>.
* @example "url.path.params.id='123'"
*/
export const URL_PATH_PARAMS_KEY = 'url.path.params.<key>';

/**
* Base key for {@link URL_PATH_PARAMS_KEY}. Use with a dynamic suffix, e.g. `${URL_PATH_PARAMS_KEY_BASE}.${key}`.
*
* @deprecated Use {@link URL_PATH_PARAMETER_KEY_BASE} (url.path.parameter) instead - This attribute is being deprecated in favor of url.path.parameter.<key>.
*/
export const URL_PATH_PARAMS_KEY_BASE = 'url.path.params';

/**
* Type for {@link URL_PATH_PARAMS_KEY} url.path.params.<key>
*/
export type URL_PATH_PARAMS_KEY_TYPE = string;

// Path: model/attributes/url/url__port.json

/**
Expand Down Expand Up @@ -19163,6 +19196,7 @@ export const ATTRIBUTE_TYPE: Record<string, AttributeType> = {
'url.full': 'string',
'url.path': 'string',
'url.path.parameter.<key>': 'string',
'url.path.params.<key>': 'string',
'url.port': 'integer',
'url.query': 'string',
'url.same_origin': 'boolean',
Expand Down Expand Up @@ -19987,6 +20021,7 @@ export type AttributeName =
| typeof URL_FULL
| typeof URL_PATH
| typeof URL_PATH_PARAMETER_KEY
| typeof URL_PATH_PARAMS_KEY
| typeof URL_PORT
| typeof URL_QUERY
| typeof URL_SAME_ORIGIN
Expand Down Expand Up @@ -29519,16 +29554,19 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
brief:
'Decoded parameters extracted from a URL path. Usually added by client-side routing frameworks like vue-router.',
type: 'string',
keys: ['params.<key>', 'url.path.parameter.<key>'],
keys: ['params.<key>', 'url.path.parameter.<key>', 'url.path.params.<key>'],
applyScrubbing: {
key: 'auto',
},
isInOtel: false,
visibility: 'public',
hasDynamicSuffix: true,
example: "params.id='123'",
aliases: ['url.path.parameter.<key>'],
changelog: [{ version: '0.1.0', prs: [103] }],
aliases: ['url.path.parameter.<key>', 'url.path.params.<key>'],
changelog: [
{ version: 'next', description: 'Added url.path.params.<key> as an alias' },
{ version: '0.1.0', prs: [103] },
],
},
'performance.activationStart': {
brief: 'The time between initiating a navigation to a page and the browser activating the page',
Expand Down Expand Up @@ -32125,16 +32163,40 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
brief:
'Decoded parameters extracted from a URL path. Usually added by client-side routing frameworks like vue-router.',
type: 'string',
keys: ['url.path.parameter.<key>', 'params.<key>'],
keys: ['url.path.parameter.<key>', 'params.<key>', 'url.path.params.<key>'],
applyScrubbing: {
key: 'auto',
},
isInOtel: false,
visibility: 'public',
hasDynamicSuffix: true,
example: "url.path.parameter.id='123'",
aliases: ['params.<key>'],
changelog: [{ version: '0.1.0', prs: [103] }],
aliases: ['params.<key>', 'url.path.params.<key>'],
changelog: [
{ version: 'next', description: 'Added url.path.params.<key> as an alias' },
{ version: '0.1.0', prs: [103] },
],
},
'url.path.params.<key>': {
brief:
'Decoded parameters extracted from a URL path. Usually added by client-side routing frameworks like vue-router.',
type: 'string',
keys: ['url.path.parameter.<key>', 'params.<key>', 'url.path.params.<key>'],
applyScrubbing: {
key: 'auto',
},
isInOtel: false,
visibility: 'public',
hasDynamicSuffix: true,
example: "url.path.params.id='123'",
examples: ["url.path.params.id='123'"],
deprecation: {
replacement: 'url.path.parameter.<key>',
reason: 'This attribute is being deprecated in favor of url.path.parameter.<key>.',
status: 'backfill',
},
aliases: ['url.path.parameter.<key>', 'params.<key>'],
changelog: [{ version: 'next', prs: [586], description: 'Added url.path.params.<key> attribute' }],
},
'url.port': {
brief: 'Server port number.',
Expand Down Expand Up @@ -36709,7 +36771,7 @@ export const ATTRIBUTE_SEARCH_METADATA: Record<string, AttributeSearchMetadata>
type: 'string',
brief:
'Decoded parameters extracted from a URL path. Usually added by client-side routing frameworks like vue-router.',
deprecationChain: ['params.<key>', 'url.path.parameter.<key>'],
deprecationChain: ['params.<key>', 'url.path.parameter.<key>', 'url.path.params.<key>'],
},
'performance.activationStart': {
canonicalName: 'browser.performance.navigation.activation_start',
Expand Down Expand Up @@ -37693,7 +37755,14 @@ export const ATTRIBUTE_SEARCH_METADATA: Record<string, AttributeSearchMetadata>
type: 'string',
brief:
'Decoded parameters extracted from a URL path. Usually added by client-side routing frameworks like vue-router.',
deprecationChain: ['url.path.parameter.<key>', 'params.<key>'],
deprecationChain: ['url.path.parameter.<key>', 'params.<key>', 'url.path.params.<key>'],
},
'url.path.params.<key>': {
canonicalName: 'url.path.parameter.<key>',
type: 'string',
brief:
'Decoded parameters extracted from a URL path. Usually added by client-side routing frameworks like vue-router.',
deprecationChain: ['url.path.parameter.<key>', 'params.<key>', 'url.path.params.<key>'],
},
'url.port': {
canonicalName: 'url.port',
Expand Down Expand Up @@ -38799,6 +38868,7 @@ export type Attributes = {
[URL_FULL]?: URL_FULL_TYPE;
[URL_PATH]?: URL_PATH_TYPE;
[URL_PATH_PARAMETER_KEY]?: URL_PATH_PARAMETER_KEY_TYPE;
[URL_PATH_PARAMS_KEY]?: URL_PATH_PARAMS_KEY_TYPE;
[URL_PORT]?: URL_PORT_TYPE;
[URL_QUERY]?: URL_QUERY_TYPE;
[URL_SAME_ORIGIN]?: URL_SAME_ORIGIN_TYPE;
Expand Down
6 changes: 5 additions & 1 deletion model/attributes/params/params__[key].json
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,13 @@
},
"is_in_otel": false,
"example": "params.id='123'",
"alias": ["url.path.parameter.<key>"],
"alias": ["url.path.parameter.<key>", "url.path.params.<key>"],
"visibility": "public",
"changelog": [
{
"version": "next",
"description": "Added url.path.params.<key> as an alias"
},
{
"version": "0.1.0",
"prs": [103]
Expand Down
6 changes: 5 additions & 1 deletion model/attributes/url/url__path__parameter__[key].json
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,13 @@
},
"is_in_otel": false,
"example": "url.path.parameter.id='123'",
"alias": ["params.<key>"],
"alias": ["params.<key>", "url.path.params.<key>"],
"visibility": "public",
"changelog": [
{
"version": "next",
"description": "Added url.path.params.<key> as an alias"
},
{
"version": "0.1.0",
"prs": [103]
Expand Down
25 changes: 25 additions & 0 deletions model/attributes/url/url__path__params__[key].json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"key": "url.path.params.<key>",
"brief": "Decoded parameters extracted from a URL path. Usually added by client-side routing frameworks like vue-router.",
"has_dynamic_suffix": true,
"type": "string",
"apply_scrubbing": {
"key": "auto"
},
"is_in_otel": false,
"examples": ["url.path.params.id='123'"],
"alias": ["url.path.parameter.<key>", "params.<key>"],
"deprecation": {
"_status": "backfill",
"replacement": "url.path.parameter.<key>",
"reason": "This attribute is being deprecated in favor of url.path.parameter.<key>."
},
"visibility": "public",
"changelog": [
{
"version": "next",
"prs": [586],
"description": "Added url.path.params.<key> attribute"
}
]
}
60 changes: 56 additions & 4 deletions python/src/sentry_conventions/attributes.py
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,7 @@ class _AttributeNamesMeta(type):
"TRANSACTION",
"TTFB_REQUESTTIME",
"TTFB",
"URL_PATH_PARAMS_KEY",
"URL_SAME_ORIGIN",
"URL",
}
Expand Down Expand Up @@ -7961,7 +7962,7 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
Defined in OTEL: No
Visibility: public
Has Dynamic Suffix: true
Aliases: url.path.parameter.<key>
Aliases: url.path.parameter.<key>, url.path.params.<key>
Example: "params.id='123'"
"""

Expand Down Expand Up @@ -9979,10 +9980,24 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
Defined in OTEL: No
Visibility: public
Has Dynamic Suffix: true
Aliases: params.<key>
Aliases: params.<key>, url.path.params.<key>
Example: "url.path.parameter.id='123'"
"""

# Path: model/attributes/url/url__path__params__[key].json
URL_PATH_PARAMS_KEY: Literal["url.path.params.<key>"] = "url.path.params.<key>"
"""Decoded parameters extracted from a URL path. Usually added by client-side routing frameworks like vue-router.

Type: str
Apply Scrubbing: auto
Defined in OTEL: No
Visibility: public
Has Dynamic Suffix: true
Aliases: url.path.parameter.<key>, params.<key>
DEPRECATED: Use url.path.parameter.<key> instead - This attribute is being deprecated in favor of url.path.parameter.<key>.
Example: "url.path.params.id='123'"
"""

# Path: model/attributes/url/url__port.json
URL_PORT: Literal["url.port"] = "url.port"
"""Server port number.
Expand Down Expand Up @@ -21792,14 +21807,18 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
keys=(
"params.<key>",
"url.path.parameter.<key>",
"url.path.params.<key>",
),
apply_scrubbing=ApplyScrubbingInfo(key=ApplyScrubbing.AUTO),
is_in_otel=False,
visibility=Visibility.PUBLIC,
has_dynamic_suffix=True,
example="params.id='123'",
aliases=["url.path.parameter.<key>"],
aliases=["url.path.parameter.<key>", "url.path.params.<key>"],
changelog=[
ChangelogEntry(
version="next", description="Added url.path.params.<key> as an alias"
),
ChangelogEntry(version="0.1.0", prs=[103]),
],
),
Expand Down Expand Up @@ -24720,17 +24739,49 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
keys=(
"url.path.parameter.<key>",
"params.<key>",
"url.path.params.<key>",
),
apply_scrubbing=ApplyScrubbingInfo(key=ApplyScrubbing.AUTO),
is_in_otel=False,
visibility=Visibility.PUBLIC,
has_dynamic_suffix=True,
example="url.path.parameter.id='123'",
aliases=["params.<key>"],
aliases=["params.<key>", "url.path.params.<key>"],
changelog=[
ChangelogEntry(
version="next", description="Added url.path.params.<key> as an alias"
),
ChangelogEntry(version="0.1.0", prs=[103]),
],
),
"url.path.params.<key>": AttributeMetadata(
brief="Decoded parameters extracted from a URL path. Usually added by client-side routing frameworks like vue-router.",
type=AttributeType.STRING,
keys=(
"url.path.parameter.<key>",
"params.<key>",
"url.path.params.<key>",
),
apply_scrubbing=ApplyScrubbingInfo(key=ApplyScrubbing.AUTO),
is_in_otel=False,
visibility=Visibility.PUBLIC,
has_dynamic_suffix=True,
example="url.path.params.id='123'",
examples=["url.path.params.id='123'"],
deprecation=DeprecationInfo(
replacement="url.path.parameter.<key>",
reason="This attribute is being deprecated in favor of url.path.parameter.<key>.",
status=DeprecationStatus.BACKFILL,
),
aliases=["url.path.parameter.<key>", "params.<key>"],
changelog=[
ChangelogEntry(
version="next",
prs=[586],
description="Added url.path.params.<key> attribute",
),
],
),
"url.port": AttributeMetadata(
brief="Server port number.",
type=AttributeType.INTEGER,
Expand Down Expand Up @@ -26248,6 +26299,7 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
"url.full": str,
"url.path": str,
"url.path.parameter.<key>": str,
"url.path.params.<key>": str,
"url.port": int,
"url.query": str,
"url.same_origin": bool,
Expand Down
Loading