/
custom_tag.proto
83 lines (64 loc) · 2.67 KB
/
custom_tag.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
syntax = "proto3";
package envoy.type.tracing.v2;
import "envoy/type/metadata/v2/metadata.proto";
import "validate/validate.proto";
option java_package = "io.envoyproxy.envoy.type.tracing.v2";
option java_outer_classname = "CustomTagProto";
option java_multiple_files = true;
// [#protodoc-title: Custom Tag]
// Describes custom tags for the active span.
// [#next-free-field: 6]
message CustomTag {
// Literal type custom tag with static value for the tag value.
message Literal {
// Static literal value to populate the tag value.
string value = 1 [(validate.rules).string = {min_bytes: 1}];
}
// Environment type custom tag with environment name and default value.
message Environment {
// Environment variable name to obtain the value to populate the tag value.
string name = 1 [(validate.rules).string = {min_bytes: 1}];
// 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.
string default_value = 2;
}
// Header type custom tag with header name and default value.
message Header {
// Header name to obtain the value to populate the tag value.
string name = 1 [(validate.rules).string = {min_bytes: 1}];
// When the header does not exist,
// the tag value will be populated with this default value if specified,
// otherwise no tag will be populated.
string default_value = 2;
}
// 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.
message Metadata {
// Specify what kind of metadata to obtain tag value from.
metadata.v2.MetadataKind kind = 1;
// Metadata key to define the path to retrieve the tag value.
metadata.v2.MetadataKey metadata_key = 2;
// When no valid metadata is found,
// the tag value would be populated with this default value if specified,
// otherwise no tag would be populated.
string default_value = 3;
}
// Used to populate the tag name.
string tag = 1 [(validate.rules).string = {min_bytes: 1}];
// Used to specify what kind of custom tag.
oneof type {
option (validate.required) = true;
// A literal custom tag.
Literal literal = 2;
// An environment custom tag.
Environment environment = 3;
// A request header custom tag.
Header request_header = 4;
// A custom tag to obtain tag value from the metadata.
Metadata metadata = 5;
}
}