Struct ComputeNodeOpts

pub struct ComputeNodeOpts {

    pub listen_addr: String,
    pub advertise_addr: Option<String>,
    pub prometheus_listener_addr: String,
    pub meta_address: MetaAddressStrategy,
    pub config_path: String,
    pub total_memory_bytes: usize,
    pub reserved_memory_bytes: Option<usize>,
    pub memory_manager_target_bytes: Option<usize>,
    pub parallelism: usize,
    pub resource_group: String,
    pub role: Role,
    pub metrics_level: Option<MetricLevel>,
    pub data_file_cache_dir: Option<String>,
    pub meta_file_cache_dir: Option<String>,
    pub async_stack_trace: Option<AsyncStackTraceOption>,
    pub heap_profiling_dir: Option<String>,
    pub connector_rpc_endpoint: Option<String>,
    pub temp_secret_file_dir: String,
}

Command-line arguments for compute-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.

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

config_path: String

The path of risingwave.toml configuration file.

If empty, default configuration values will be used.

total_memory_bytes: usize

Total available memory for the compute node in bytes. Used by both computing and storage.

reserved_memory_bytes: Option<usize>

Reserved memory for the compute node in bytes. If not set, a portion (default to 30% for the first 16GB and 20% for the rest) for the total_memory_bytes will be used as the reserved memory.

The total memory compute and storage can use is total_memory_bytes - reserved_memory_bytes.

memory_manager_target_bytes: Option<usize>

Target memory usage for Memory Manager. If not set, the default value is total_memory_bytes - reserved_memory_bytes

It’s strongly recommended to set it for standalone deployment.

Why need this?

Our crate::memory::manager::MemoryManager works by reading the memory statistics from Jemalloc. This is fine when running the compute node alone; while for standalone mode, the memory usage of all nodes are counted. Thus, we need to pass a reasonable total usage so that the memory is kept around this value.

parallelism: usize

The parallelism that the compute node will register to the scheduler of the meta service.

resource_group: String

Resource group for scheduling, default value is “default”

role: Role

Decides whether the compute node can be used for streaming and serving.

metrics_level: Option<MetricLevel>

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

level = 0: disable metrics level > 0: enable metrics

data_file_cache_dir: Option<String>

Path to data file cache data directory. Left empty to disable file cache.

meta_file_cache_dir: Option<String>

Path to meta file cache data directory. Left empty to disable file cache.

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.

connector_rpc_endpoint: Option<String>

👎Deprecated: connector node has been deprecated.

Endpoint of the connector node.

temp_secret_file_dir: String

The path of the temp secret file directory.

Trait Implementations

impl Args for ComputeNodeOpts

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 ComputeNodeOpts

fn clone(&self) -> ComputeNodeOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for ComputeNodeOpts

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 ComputeNodeOpts

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

Formats the value using the given formatter.

impl FromArgMatches for ComputeNodeOpts

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 ComputeNodeOpts

fn name() -> &'static str

The name of the component.

fn meta_addr(&self) -> MetaAddressStrategy

The address to the meta node.

impl OverrideConfig for ComputeNodeOpts

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

impl Parser for ComputeNodeOpts

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.