.. _envoy_api_file_envoy/type/tracing/v2/custom_tag.proto: Custom Tag ========== .. _envoy_api_msg_type.tracing.v2.CustomTag: type.tracing.v2.CustomTag ------------------------- `[type.tracing.v2.CustomTag proto] `_ Describes custom tags for the active span. .. code-block:: json { "tag": "...", "literal": "{...}", "environment": "{...}", "request_header": "{...}", "metadata": "{...}" } .. _envoy_api_field_type.tracing.v2.CustomTag.tag: tag (`string `_, *REQUIRED*) Used to populate the tag name. .. _envoy_api_field_type.tracing.v2.CustomTag.literal: literal (:ref:`type.tracing.v2.CustomTag.Literal `) A literal custom tag. Used to specify what kind of custom tag. Precisely one of :ref:`literal `, :ref:`environment `, :ref:`request_header `, :ref:`metadata ` must be set. .. _envoy_api_field_type.tracing.v2.CustomTag.environment: environment (:ref:`type.tracing.v2.CustomTag.Environment `) An environment custom tag. Used to specify what kind of custom tag. Precisely one of :ref:`literal `, :ref:`environment `, :ref:`request_header `, :ref:`metadata ` must be set. .. _envoy_api_field_type.tracing.v2.CustomTag.request_header: request_header (:ref:`type.tracing.v2.CustomTag.Header `) A request header custom tag. Used to specify what kind of custom tag. Precisely one of :ref:`literal `, :ref:`environment `, :ref:`request_header `, :ref:`metadata ` must be set. .. _envoy_api_field_type.tracing.v2.CustomTag.metadata: metadata (:ref:`type.tracing.v2.CustomTag.Metadata `) A custom tag to obtain tag value from the metadata. Used to specify what kind of custom tag. Precisely one of :ref:`literal `, :ref:`environment `, :ref:`request_header `, :ref:`metadata ` must be set. .. _envoy_api_msg_type.tracing.v2.CustomTag.Literal: type.tracing.v2.CustomTag.Literal --------------------------------- `[type.tracing.v2.CustomTag.Literal proto] `_ Literal type custom tag with static value for the tag value. .. code-block:: json { "value": "..." } .. _envoy_api_field_type.tracing.v2.CustomTag.Literal.value: value (`string `_, *REQUIRED*) Static literal value to populate the tag value. .. _envoy_api_msg_type.tracing.v2.CustomTag.Environment: type.tracing.v2.CustomTag.Environment ------------------------------------- `[type.tracing.v2.CustomTag.Environment proto] `_ Environment type custom tag with environment name and default value. .. code-block:: json { "name": "...", "default_value": "..." } .. _envoy_api_field_type.tracing.v2.CustomTag.Environment.name: name (`string `_, *REQUIRED*) Environment variable name to obtain the value to populate the tag value. .. _envoy_api_field_type.tracing.v2.CustomTag.Environment.default_value: default_value (`string `_) 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. .. _envoy_api_msg_type.tracing.v2.CustomTag.Header: type.tracing.v2.CustomTag.Header -------------------------------- `[type.tracing.v2.CustomTag.Header proto] `_ Header type custom tag with header name and default value. .. code-block:: json { "name": "...", "default_value": "..." } .. _envoy_api_field_type.tracing.v2.CustomTag.Header.name: name (`string `_, *REQUIRED*) Header name to obtain the value to populate the tag value. .. _envoy_api_field_type.tracing.v2.CustomTag.Header.default_value: default_value (`string `_) When the header does not exist, the tag value will be populated with this default value if specified, otherwise no tag will be populated. .. _envoy_api_msg_type.tracing.v2.CustomTag.Metadata: type.tracing.v2.CustomTag.Metadata ---------------------------------- `[type.tracing.v2.CustomTag.Metadata proto] `_ Metadata type custom tag using :ref:`MetadataKey ` to retrieve the protobuf value from :ref:`Metadata `, and populate the tag value with `the canonical JSON `_ representation of it. .. code-block:: json { "kind": "{...}", "metadata_key": "{...}", "default_value": "..." } .. _envoy_api_field_type.tracing.v2.CustomTag.Metadata.kind: kind (:ref:`type.metadata.v2.MetadataKind `) Specify what kind of metadata to obtain tag value from. .. _envoy_api_field_type.tracing.v2.CustomTag.Metadata.metadata_key: metadata_key (:ref:`type.metadata.v2.MetadataKey `) Metadata key to define the path to retrieve the tag value. .. _envoy_api_field_type.tracing.v2.CustomTag.Metadata.default_value: default_value (`string `_) When no valid metadata is found, the tag value would be populated with this default value if specified, otherwise no tag would be populated.