Struct CompactorOpts

pub struct CompactorOpts {

    pub listen_addr: String,
    pub advertise_addr: Option<String>,
    pub port: Option<u16>,
    pub prometheus_listener_addr: String,
    pub meta_address: MetaAddressStrategy,
    pub compaction_worker_threads_number: Option<usize>,
    pub config_path: String,
    pub metrics_level: Option<MetricLevel>,
    pub async_stack_trace: Option<AsyncStackTraceOption>,
    pub heap_profiling_dir: Option<String>,
    pub compactor_mode: Option<CompactorMode>,
    pub proxy_rpc_endpoint: String,
    pub compactor_total_memory_bytes: usize,
    pub compactor_meta_cache_memory_bytes: usize,
}

Command-line arguments for compactor-node.

Fields

listen_addr: String

The address that this service listens to. Usually the localhost + desired port.

advertise_addr: Option<String>

The address for contacting this instance of the service. This would be synonymous with the service’s “public address” or “identifying address”. Optional, we will use listen_addr if not specified.

port: Option<u16>

prometheus_listener_addr: String

We will start a http server at this address via MetricsManager. Then the prometheus instance will poll the metrics from this address.

meta_address: MetaAddressStrategy

compaction_worker_threads_number: Option<usize>

config_path: String

The path of risingwave.toml configuration file.

If empty, default configuration values will be used.

metrics_level: Option<MetricLevel>

Used for control the metrics level, similar to log level.

async_stack_trace: Option<AsyncStackTraceOption>

Enable async stack tracing through await-tree for risectl.

heap_profiling_dir: Option<String>

Enable heap profile dump when memory usage is high.

compactor_mode: Option<CompactorMode>

proxy_rpc_endpoint: String

compactor_total_memory_bytes: usize

Total available memory for the frontend node in bytes. Used by compactor.

compactor_meta_cache_memory_bytes: usize

Trait Implementations

impl Args for CompactorOpts

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

impl Clone for CompactorOpts

fn clone(&self) -> CompactorOpts

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for CompactorOpts

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for CompactorOpts

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for CompactorOpts

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Opts for CompactorOpts

fn name() -> &'static str

The name of the component.

fn meta_addr(&self) -> MetaAddressStrategy

The address to the meta node.

impl OverrideConfig for CompactorOpts

fn override(&self, config: &mut RwConfig)

impl Parser for CompactorOpts

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.