Server State¶

admin.v3.ServerInfo¶

Proto representation of the value returned by /server_info, containing server version/server status information.

{
  "version": "...",
  "state": "...",
  "uptime_current_epoch": "{...}",
  "uptime_all_epochs": "{...}",
  "hot_restart_version": "...",
  "command_line_options": "{...}",
  "node": "{...}"
}

version: (string) Server version.

state: (admin.v3.ServerInfo.State) State of the server.

uptime_current_epoch: (Duration) Uptime since current epoch was started.

uptime_all_epochs: (Duration) Uptime since the start of the first epoch.

hot_restart_version: (string) Hot restart version.

command_line_options: (admin.v3.CommandLineOptions) Command line options the server is currently running with.

node: (config.core.v3.Node) Populated node identity of this server.

Enum admin.v3.ServerInfo.State¶

[admin.v3.ServerInfo.State proto]

LIVE: (DEFAULT) ⁣Server is live and serving traffic.

DRAINING: ⁣Server is draining listeners in response to external health checks failing.

PRE_INITIALIZING: ⁣Server has not yet completed cluster manager initialization.

INITIALIZING: ⁣Server is running the cluster manager initialization callbacks (e.g., RDS).

admin.v3.CommandLineOptions¶

[admin.v3.CommandLineOptions proto]

{
  "base_id": "...",
  "use_dynamic_base_id": "...",
  "base_id_path": "...",
  "concurrency": "...",
  "config_path": "...",
  "config_yaml": "...",
  "allow_unknown_static_fields": "...",
  "reject_unknown_dynamic_fields": "...",
  "ignore_unknown_dynamic_fields": "...",
  "admin_address_path": "...",
  "local_address_ip_version": "...",
  "log_level": "...",
  "component_log_level": "...",
  "log_format": "...",
  "log_format_escaped": "...",
  "log_path": "...",
  "service_cluster": "...",
  "service_node": "...",
  "service_zone": "...",
  "file_flush_interval": "{...}",
  "drain_time": "{...}",
  "drain_strategy": "...",
  "parent_shutdown_time": "{...}",
  "mode": "...",
  "disable_hot_restart": "...",
  "enable_mutex_tracing": "...",
  "restart_epoch": "...",
  "cpuset_threads": "...",
  "disabled_extensions": [],
  "bootstrap_version": "...",
  "enable_fine_grain_logging": "...",
  "socket_path": "...",
  "socket_mode": "...",
  "enable_core_dump": "..."
}

base_id: (uint64) See --base-id for details.

use_dynamic_base_id: (bool) See --use-dynamic-base-id for details.

base_id_path: (string) See --base-id-path for details.

concurrency: (uint32) See --concurrency for details.

config_path: (string) See --config-path for details.

config_yaml: (string) See --config-yaml for details.

allow_unknown_static_fields: (bool) See --allow-unknown-static-fields for details.

reject_unknown_dynamic_fields: (bool) See --reject-unknown-dynamic-fields for details.

ignore_unknown_dynamic_fields: (bool) See --ignore-unknown-dynamic-fields for details.

admin_address_path: (string) See --admin-address-path for details.

local_address_ip_version: (admin.v3.CommandLineOptions.IpVersion) See --local-address-ip-version for details.

log_level: (string) See --log-level for details.

component_log_level: (string) See --component-log-level for details.

log_format: (string) See --log-format for details.

log_format_escaped: (bool) See --log-format-escaped for details.

log_path: (string) See --log-path for details.

service_cluster: (string) See --service-cluster for details.

service_node: (string) See --service-node for details.

service_zone: (string) See --service-zone for details.

file_flush_interval: (Duration) See --file-flush-interval-msec for details.

drain_time: (Duration) See --drain-time-s for details.

drain_strategy: (admin.v3.CommandLineOptions.DrainStrategy) See --drain-strategy for details.

parent_shutdown_time: (Duration) See --parent-shutdown-time-s for details.

mode: (admin.v3.CommandLineOptions.Mode) See --mode for details.

disable_hot_restart: (bool) See --disable-hot-restart for details.

enable_mutex_tracing: (bool) See --enable-mutex-tracing for details.

restart_epoch: (uint32) See --restart-epoch for details.

cpuset_threads: (bool) See --cpuset-threads for details.

disabled_extensions: (repeated string) See --disable-extensions for details.

bootstrap_version: (uint32) See --bootstrap-version for details.

enable_fine_grain_logging: (bool) See --enable-fine-grain-logging for details.

socket_path: (string) See --socket-path for details.

socket_mode: (uint32) See --socket-mode for details.

enable_core_dump: (bool) See --enable-core-dump for details.

Enum admin.v3.CommandLineOptions.IpVersion¶

[admin.v3.CommandLineOptions.IpVersion proto]

v4: (DEFAULT) ⁣

v6: ⁣

Enum admin.v3.CommandLineOptions.Mode¶

[admin.v3.CommandLineOptions.Mode proto]

Serve: (DEFAULT) ⁣Validate configs and then serve traffic normally.

Validate: ⁣Validate configs and exit.

InitOnly: ⁣Completely load and initialize the config, and then exit without running the listener loop.

Enum admin.v3.CommandLineOptions.DrainStrategy¶

[admin.v3.CommandLineOptions.DrainStrategy proto]

Gradual: (DEFAULT) ⁣Gradually discourage connections over the course of the drain period.

Immediate: ⁣Discourage all connections for the duration of the drain sequence.