Payload Collection
The “Payload Collection” rule can be used to add span attributes by collecting payload data from various sources like HTTP requests, HTTP responses, database queries, and messaging systems.
This Instrumentation Rule is currently only available with the Odigos Enterprise plan.
Contact us for more information.
Considerations
Before enabling payload collection, please note the following:
- PII (Personally Identifiable Information) and other potentially sensitive data may be present in the payload. Evaluate the risk of collecting this data, and consider using the PII Masking Action to mask sensitive data.
- Payload data can be large and may increase the size of your spans. This can impact the performance of your application and the cost of processing, storing and analyzing traces.
- The support for payload collection varies between instrumentation libraries and languages. Not all libraries support payload collection, and the supported payload types and formats may differ. Consult the documentation of the instrumentation library you are using for more information.
Configuration Options
httpRequest
httpRequest
httpRequest object
: Collect HTTP request payload data when available. Can be a client (outgoing) request or a server (incoming) request, depending on the instrumentation library.
- This field is optional
mimeTypes
mimeTypes
mimeTypes string[]
: Limit payload collection to specific mime types based on the content-type header.
- This field is optional, and defaults to
nil
(all mime types) - Empty array will make the rule ineffective
maxPayloadLength
maxPayloadLength
maxPayloadLength number
: Maximum length of the payload to collect. If the payload is longer than this value, it will be truncated or dropped, based on the value of dropPartialPayloads
.
- This field is optional
dropPartialPayloads
dropPartialPayloads
dropPartialPayloads boolean
: If the payload is larger than the maxPayloadLength
, this parameter will determine if the payload should be partially collected up to the allowed length, or not collected at all. This is useful if you require some decoding of the payload (like json) and having it partially is not useful.
- This field is optional, and defaults to
false
httpResponse
httpResponse
httpResponse object
: Collect HTTP response payload data when available. Can be a client (incoming) response or a server (outgoing) response, depending on the instrumentation library
- This field is optional
mimeTypes
mimeTypes
mimeTypes string[]
: Limit payload collection to specific mime types based on the content-type header.
- This field is optional, and defaults to
nil
(all mime types) - Empty array will make the rule ineffective
maxPayloadLength
maxPayloadLength
maxPayloadLength number
: Maximum length of the payload to collect. If the payload is longer than this value, it will be truncated or dropped, based on the value of dropPartialPayloads
.
- This field is optional
dropPartialPayloads
dropPartialPayloads
dropPartialPayloads boolean
: If the payload is larger than the maxPayloadLength
, this parameter will determine if the payload should be partially collected up to the allowed length, or not collected at all. This is useful if you require some decoding of the payload (like json) and having it partially is not useful.
- This field is optional, and defaults to
false
dbQuery
dbQuery
dbQuery object
: Collect database query payload info when available.
- This field is optional
mimeTypes
mimeTypes
mimeTypes string[]
: Limit payload collection to specific mime types based on the content-type header.
- This field is optional, and defaults to
nil
(all mime types) - Empty array will make the rule ineffective
maxPayloadLength
maxPayloadLength
maxPayloadLength number
: Maximum length of the payload to collect. If the payload is longer than this value, it will be truncated or dropped, based on the value of dropPartialPayloads
.
- This field is optional
messaging
messaging
messaging object
: Collect messaging system operation payload info when available.
- This field is optional
mimeTypes
mimeTypes
mimeTypes string[]
: Limit payload collection to specific mime types based on the content-type header.
- This field is optional, and defaults to
nil
(all mime types) - Empty array will make the rule ineffective
maxPayloadLength
maxPayloadLength
maxPayloadLength number
: Maximum length of the payload to collect. If the payload is longer than this value, it will be truncated or dropped, based on the value of dropPartialPayloads
.
- This field is optional
Any unspecified options will fallback to a reasonable default value provided by the instrumentation library (recommended).
Basic Example
The following example demonstrates how to enable payload collection for all supported workloads and instrumentation libraries in the cluster.
Create a YAML file with the following content:
Apply the action to the cluster:
Full Example
The following example is a demonstration of all the options available in the “Payload Collection” Rule. It is not meant to be used “as is”, but rather as a reference to customize the rule to your needs.
Create a YAML file with the following content:
Apply the action to the cluster: