1syntax = "proto3";
2
3package envoy.admin.v4alpha;
4
5import "envoy/config/core/v4alpha/base.proto";
6
7import "google/protobuf/duration.proto";
8
9import "envoy/annotations/deprecation.proto";
10import "udpa/annotations/status.proto";
11import "udpa/annotations/versioning.proto";
12
13option java_package = "io.envoyproxy.envoy.admin.v4alpha";
14option java_outer_classname = "ServerInfoProto";
15option java_multiple_files = true;
16option (udpa.annotations.file_status).package_version_status = NEXT_MAJOR_VERSION_CANDIDATE;
17
18// [#protodoc-title: Server State]
19
20// Proto representation of the value returned by /server_info, containing
21// server version/server status information.
22// [#next-free-field: 8]
23message ServerInfo {
24 option (udpa.annotations.versioning).previous_message_type = "envoy.admin.v3.ServerInfo";
25
26 enum State {
27 // Server is live and serving traffic.
28 LIVE = 0;
29
30 // Server is draining listeners in response to external health checks failing.
31 DRAINING = 1;
32
33 // Server has not yet completed cluster manager initialization.
34 PRE_INITIALIZING = 2;
35
36 // Server is running the cluster manager initialization callbacks (e.g., RDS).
37 INITIALIZING = 3;
38 }
39
40 // Server version.
41 string version = 1;
42
43 // State of the server.
44 State state = 2;
45
46 // Uptime since current epoch was started.
47 google.protobuf.Duration uptime_current_epoch = 3;
48
49 // Uptime since the start of the first epoch.
50 google.protobuf.Duration uptime_all_epochs = 4;
51
52 // Hot restart version.
53 string hot_restart_version = 5;
54
55 // Command line options the server is currently running with.
56 CommandLineOptions command_line_options = 6;
57
58 // Populated node identity of this server.
59 config.core.v4alpha.Node node = 7;
60}
61
62// [#next-free-field: 37]
63message CommandLineOptions {
64 option (udpa.annotations.versioning).previous_message_type = "envoy.admin.v3.CommandLineOptions";
65
66 enum IpVersion {
67 v4 = 0;
68 v6 = 1;
69 }
70
71 enum Mode {
72 // Validate configs and then serve traffic normally.
73 Serve = 0;
74
75 // Validate configs and exit.
76 Validate = 1;
77
78 // Completely load and initialize the config, and then exit without running the listener loop.
79 InitOnly = 2;
80 }
81
82 enum DrainStrategy {
83 // Gradually discourage connections over the course of the drain period.
84 Gradual = 0;
85
86 // Discourage all connections for the duration of the drain sequence.
87 Immediate = 1;
88 }
89
90 reserved 12, 20, 21;
91
92 reserved "max_stats", "max_obj_name_len";
93
94 // See :option:`--base-id` for details.
95 uint64 base_id = 1;
96
97 // See :option:`--use-dynamic-base-id` for details.
98 bool use_dynamic_base_id = 31;
99
100 // See :option:`--base-id-path` for details.
101 string base_id_path = 32;
102
103 // See :option:`--concurrency` for details.
104 uint32 concurrency = 2;
105
106 // See :option:`--config-path` for details.
107 string config_path = 3;
108
109 // See :option:`--config-yaml` for details.
110 string config_yaml = 4;
111
112 // See :option:`--allow-unknown-static-fields` for details.
113 bool allow_unknown_static_fields = 5;
114
115 // See :option:`--reject-unknown-dynamic-fields` for details.
116 bool reject_unknown_dynamic_fields = 26;
117
118 // See :option:`--ignore-unknown-dynamic-fields` for details.
119 bool ignore_unknown_dynamic_fields = 30;
120
121 // See :option:`--admin-address-path` for details.
122 string admin_address_path = 6;
123
124 // See :option:`--local-address-ip-version` for details.
125 IpVersion local_address_ip_version = 7;
126
127 // See :option:`--log-level` for details.
128 string log_level = 8;
129
130 // See :option:`--component-log-level` for details.
131 string component_log_level = 9;
132
133 // See :option:`--log-format` for details.
134 string log_format = 10;
135
136 // See :option:`--log-format-escaped` for details.
137 bool log_format_escaped = 27;
138
139 // See :option:`--log-path` for details.
140 string log_path = 11;
141
142 // See :option:`--service-cluster` for details.
143 string service_cluster = 13;
144
145 // See :option:`--service-node` for details.
146 string service_node = 14;
147
148 // See :option:`--service-zone` for details.
149 string service_zone = 15;
150
151 // See :option:`--file-flush-interval-msec` for details.
152 google.protobuf.Duration file_flush_interval = 16;
153
154 // See :option:`--drain-time-s` for details.
155 google.protobuf.Duration drain_time = 17;
156
157 // See :option:`--drain-strategy` for details.
158 DrainStrategy drain_strategy = 33;
159
160 // See :option:`--parent-shutdown-time-s` for details.
161 google.protobuf.Duration parent_shutdown_time = 18;
162
163 // See :option:`--mode` for details.
164 Mode mode = 19;
165
166 // See :option:`--disable-hot-restart` for details.
167 bool disable_hot_restart = 22;
168
169 // See :option:`--enable-mutex-tracing` for details.
170 bool enable_mutex_tracing = 23;
171
172 // See :option:`--restart-epoch` for details.
173 uint32 restart_epoch = 24;
174
175 // See :option:`--cpuset-threads` for details.
176 bool cpuset_threads = 25;
177
178 // See :option:`--disable-extensions` for details.
179 repeated string disabled_extensions = 28;
180
181 // See :option:`--bootstrap-version` for details.
182 uint32 bootstrap_version = 29;
183
184 // See :option:`--enable-fine-grain-logging` for details.
185 bool enable_fine_grain_logging = 34;
186
187 // See :option:`--socket-path` for details.
188 string socket_path = 35;
189
190 // See :option:`--socket-mode` for details.
191 uint32 socket_mode = 36;
192}
View as plain text