gazette
Command¶
gazette serve¶
Usage:
gazette [OPTIONS] serve
Serve a Gazette broker with the provided configuration, until signaled to
exit (via SIGTERM). Upon receiving a signal, the broker will seek to discharge
its responsible journals and will exit only when it can safely do so.
Broker:
--broker.zone= Availability zone within which this process is running (default: local) [$BROKER_ZONE]
--broker.id= Unique ID of this process. Auto-generated if not set [$BROKER_ID]
--broker.host= Addressable, advertised hostname or IP of this process. Hostname is used if not set [$BROKER_HOST]
--broker.port= Service port for HTTP and gRPC requests. A random port is used if not set [$BROKER_PORT]
--broker.limit= Maximum number of Journals the broker will allocate (default: 1024) [$BROKER_LIMIT]
--broker.file-root= Local path which roots file:// fragment stores (optional) [$BROKER_FILE_ROOT]
--broker.max-append-rate= Max rate (in bytes-per-sec) that any one journal may be appended to. If zero, there is no max rate (default: 0) [$BROKER_MAX_APPEND_RATE]
--broker.min-append-rate= Min rate (in bytes-per-sec) at which a client may stream Append RPC content. RPCs unable to sustain this rate are aborted (default: 65536)
[$BROKER_MIN_APPEND_RATE]
Etcd:
--etcd.address= Etcd service address endpoint (default: http://localhost:2379) [$ETCD_ADDRESS]
--etcd.lease= Time-to-live of Etcd lease (default: 20s) [$ETCD_LEASE_TTL]
--etcd.prefix= Etcd base prefix for broker state and coordination (default: /gazette/cluster) [$ETCD_PREFIX]
Logging:
--log.level=[info|debug|warn] Logging level (default: info) [$LOG_LEVEL]
--log.format=[json|text|color] Logging output format (default: text) [$LOG_FORMAT]
Help Options:
-h, --help Show this help message
gazette print-config¶
Usage:
gazette [OPTIONS] serve
Serve a Gazette broker with the provided configuration, until signaled to
exit (via SIGTERM). Upon receiving a signal, the broker will seek to discharge
its responsible journals and will exit only when it can safely do so.
Broker:
--broker.zone= Availability zone within which this process is running (default: local) [$BROKER_ZONE]
--broker.id= Unique ID of this process. Auto-generated if not set [$BROKER_ID]
--broker.host= Addressable, advertised hostname or IP of this process. Hostname is used if not set [$BROKER_HOST]
--broker.port= Service port for HTTP and gRPC requests. A random port is used if not set [$BROKER_PORT]
--broker.limit= Maximum number of Journals the broker will allocate (default: 1024) [$BROKER_LIMIT]
--broker.file-root= Local path which roots file:// fragment stores (optional) [$BROKER_FILE_ROOT]
--broker.max-append-rate= Max rate (in bytes-per-sec) that any one journal may be appended to. If zero, there is no max rate (default: 0) [$BROKER_MAX_APPEND_RATE]
--broker.min-append-rate= Min rate (in bytes-per-sec) at which a client may stream Append RPC content. RPCs unable to sustain this rate are aborted (default: 65536)
[$BROKER_MIN_APPEND_RATE]
Etcd:
--etcd.address= Etcd service address endpoint (default: http://localhost:2379) [$ETCD_ADDRESS]
--etcd.lease= Time-to-live of Etcd lease (default: 20s) [$ETCD_LEASE_TTL]
--etcd.prefix= Etcd base prefix for broker state and coordination (default: /gazette/cluster) [$ETCD_PREFIX]
Logging:
--log.level=[info|debug|warn] Logging level (default: info) [$LOG_LEVEL]
--log.format=[json|text|color] Logging output format (default: text) [$LOG_FORMAT]
Help Options:
-h, --help Show this help message