Skip to content
Open
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
159 changes: 159 additions & 0 deletions javascript/sentry-conventions/src/attributes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2862,6 +2862,27 @@ export const AWS_LAMBDA_REMAINING_TIME_IN_MILLIS = 'aws.lambda.remaining_time_in
*/
export type AWS_LAMBDA_REMAINING_TIME_IN_MILLIS_TYPE = number;

// Path: model/attributes/aws/aws__lambda__target_function__name.json

/**
* The name of the AWS Lambda function that an AWS SDK call acts on. `aws.lambda.target_function.name`
*
* Attribute Value Type: `string` {@link AWS_LAMBDA_TARGET_FUNCTION_NAME_TYPE}
*
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
*
* @example "billing"
*/
export const AWS_LAMBDA_TARGET_FUNCTION_NAME = 'aws.lambda.target_function.name';

/**
* Type for {@link AWS_LAMBDA_TARGET_FUNCTION_NAME} aws.lambda.target_function.name
*/
export type AWS_LAMBDA_TARGET_FUNCTION_NAME_TYPE = string;

// Path: model/attributes/aws/aws__log__group__names.json

/**
Expand Down Expand Up @@ -3194,6 +3215,28 @@ export const AWS_SECRETSMANAGER_SECRET_ARN = 'aws.secretsmanager.secret.arn';
*/
export type AWS_SECRETSMANAGER_SECRET_ARN_TYPE = string;

// Path: model/attributes/aws/aws__secretsmanager__secret__name.json

/**
* The name of the secret stored in AWS Secrets Manager. `aws.secretsmanager.secret.name`
*
* Attribute Value Type: `string` {@link AWS_SECRETSMANAGER_SECRET_NAME_TYPE}
*
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
*
* @example "db-password"
* @example "prod/billing/api-key"
*/
export const AWS_SECRETSMANAGER_SECRET_NAME = 'aws.secretsmanager.secret.name';

/**
* Type for {@link AWS_SECRETSMANAGER_SECRET_NAME} aws.secretsmanager.secret.name
*/
export type AWS_SECRETSMANAGER_SECRET_NAME_TYPE = string;

// Path: model/attributes/aws/aws__sns__topic__arn.json

/**
Expand Down Expand Up @@ -3257,6 +3300,27 @@ export const AWS_STEP_FUNCTIONS_ACTIVITY_ARN = 'aws.step_functions.activity.arn'
*/
export type AWS_STEP_FUNCTIONS_ACTIVITY_ARN_TYPE = string;

// Path: model/attributes/aws/aws__step_functions__activity__name.json

/**
* The name of the AWS Step Functions activity. `aws.step_functions.activity.name`
*
* Attribute Value Type: `string` {@link AWS_STEP_FUNCTIONS_ACTIVITY_NAME_TYPE}
*
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
*
* @example "resize-image"
*/
export const AWS_STEP_FUNCTIONS_ACTIVITY_NAME = 'aws.step_functions.activity.name';

/**
* Type for {@link AWS_STEP_FUNCTIONS_ACTIVITY_NAME} aws.step_functions.activity.name
*/
export type AWS_STEP_FUNCTIONS_ACTIVITY_NAME_TYPE = string;

// Path: model/attributes/aws/aws__step_functions__execution__arn.json

/**
Expand Down Expand Up @@ -3299,6 +3363,27 @@ export const AWS_STEP_FUNCTIONS_STATE_MACHINE_ARN = 'aws.step_functions.state_ma
*/
export type AWS_STEP_FUNCTIONS_STATE_MACHINE_ARN_TYPE = string;

// Path: model/attributes/aws/aws__step_functions__state_machine__name.json

/**
* The name of the AWS Step Functions state machine. `aws.step_functions.state_machine.name`
*
* Attribute Value Type: `string` {@link AWS_STEP_FUNCTIONS_STATE_MACHINE_NAME_TYPE}
*
* Apply Scrubbing: manual
*
* Attribute defined in OTEL: No
* Visibility: public
*
* @example "orders"
*/
export const AWS_STEP_FUNCTIONS_STATE_MACHINE_NAME = 'aws.step_functions.state_machine.name';

/**
* Type for {@link AWS_STEP_FUNCTIONS_STATE_MACHINE_NAME} aws.step_functions.state_machine.name
*/
export type AWS_STEP_FUNCTIONS_STATE_MACHINE_NAME_TYPE = string;

// Path: model/attributes/blocked_main_thread.json

/**
Expand Down Expand Up @@ -20569,6 +20654,7 @@ export const ATTRIBUTE_TYPE: Record<string, AttributeType> = {
'aws.lambda.invoked_arn': 'string',
'aws.lambda.invoked_function_arn': 'string',
'aws.lambda.remaining_time_in_millis': 'double',
'aws.lambda.target_function.name': 'string',
'aws.log.group.names': 'string[]',
'aws.log.stream.names': 'string[]',
'aws.operation_name': 'string',
Expand All @@ -20584,11 +20670,14 @@ export const ATTRIBUTE_TYPE: Record<string, AttributeType> = {
'aws.s3.part_number': 'integer',
'aws.s3.upload_id': 'string',
'aws.secretsmanager.secret.arn': 'string',
'aws.secretsmanager.secret.name': 'string',
'aws.sns.topic.arn': 'string',
'aws.sqs.queue.url': 'string',
'aws.step_functions.activity.arn': 'string',
'aws.step_functions.activity.name': 'string',
'aws.step_functions.execution.arn': 'string',
'aws.step_functions.state_machine.arn': 'string',
'aws.step_functions.state_machine.name': 'string',
blocked_main_thread: 'boolean',
'browser.bfcache.frame': 'string',
'browser.bfcache.not_restored_reason_count': 'integer',
Expand Down Expand Up @@ -21478,6 +21567,7 @@ export type AttributeName =
| typeof AWS_LAMBDA_INVOKED_ARN
| typeof AWS_LAMBDA_INVOKED_FUNCTION_ARN
| typeof AWS_LAMBDA_REMAINING_TIME_IN_MILLIS
| typeof AWS_LAMBDA_TARGET_FUNCTION_NAME
| typeof AWS_LOG_GROUP_NAMES
| typeof AWS_LOG_STREAM_NAMES
| typeof AWS_OPERATION_NAME
Expand All @@ -21493,11 +21583,14 @@ export type AttributeName =
| typeof AWS_S3_PART_NUMBER
| typeof AWS_S3_UPLOAD_ID
| typeof AWS_SECRETSMANAGER_SECRET_ARN
| typeof AWS_SECRETSMANAGER_SECRET_NAME
| typeof AWS_SNS_TOPIC_ARN
| typeof AWS_SQS_QUEUE_URL
| typeof AWS_STEP_FUNCTIONS_ACTIVITY_ARN
| typeof AWS_STEP_FUNCTIONS_ACTIVITY_NAME
| typeof AWS_STEP_FUNCTIONS_EXECUTION_ARN
| typeof AWS_STEP_FUNCTIONS_STATE_MACHINE_ARN
| typeof AWS_STEP_FUNCTIONS_STATE_MACHINE_NAME
| typeof BLOCKED_MAIN_THREAD
| typeof BROWSER_BFCACHE_FRAME
| typeof BROWSER_BFCACHE_NOT_RESTORED_REASON_COUNT
Expand Down Expand Up @@ -24354,6 +24447,22 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
example: 5000,
changelog: [{ version: '0.7.0', prs: [369], description: 'Added aws.lambda.remaining_time_in_millis attribute' }],
},
'aws.lambda.target_function.name': {
brief: 'The name of the AWS Lambda function that an AWS SDK call acts on.',
type: 'string',
keys: ['aws.lambda.target_function.name'],
applyScrubbing: {
key: 'manual',
},
isInOtel: false,
visibility: 'public',
example: 'billing',
examples: ['billing'],
changelog: [{ version: 'next', description: 'Added aws.lambda.target_function.name attribute' }],
additionalContext: [
'Set on Lambda API calls that take a `FunctionName`, such as `GetFunction` or `UpdateFunctionCode`, without a version or alias qualifier (`billing`, not `billing:prod`). Different from `faas.name` which is the function the code runs in.',
],
},
'aws.log.group.names': {
brief: 'The name(s) of the AWS log group(s) an application is writing to.',
type: 'string[]',
Expand Down Expand Up @@ -24597,6 +24706,22 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
example: 'arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters',
changelog: [{ version: '0.16.0', prs: [480], description: 'Added aws.secretsmanager.secret.arn attribute' }],
},
'aws.secretsmanager.secret.name': {
brief: 'The name of the secret stored in AWS Secrets Manager.',
type: 'string',
keys: ['aws.secretsmanager.secret.name'],
applyScrubbing: {
key: 'manual',
},
isInOtel: false,
visibility: 'public',
example: 'db-password',
examples: ['db-password', 'prod/billing/api-key'],
changelog: [{ version: 'next', description: 'Added aws.secretsmanager.secret.name attribute' }],
additionalContext: [
"Without the hyphen and six random characters that Secrets Manager appends to the name in the secret's ARN (`db-password`, not `db-password-AbCdEf`).",
],
},
'aws.sns.topic.arn': {
brief:
'The ARN of the AWS SNS Topic. An Amazon SNS topic is a logical access point that acts as a communication channel.',
Expand Down Expand Up @@ -24636,6 +24761,22 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
example: 'arn:aws:states:us-east-1:123456789012:activity:get-greeting',
changelog: [{ version: '0.16.0', prs: [480], description: 'Added aws.step_functions.activity.arn attribute' }],
},
'aws.step_functions.activity.name': {
brief: 'The name of the AWS Step Functions activity.',
type: 'string',
keys: ['aws.step_functions.activity.name'],
applyScrubbing: {
key: 'manual',
},
isInOtel: false,
visibility: 'public',
example: 'resize-image',
examples: ['resize-image'],
changelog: [{ version: 'next', description: 'Added aws.step_functions.activity.name attribute' }],
additionalContext: [
'The last part of the activity ARN (`arn:aws:states:us-east-1:123456789012:activity:resize-image`).',
],
},
'aws.step_functions.execution.arn': {
brief: 'The ARN of the AWS Step Functions Execution.',
type: 'string',
Expand All @@ -24661,6 +24802,20 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
example: 'arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1',
changelog: [{ version: '0.16.0', prs: [480], description: 'Added aws.step_functions.state_machine.arn attribute' }],
},
'aws.step_functions.state_machine.name': {
brief: 'The name of the AWS Step Functions state machine.',
type: 'string',
keys: ['aws.step_functions.state_machine.name'],
applyScrubbing: {
key: 'manual',
},
isInOtel: false,
visibility: 'public',
example: 'orders',
examples: ['orders'],
changelog: [{ version: 'next', description: 'Added aws.step_functions.state_machine.name attribute' }],
additionalContext: ['Contains no version or alias qualifier (`orders`, not `orders:1` or `orders:prod`).'],
},
blocked_main_thread: {
brief: 'Whether the main thread was blocked by the span.',
type: 'boolean',
Expand Down Expand Up @@ -37335,6 +37490,7 @@ export type Attributes = {
[AWS_LAMBDA_INVOKED_ARN]?: AWS_LAMBDA_INVOKED_ARN_TYPE;
[AWS_LAMBDA_INVOKED_FUNCTION_ARN]?: AWS_LAMBDA_INVOKED_FUNCTION_ARN_TYPE;
[AWS_LAMBDA_REMAINING_TIME_IN_MILLIS]?: AWS_LAMBDA_REMAINING_TIME_IN_MILLIS_TYPE;
[AWS_LAMBDA_TARGET_FUNCTION_NAME]?: AWS_LAMBDA_TARGET_FUNCTION_NAME_TYPE;
[AWS_LOG_GROUP_NAMES]?: AWS_LOG_GROUP_NAMES_TYPE;
[AWS_LOG_STREAM_NAMES]?: AWS_LOG_STREAM_NAMES_TYPE;
[AWS_OPERATION_NAME]?: AWS_OPERATION_NAME_TYPE;
Expand All @@ -37350,11 +37506,14 @@ export type Attributes = {
[AWS_S3_PART_NUMBER]?: AWS_S3_PART_NUMBER_TYPE;
[AWS_S3_UPLOAD_ID]?: AWS_S3_UPLOAD_ID_TYPE;
[AWS_SECRETSMANAGER_SECRET_ARN]?: AWS_SECRETSMANAGER_SECRET_ARN_TYPE;
[AWS_SECRETSMANAGER_SECRET_NAME]?: AWS_SECRETSMANAGER_SECRET_NAME_TYPE;
[AWS_SNS_TOPIC_ARN]?: AWS_SNS_TOPIC_ARN_TYPE;
[AWS_SQS_QUEUE_URL]?: AWS_SQS_QUEUE_URL_TYPE;
[AWS_STEP_FUNCTIONS_ACTIVITY_ARN]?: AWS_STEP_FUNCTIONS_ACTIVITY_ARN_TYPE;
[AWS_STEP_FUNCTIONS_ACTIVITY_NAME]?: AWS_STEP_FUNCTIONS_ACTIVITY_NAME_TYPE;
[AWS_STEP_FUNCTIONS_EXECUTION_ARN]?: AWS_STEP_FUNCTIONS_EXECUTION_ARN_TYPE;
[AWS_STEP_FUNCTIONS_STATE_MACHINE_ARN]?: AWS_STEP_FUNCTIONS_STATE_MACHINE_ARN_TYPE;
[AWS_STEP_FUNCTIONS_STATE_MACHINE_NAME]?: AWS_STEP_FUNCTIONS_STATE_MACHINE_NAME_TYPE;
[BLOCKED_MAIN_THREAD]?: BLOCKED_MAIN_THREAD_TYPE;
[BROWSER_BFCACHE_FRAME]?: BROWSER_BFCACHE_FRAME_TYPE;
[BROWSER_BFCACHE_NOT_RESTORED_REASON_COUNT]?: BROWSER_BFCACHE_NOT_RESTORED_REASON_COUNT_TYPE;
Expand Down
48 changes: 48 additions & 0 deletions javascript/sentry-conventions/src/search.ts
Original file line number Diff line number Diff line change
Expand Up @@ -788,6 +788,11 @@ export const SEARCH_AWS__LAMBDA__INVOKED_FUNCTION_ARN = 'aws.lambda.invoked_func
*/
export const SEARCH_AWS__LAMBDA__REMAINING_TIME_IN_MILLIS = 'aws.lambda.remaining_time_in_millis';

/**
* Search name for {@link attributes.AWS_LAMBDA_TARGET_FUNCTION_NAME}. `aws.lambda.target_function.name`
*/
export const SEARCH_AWS__LAMBDA__TARGET_FUNCTION__NAME = 'aws.lambda.target_function.name';

/**
* Search name for {@link attributes.AWS_LOG_GROUP_NAMES}. `aws.log.group.names`
*/
Expand Down Expand Up @@ -866,6 +871,11 @@ export const SEARCH_AWS__S3__UPLOAD_ID = 'aws.s3.upload_id';
*/
export const SEARCH_AWS__SECRETSMANAGER__SECRET__ARN = 'aws.secretsmanager.secret.arn';

/**
* Search name for {@link attributes.AWS_SECRETSMANAGER_SECRET_NAME}. `aws.secretsmanager.secret.name`
*/
export const SEARCH_AWS__SECRETSMANAGER__SECRET__NAME = 'aws.secretsmanager.secret.name';

/**
* Search name for {@link attributes.AWS_SNS_TOPIC_ARN}. `aws.sns.topic.arn`
*/
Expand All @@ -881,6 +891,11 @@ export const SEARCH_AWS__SQS__QUEUE__URL = 'aws.sqs.queue.url';
*/
export const SEARCH_AWS__STEP_FUNCTIONS__ACTIVITY__ARN = 'aws.step_functions.activity.arn';

/**
* Search name for {@link attributes.AWS_STEP_FUNCTIONS_ACTIVITY_NAME}. `aws.step_functions.activity.name`
*/
export const SEARCH_AWS__STEP_FUNCTIONS__ACTIVITY__NAME = 'aws.step_functions.activity.name';

/**
* Search name for {@link attributes.AWS_STEP_FUNCTIONS_EXECUTION_ARN}. `aws.step_functions.execution.arn`
*/
Expand All @@ -891,6 +906,11 @@ export const SEARCH_AWS__STEP_FUNCTIONS__EXECUTION__ARN = 'aws.step_functions.ex
*/
export const SEARCH_AWS__STEP_FUNCTIONS__STATE_MACHINE__ARN = 'aws.step_functions.state_machine.arn';

/**
* Search name for {@link attributes.AWS_STEP_FUNCTIONS_STATE_MACHINE_NAME}. `aws.step_functions.state_machine.name`
*/
export const SEARCH_AWS__STEP_FUNCTIONS__STATE_MACHINE__NAME = 'aws.step_functions.state_machine.name';

/**
* Search name for {@link attributes.AWS_REGION}. `aws_region`
*
Expand Down Expand Up @@ -5383,6 +5403,7 @@ export type AttributeSearchName =
| typeof SEARCH_AWS__LAMBDA__INVOKED_ARN
| typeof SEARCH_AWS__LAMBDA__INVOKED_FUNCTION_ARN
| typeof SEARCH_AWS__LAMBDA__REMAINING_TIME_IN_MILLIS
| typeof SEARCH_AWS__LAMBDA__TARGET_FUNCTION__NAME
| typeof SEARCH_AWS__LOG__GROUP__NAMES
| typeof SEARCH_AWS__LOG__STREAM__NAMES
| typeof SEARCH_AWS__OPERATION_NAME
Expand All @@ -5397,11 +5418,14 @@ export type AttributeSearchName =
| typeof SEARCH_AWS__S3__PART_NUMBER
| typeof SEARCH_AWS__S3__UPLOAD_ID
| typeof SEARCH_AWS__SECRETSMANAGER__SECRET__ARN
| typeof SEARCH_AWS__SECRETSMANAGER__SECRET__NAME
| typeof SEARCH_AWS__SNS__TOPIC__ARN
| typeof SEARCH_AWS__SQS__QUEUE__URL
| typeof SEARCH_AWS__STEP_FUNCTIONS__ACTIVITY__ARN
| typeof SEARCH_AWS__STEP_FUNCTIONS__ACTIVITY__NAME
| typeof SEARCH_AWS__STEP_FUNCTIONS__EXECUTION__ARN
| typeof SEARCH_AWS__STEP_FUNCTIONS__STATE_MACHINE__ARN
| typeof SEARCH_AWS__STEP_FUNCTIONS__STATE_MACHINE__NAME
| typeof SEARCH_AWS_REGION
| typeof SEARCH_BLOCKED_MAIN_THREAD
| typeof SEARCH_BROWSER__BFCACHE__FRAME
Expand Down Expand Up @@ -7068,6 +7092,12 @@ export const ATTRIBUTE_SEARCH_METADATA: Record<string, AttributeSearchMetadata>
brief: 'The remaining time in milliseconds before the Lambda function times out',
deprecationChain: ['aws.lambda.remaining_time_in_millis'],
},
'aws.lambda.target_function.name': {
canonicalName: 'aws.lambda.target_function.name',
type: 'string',
brief: 'The name of the AWS Lambda function that an AWS SDK call acts on.',
deprecationChain: ['aws.lambda.target_function.name'],
},
'aws.log.group.names': {
canonicalName: 'aws.log.group.names',
type: 'string[]',
Expand Down Expand Up @@ -7153,6 +7183,12 @@ export const ATTRIBUTE_SEARCH_METADATA: Record<string, AttributeSearchMetadata>
brief: 'The ARN of the Secret stored in Secrets Manager.',
deprecationChain: ['aws.secretsmanager.secret.arn'],
},
'aws.secretsmanager.secret.name': {
canonicalName: 'aws.secretsmanager.secret.name',
type: 'string',
brief: 'The name of the secret stored in AWS Secrets Manager.',
deprecationChain: ['aws.secretsmanager.secret.name'],
},
'aws.sns.topic.arn': {
canonicalName: 'aws.sns.topic.arn',
type: 'string',
Expand All @@ -7173,6 +7209,12 @@ export const ATTRIBUTE_SEARCH_METADATA: Record<string, AttributeSearchMetadata>
brief: 'The ARN of the AWS Step Functions Activity.',
deprecationChain: ['aws.step_functions.activity.arn'],
},
'aws.step_functions.activity.name': {
canonicalName: 'aws.step_functions.activity.name',
type: 'string',
brief: 'The name of the AWS Step Functions activity.',
deprecationChain: ['aws.step_functions.activity.name'],
},
'aws.step_functions.execution.arn': {
canonicalName: 'aws.step_functions.execution.arn',
type: 'string',
Expand All @@ -7185,6 +7227,12 @@ export const ATTRIBUTE_SEARCH_METADATA: Record<string, AttributeSearchMetadata>
brief: 'The ARN of the AWS Step Functions State Machine.',
deprecationChain: ['aws.step_functions.state_machine.arn'],
},
'aws.step_functions.state_machine.name': {
canonicalName: 'aws.step_functions.state_machine.name',
type: 'string',
brief: 'The name of the AWS Step Functions state machine.',
deprecationChain: ['aws.step_functions.state_machine.name'],
},
aws_region: {
canonicalName: 'cloud.region',
type: 'string',
Expand Down
Loading
Loading