package envoy.type.tracing.v2

Get desktop application:
View/edit binary Protocol Buffers messages

Describes custom tags for the active span. [#next-free-field: 6]

Used in: api.v2.route.Tracing, config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing

• string tag = 1

  Used to populate the tag name.

• oneof type

  Used to specify what kind of custom tag.

  • CustomTag.Literal literal = 2

    A literal custom tag.

  • CustomTag.Environment environment = 3

    An environment custom tag.

  • CustomTag.Header request_header = 4

    A request header custom tag.

  • CustomTag.Metadata metadata = 5

    A custom tag to obtain tag value from the metadata.

Environment type custom tag with environment name and default value.

Used in: CustomTag

• string name = 1

  Environment variable name to obtain the value to populate the tag value.

• string default_value = 2

  When the environment variable is not found, the tag value will be populated with this default value if specified, otherwise no tag will be populated.

Header type custom tag with header name and default value.

Used in: CustomTag

• string name = 1

  Header name to obtain the value to populate the tag value.

• string default_value = 2

  When the header does not exist, the tag value will be populated with this default value if specified, otherwise no tag will be populated.

Literal type custom tag with static value for the tag value.

Used in: CustomTag

• string value = 1

  Static literal value to populate the tag value.

Metadata type custom tag using :ref:`MetadataKey <envoy_api_msg_type.metadata.v2.MetadataKey>` to retrieve the protobuf value from :ref:`Metadata <envoy_api_msg_core.Metadata>`, and populate the tag value with `the canonical JSON <https://developers.google.com/protocol-buffers/docs/proto3#json>`_ representation of it.

Used in: CustomTag

• optional metadata.v2.MetadataKind kind = 1

  Specify what kind of metadata to obtain tag value from.

• optional metadata.v2.MetadataKey metadata_key = 2

  Metadata key to define the path to retrieve the tag value.

• string default_value = 3

  When no valid metadata is found, the tag value would be populated with this default value if specified, otherwise no tag would be populated.