custom_tag.proto
Package: solo.io.envoy.type.tracing.v3
Types:
Source File: github.com/solo-io/gloo/projects/gloo/api/external/envoy/type/tracing/v3/custom_tag.proto
CustomTag
Describes custom tags for the active span. [#next-free-field: 6]
"tag": string
"literal": .solo.io.envoy.type.tracing.v3.CustomTag.Literal
"environment": .solo.io.envoy.type.tracing.v3.CustomTag.Environment
"requestHeader": .solo.io.envoy.type.tracing.v3.CustomTag.Header
"metadata": .solo.io.envoy.type.tracing.v3.CustomTag.Metadata
| Field | Type | Description |
|---|---|---|
tag |
string |
Used to populate the tag name. |
literal |
.solo.io.envoy.type.tracing.v3.CustomTag.Literal | A literal custom tag. Only one of literal, environment, requestHeader, or metadata can be set. |
environment |
.solo.io.envoy.type.tracing.v3.CustomTag.Environment | An environment custom tag. Only one of environment, literal, requestHeader, or metadata can be set. |
requestHeader |
.solo.io.envoy.type.tracing.v3.CustomTag.Header | A request header custom tag. Only one of requestHeader, literal, environment, or metadata can be set. |
metadata |
.solo.io.envoy.type.tracing.v3.CustomTag.Metadata | A custom tag to obtain tag value from the metadata. Only one of metadata, literal, environment, or requestHeader can be set. |
Literal
Literal type custom tag with static value for the tag value.
"value": string
| Field | Type | Description |
|---|---|---|
value |
string |
Static literal value to populate the tag value. |
Environment
Environment type custom tag with environment name and default value.
"name": string
"defaultValue": string
| Field | Type | Description |
|---|---|---|
name |
string |
Environment variable name to obtain the value to populate the tag value. |
defaultValue |
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. |
Header
Header type custom tag with header name and default value.
"name": string
"defaultValue": string
| Field | Type | Description |
|---|---|---|
name |
string |
Header name to obtain the value to populate the tag value. |
defaultValue |
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. |
Metadata
Metadata type custom tag using
:ref:MetadataKey <envoy_api_msg_type.metadata.v3.MetadataKey> to retrieve the protobuf value
from :ref:Metadata <envoy_api_msg_config.core.v3.Metadata>, and populate the tag value with
the canonical JSON <https://developers.google.com/protocol-buffers/docs/proto3#json>_
representation of it.
"kind": .solo.io.envoy.type.metadata.v3.MetadataKind
"metadataKey": .solo.io.envoy.type.metadata.v3.MetadataKey
"defaultValue": string
| Field | Type | Description |
|---|---|---|
kind |
.solo.io.envoy.type.metadata.v3.MetadataKind | Specify what kind of metadata to obtain tag value from. |
metadataKey |
.solo.io.envoy.type.metadata.v3.MetadataKey | Metadata key to define the path to retrieve the tag value. |
defaultValue |
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. |