package serverless.instrumentation.v1

Get desktop application:
View/edit binary Protocol Buffers messages

A DevMode Payload is a message that will contain reqRes data or span data that is forwarded to ingest via the internal extension

• string account_id = 1

  The AWS Account ID where this payload originated from

• string region = 2

  The AWS Region where this payload originated from

• string request_id = 3

  The lambda request id where this payload originated from

• optional LambdaTelemetry telemetry = 6

  Extracted Lambda Telemetry API data

• oneof payload

  • TracePayload trace = 4

    The set of lambda traces that were generated via an internal extension

  • RequestResponse request_response = 5

    The req or response data from the instrumented lambda function

DevMode Transport Payload that will be used to aggregate reqRes, traces, and logs into a single payload that will be packaged and sent to our DevMode ingest.

• string account_id = 1

  The AWS Account ID where this payload originated from

• string region = 2

  The AWS Region where this payload originated from

• string request_id = 3

  The lambda request id where this payload originated from

• repeated RequestResponse request_response = 4

  The request/response data from the instrumented lambda function

• repeated TracePayload traces = 5

  The set of lambda traces that were generated via an internal extension

• repeated LogPayload logs = 7

  The logs generated via the telemetry API

Used in: EventPayload, TracePayload

• bytes id = 1

  The Event ID, this will be a random 8-byte ID encoded as a length 16 lowercase hex string.

• bytes trace_id = 2

  The Trace ID, this will be a random 16-byte ID encoded as a length 32 lowercase hex string. The Trace ID is what is used to group all spans for specific trace together.

• optional bytes span_id = 3

  An optional Span ID to be used to create to show the span context that the event was generated in. In practical terms, every span except the root span will have a parent span ID.

• fixed64 timestamp_unix_nano = 4

  The timestamp of when the Event happened in nanoseconds from EPOCH.

• string event_name = 5

  The name that is used internal in the Serverless platform to identify the event.

• optional string custom_tags = 6

  The optional customTags that can be attached to an event when published. This is expected to be a JSON object in string format.

• optional string custom_fingerprint = 7

  The optional custom fingerprint that will override our default fingerprinting approach

• optional tags.v1.Tags tags = 15

  A message containing any number of Tagsets.

An EventPayload is a message that will contain any number of Events plus the global tags required by our Serverless Ingest Platform.

• optional tags.v1.SlsTags sls_tags = 1

• repeated Event events = 2

  A list of Events to be ingested. Ingest does not impose a limit on the number of Events in a single payload. It is the responsibility of the Event producer to limit the size of payloads based on their own requirements.

Lambda Telemetry API data. This data is only available for lambda functions that have access to the telemetry API so it will not be included in all regions.

Used in: DevModePayload

• optional uint32 init_duration_ms = 1

  Init duration in milliseconds as reported by the metrics on the platform.initReport event

• optional uint32 runtime_duration_ms = 2

  Internal runtime duration in milliseconds as reported by the metrics on the platform.runtimeDone event

• optional uint32 runtime_response_latency_ms = 3

  Internal runtime duration in milliseconds as reported by the responseLatency span on the platform.runtimeDone event

Used in: LogPayload

• fixed64 timestamp = 2

  The timestamp of when the LogEvent was created.

• optional string trace_id = 8

  The Trace Id that the log's are linked to. When ingesting LogEvents, ingest will attempt to infer the request_id from the payload and attach it. If it is not able to, then it will attempt to reconcile later.

• string body = 9

  The LogEvent's body.

• string severity_text = 10

  The calculated severity text value for a log

• uint64 severity_number = 11

  The calculated severity text value for a log

• optional tags.v1.Tags tags = 12

  A message containing any number of Tagsets

• optional bool is_historical = 13

  Is historical is addedd via ingestion so that we can tell the differnce between historical payloads and live streamed payloads

• optional string type = 14

  Type is used to determine the kind of document that is being send via a livestream

A LogPayload is a message that will contain any number of LogEvents plus the global tags required by our Serverless Ingest Platform.

Used in: DevModeTransportPayload

• optional tags.v1.SlsTags sls_tags = 1

• repeated LogEvent log_events = 2

  A list of LogEvents to be ingested. Ingest does not impose a limit on the number of LogEvents in a single payload. It is the responsibility of the LogEvents' producers to limit the size of payloads based on their own requirements.

Used in: MetricPayload

• bytes id = 1

  A unique id for the metric measurement. If this is a Metric from, The metric stream then it will be a randomly generated UUID at ingest time.

• string name = 2

  The name of the metric. If this is a Metric from the Metric stream, it will be in the format amazonaws.com/<metric_namespace>/<metric_name>. The name is what will be mapped into influx.

• fixed64 start_time_unix_nano = 3

  The start time of the measure. If this is a Metric from the Metric stream, it will be the Cloudwatch startTime property.

• fixed64 end_time_unix_nano = 4

  The end time of the measure. If this is a Metric from the Metric stream, it will be the Cloudwatch endTime property.

• string tags = 5

  Tags for the Metric. Any tags can be placed in this field, however, ingest will only write allowlisted, low cardinality tags to Influx.

• fixed64 count = 6

  The number of datapoints for the Metric. If this is a Metric from the Metric stream, it will be the SampleCount from Cloudwatch

• double sum = 7

  The sum of the datapoints for the Metric.

• repeated Metric.ValueAtQuantile quantile_values = 8

  List of quantile values. If this is a Metric from the Metric stream, it will by default have quantile 0.0 and 1.0 to represent the min and max values. If defined during Metric's Stream setup it will have additional quantiles as well.

A value at a given quantile of the distribution. If a Metric has multiple samples, the Min and Max will be represented by, 1. Quantile = 1.0, is the max value 2. Quantile = 0.0, is the min value

Used in: Metric

• double quantile = 1

• double value = 2

A MetricPayload is a message that will contain any number of Metrics plus the global tags required by our Serverless Ingest Platform.

• optional tags.v1.SlsTags sls_tags = 1

• repeated Metric metrics = 2

  A list of Metrics to be ingested. Ingest does not impose a limit on the number of Metrics in a single payload. It is the responsibility of the metrics' producers to limit the size of payloads based on their own requirements.

RequestResponse is the AWS Lambda Event and Response Data. In the Serverless Platform there will be two of these payloads One for Event payload and then one for the payload returned at the end of the function invocation.

Used in: DevModePayload, DevModeTransportPayload

• optional tags.v1.SlsTags sls_tags = 1

  The Global Serverless Platform Tags

• optional bytes trace_id = 2

  The trace Id of the invocation

• optional bytes span_id = 3

  The span id of the root Lambda Span that request data is attached to on ingest.

• optional string request_id = 4

  The Lambda Request Id.

• optional string body = 11

  JSON string of the request or the response body In case of response may be omited if lambda resolved with no value

• RequestResponse.Origin origin = 12

  Type of body

• optional tags.v1.Tags tags = 7

  A message containing any number of Tagsets

• optional bool is_historical = 8

  Is historical is addedd via ingestion so that we can tell the differnce between historical payloads and live streamed payloads

• optional string type = 9

  Type is used to determine the kind of document that is being send via a livestream

• optional fixed64 timestamp = 10

  The timestamp of when the req/res data was generated.

Used in: RequestResponse

• ORIGIN_UNSPECIFIED = 0

  Not disclosed (not applicable as property is required)

• ORIGIN_REQUEST = 1

  Function request event

• ORIGIN_RESPONSE = 2

  Function handler response

Used in: TracePayload

• bytes id = 1

  The Span ID, this will be a random 8-byte ID encoded as a length 16 lowercase hex string.

• bytes trace_id = 2

  The Trace ID, this will be a random 16-byte ID encoded as a length 32 lowercase hex string. The Trace ID is what is used to group all spans for specific trace together.

• optional bytes parent_span_id = 3

  An optional Parent Span ID to be used to create a trace's Span Dependency graph. In practical terms, every span except the root span will have a parent span ID.

• string name = 4

  The name of the span describes the type of span that is being produced. currently have a limited set of span names - aws.lambda: Spans the full invocation duration of a lambda function - aws.lambda.invocation: Spans the cold-start duration of a lambda function

• fixed64 start_time_unix_nano = 5

  The start time of the span in nanoseconds from EPOCH.

• fixed64 end_time_unix_nano = 6

  The end time of the span in nanoseconds from EPOCH. An important invariant to keep in mind is that the root span will always have the latest end time.

• optional tags.v1.Tags tags = 7

  A message containing any number of Tagsets

• optional string input = 8

  Eventual input body (e.g. HTTP request body)

• optional string output = 9

  Eventual output body (e.g. HTTP response body)

• optional fixed64 timestamp = 10

  The timestamp that is created in ingestion as the search key

• optional bool is_historical = 11

  Is historical is addedd via ingestion so that we can tell the differnce between historical payloads and live streamed payloads

• optional string type = 12

  Type is used to determine the kind of document that is being send via a livestream

• optional string custom_tags = 13

  The optional custom tags to be set by the user This is expected to be a JSON object in string format.

TracePayload is a message that will contain any number of Spans plus the global tags required by our Serverless Ingest Platform. A TracePayload DOES NOT necessarily mean that it is a complete Trace. It may contain only a subset of Spans that will make up the complete Trace.

Used in: DevModePayload, DevModeTransportPayload

• optional tags.v1.SlsTags sls_tags = 1

• repeated Span spans = 3

  A list of Spans to be ingest. Ingest does not impose a limit on the number of Spans in a single payload. It is the responsibility of the Span producers to limit the size of payloads based on their own requirements.

• repeated Event events = 4

  A list of Events to be ingested. Ingest does not impose a limit on the number of Events in a single payload. It is the responsibility of the Event producers to limit the size of paylaods based on their own requirements.

• optional string custom_tags = 5

  The optional custom trace tags to be set by the user This is expected to be a JSON object in string format.

• optional bool is_sampled_out = 6

  Whether the trace payload represents sampled out invocation and in result contains just core spans and no events

• optional bool is_truncated = 7

  Whether the trace payload represents truncated result (to fit max 256KB size limit)