Skip to content

TraceHeaders

Note

This page was generated by extracting information from a JSON Schema data file for the API. It may be missing some information, or otherwise suggest approximate or placeholder values based on information in the schema file; this is due to limitations on how that data is extracted from the underlying Rust code and into the JSON Schema, and then again from there and into these docs.

This is an object value, with the following properties:

  • header_name - optional string. The name of the supplemental trace header

  • include_meta_names - optional array of string. List of meta keys that should be included in the supplemental header

  • received_header - optional boolean. Whether to add a Received: header

  • supplemental_header - optional boolean. Whether to add a supplemental trace header to encode additional metadata

Examples

{
  "header_name": "string",
  "include_meta_names": [
    "string"
  ],
  "received_header": false,
  "supplemental_header": false
}