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