package serverless.instrumentation.tags.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: AwsLambdaTags

• string account_id = 1

  The AWS Account ID of the API GW.

• string api_id = 2

  The unique id used for the API GW.

• string api_stage = 3

  The stage of the API GW endpoint that was called.

• optional AwsApiGatewayTags.AwsApiGatewayRequestTags request = 15

Used in: AwsApiGatewayTags

• string id = 1

  The unique API GW Request ID.

• uint64 time_epoch = 2

  The request time in milliseconds from epoch.

• repeated string path_parameter_names = 4

  JSON string containing Request Path Parameters

Used in: AwsLambdaTags

• uint32 initialization_duration = 1

  The Initialization Duration of the Lambda Function. This is one part of the billed duration. Maps to the Cloudwatch Logs Report "Init Duration"

Used in: AwsLambdaTags

• uint32 invocation_duration = 1

  The Invocation Duration of the Lambda Function. This is one part of the billed duration. Maps to the Cloudwatch Logs Report "Duration"

Describes the AWS Lambda runtime details

Used in: AwsLambdaTags

• string identifier = 1

  Runtime identifier

• string version = 2

  Runtime version

• string arn = 3

  Runtime ARN

Used in: AwsTags

• string arch = 1

  The architecture of the Lambda function, currently either amd64 or arm64.

• bool is_coldstart = 2

  Was the invocation a cold start?

• optional string event_type = 3

  The event type for the invocation.

• optional string event_source = 4

  The event source for the invocation.

• optional string log_group = 5

  The Log Group for the Lambda Function.

• optional string log_stream_name = 6

  The Log Stream for the invocation.

• optional uint32 max_memory = 7

  The Max Memory that is configured for the Lambda Function.

• string name = 8

  The Lambda Function name.

• string request_id = 9

  The Request ID for the invocation.

• string version = 11

  The Lambda Function version.

• optional string account_id = 12

  The AWS Account ID of the Lambda Function

• AwsLambdaTags.Outcome outcome = 14

  The Outcome of the Lambda invocation

• optional string error_exception_message = 15

  Optional error exception message.

• optional string error_exception_stacktrace = 16

  Optional error exception stacktrace.

• optional uint32 duration = 17

  The billed duration of the invocation in milliseconds. This will not be available when instrumented, this will be upserted into this tag set after the report log from Cloudwatch is available.

• optional string request_body = 18

  Request body

• optional string response_body = 19

  Response body

• optional uint64 logs_start_time_unix = 20

  The Unix timestamp in milliseconds of the START log event of the invocation.

• optional uint64 logs_end_time_unix = 21

  The Unix timestamp in milliseconds of the REPORT log event of the invocation.

• optional AwsLambdaTags.ResponseMode response_mode = 22

  The event source for the invocation.

• optional AwsSqsEventTags sqs = 100

  Will be set if the function is handling a SQS event

• optional AwsSnsEventTags sns = 101

  Will be set if the function is handling a SNS event

• optional HttpTags http = 102

  Will be set if the function is handling HTTP requests via any method, API GW, Function URLs, etc.

• optional AwsApiGatewayTags api_gateway = 103

  Will be set if the function is handling HTTP requests via AWS API GW

• optional HttpRouterTags http_router = 106

  Will be set if function is handling HTTP requests and there's routing functionality setup

• optional AwsLambdaInitializationTags initialization = 104

  The root AWS Lambda Span tags.

• optional AwsLambdaInvocationTags invocation = 105

  The AWS Lambda Invocation tags.

• optional AwsLambdaRuntimeTags runtime = 107

  The AWS Lambda Runtime tags.

A Lambda function invocation can have one of the following outcomes upon completion.

Used in: AwsLambdaTags

• OUTCOME_UNSPECIFIED = 0

  No outcome was registered. Either information on the outcome was not disclosed (which should never be the case), or the function invocation has not been finalized yet

• OUTCOME_SUCCESS = 1

  Function handler returned successfully

• OUTCOME_ERROR_INITIALIZATION = 2

  Function crashed at initialization

• OUTCOME_ERROR_UNHANDLED = 3

  Function crashed in an unhandled way at invocation (a result of either uncaught exception or unhandled rejection)

• OUTCOME_ERROR_TIMEOUT = 4

  Function timed out

• OUTCOME_ERROR_HANDLED = 5

  Function handler resolved with an error (either error was passed to lambda callback, or async handler resolved with error rejection)

Used in: AwsLambdaTags

• RESPONSE_MODE_UNSPECIFIED = 0

  Mode not confirmed

• RESPONSE_MODE_BUFFERED = 1

  Regular buffered response

• RESPONSE_MODE_RESPONSE_STREAM = 2

  Stream response

Used in: AwsSdkTags

• optional string table_name = 1

  The DynamoDB table name

• optional string projection = 2

  The value of the ProjectionExpression request parameter.

• optional bool scan_forward = 3

  The value of the ScanIndexForward request parameter.

• repeated string attributes_to_get = 4

  The value of the AttributesToGet request parameter.

• optional bool consistent_read = 5

  The value of the ConsistentRead request parameter.

• optional string index_name = 6

  The value of the IndexName request parameter.

• optional uint32 limit = 7

  The value of the Limit request parameter.

• optional string select = 8

  The value of the Select request parameter.

• optional uint32 segment = 9

  The value of the Segment request parameter.

• optional uint64 total_segments = 10

  The value of the TotalSegments request parameter.

• optional string filter = 11

  The value of the FilterExpression request parameter.

• optional string key_condition = 12

  The value of the KeyConditionExpression request parameter.

• optional string exclusive_start_key = 13

  JSON string of the ExclusiveStartKey request parameter.

• optional string attribute_values = 14

  JSON string of the ExpressionAttributeValues request parameter.

• optional uint64 count = 100

  The value of the Count response parameter.

• optional uint64 scanned_count = 101

  The value of the ScannedCount response parameter.

Used in: AwsSdkTags

• optional string topic_name = 1

  The SNS Topic name taken from the TopicArn request parameter.

• repeated string message_ids = 2

  The message IDs provided in the SDK operation response.

Used in: AwsSdkTags

• optional string queue_name = 1

  The SQS queue name

• repeated string message_ids = 2

  The message IDs provided in the SDK operation response.

Used in: AwsTags

• optional string region = 2

  The AWS Region this SDK call is being made against.

• optional string signature_version = 3

  AWS Authentication signature version of the request.

• string service = 4

  The name of the service to which a request is made.

• string operation = 5

  The name of the operation corresponding to the request.

• optional string request_id = 6

  The unique ID of the request.

• optional string error = 7

  An optional error returned from the AWS APIs.

• optional AwsSdkDynamodbTags dynamodb = 100

• optional AwsSdkSqsTags sqs = 101

• optional AwsSdkSnsTags sns = 102

Used in: AwsLambdaTags

• string topic_name = 1

  Taken from the TopicARN

• repeated string message_ids = 2

  Introspected from the events records

Used in: AwsLambdaTags

• string queue_name = 1

  Taken from the eventSourceARN

• repeated string message_ids = 2

  Introspected from the events records

Used in: Tags

• optional AwsLambdaTags lambda = 100

  The root AWS Lambda Span tags

• optional AwsSdkTags sdk = 101

  The AWS SDK Tags. These are only added when instrumented code makes a call to one of the AWS SDK functions

• optional string account_id = 102

  Account Id is added to all schemas originating from aws during ingest as part of our data enrichment process

• optional string region = 103

  Region is added to all schemas originating from aws during ingest as part of our data enrichment process

• optional string request_id = 104

  RequestId is added to all schemas originating from aws lambda during ingest as part of our data enrichment process

• optional string resource_name = 105

  ResourceName is added to all schemas originating from aws lambda during ingest as part of our data enrichment process

• optional string sequence_id = 3

  The monotonically increasing sequence id for a LogEvent originating from aws lambda. This is used to determine the ordering of messages in a given stream of logs. If this is a LogEvent coming from Cloudwatch Logs, it will be provided otherwise it is the responsibility of the log producer to generate a sequence id.

• optional string log_group = 4

  The Cloudwatch Log Group name for logs originating from aws lambda.

• optional string log_stream = 5

  The Cloudwatch Log Group Stream id for logs originating from aws lambda.

Used in: Tags

• string app = 1

  The name of the Dashboard application that was instrumented.

• string service = 2

  The name of the Dashboard service that was instrumented.

Used in: Tags

• string name = 1

  The Error Name

• optional string message = 2

  The Error Message - Depending on runtime this is defined or not.

• optional string stacktrace = 3

  The Error stacktrace if applicable

• ErrorTags.ErrorType type = 4

Used in: ErrorTags

• ERROR_TYPE_UNSPECIFIED = 0

  No ErrorType was provided. This should never be the case and if it is received ingest will ignore it.

• ERROR_TYPE_UNCAUGHT = 1

  An unexpected error that caused the application to fail

• ERROR_TYPE_CAUGHT_USER = 2

  An error that was reported by user explictly via the Serverless SDK or console.error call Error doesn't explicitly fail the application. Multiple errors of this type can be reported during a single application run

• ERROR_TYPE_CAUGHT_SDK_USER = 3

  An error that was reported by the Serverless SDK internally that reports user error (misuage of the SDK) Error doesn't explicitly fail the application. Multiple errors of this type can be reported during a single application run

• ERROR_TYPE_CAUGHT_SDK_INTERNAL = 4

  An error that was reported by the Serverless SDK internally that reports internal SDK error Error doesn't explicitly fail the application. Multiple errors of this type can be reported during a single application run

Describe routing of incoming HTTP requests. Reflects configuration of a router used to route the request It can be Express.js, or API Gateway if Express.js is not detected to be used

Used in: AwsLambdaTags

• string path = 1

  The HTTP Path defined by the route handler (either express or API Gateway)

Generic tagset intended to describe incoming or outgoing HTTP requests

Used in: AwsLambdaTags, Tags

• string method = 1

  The method of the HTTP Request

• string protocol = 2

  The protocol of the HTTP Request

• string host = 3

  The host of the HTTP Request

• string path = 4

  The path of the HTTP Request

• repeated string query_parameter_names = 6

  Names of the query parameters

• repeated string request_header_names = 8

  Request header names

• optional uint32 status_code = 9

  The Response Status Code. @validation_exact_number

• optional string error_code = 12

  Eventual request error code

Used in: Tags

• string message = 1

  Notice Message

• optional NoticeTags.NoticeType type = 2

Used in: NoticeTags

• NOTICE_TYPE_UNSPECIFIED = 0

  Notice type not set

• NOTICE_TYPE_SDK_INTERNAL = 1

  Signals SDK noteworthy event Event that's not relevant to the user but can be important instruction for the Console on how to process monitoring data of given case

Used in: SlsTags, Tags

• string name = 1

  The Name of the Serverless SDK used to instrument.

• string version = 2

  The version of the Serverless SDK used to instrument.

• optional string runtime = 3

  SDK runtime (e.g. nodejs)

Used in: v1.EventPayload, v1.LogPayload, v1.MetricPayload, v1.RequestResponse, v1.TracePayload

• string org_id = 1

  A Serverless Platform OrgId.

• optional string platform = 2

  The platform that was instrumented. Currently Lambda is the only supported platform.

• string service = 3

  The service that was instrumented. For Lambda this will be the function name by default.

• optional string region = 4

  The region that instrumentation was performed in. This is used to determine which Serverless Ingest API to use.

• optional SdkTags sdk = 5

• optional string environment = 16

  An optional environment that can be attached. If there is an applicable environment tag this will be attached in a data enrichment process during ingestion.

• optional string namespace = 17

  An optional namespace that can be attached. If there is an applicable namespace tag this will be attached in a data enrichment process during ingestion.

@validation_root

Used in: v1.Event, v1.LogEvent, v1.RequestResponse, v1.Span

• optional AwsTags aws = 100

  These tags are used an AWS resource/sdk is the producer of the span

• optional HttpTags http = 106

  These tags are used when an http library is making an http request

• optional HttpTags https = 107

  These tags are used when an http library is making a https request

• optional SdkTags sdk = 112

  These sdk tags are added at ingest time so we know where the data was generated from

• optional DashboardTags dashboard = 116

  These tags are used when a Dashboard app is instrumented. It is added to all schemas during ingest as part of our data enrichment process.

• optional string environment = 109

  Environment is added to all schemas during ingest as part of our data enrichment process @validation_top_level

• optional string namespace = 110

  Namespace is added to all schemas during ingest as part of our data enrichment process @validation_top_level

• optional string org_id = 111

  OrgId is added to all schemas during ingest as part of our data enrichment process @validation_top_level @validation_single_string

• optional ErrorTags error = 113

  These tags are used when an error has occured and is reported on the event.

• optional WarningTags warning = 114

  These tags are used when a warning has occured and is reported on the event.

• optional NoticeTags notice = 115

  These tags are used when noteworthy situation occurs and is reported on the event.

Used in: Tags

• string message = 1

  The Warning Message

• optional string stacktrace = 3

  Stack trace listing where the warning was reported

• optional WarningTags.WarningType type = 2

Used in: WarningTags

• WARNING_TYPE_UNSPECIFIED = 0

  Warning type not set

• WARNING_TYPE_USER = 1

  Warning explicitly reported by user

• WARNING_TYPE_SDK_USER = 2

  Warning reported internally by the SDK that signal potential misusage on user side

• WARNING_TYPE_SDK_INTERNAL = 3

  Warning reported internally by the SDK that signal non fatal SDK issue