Struct NodeSpecificOpts

pub struct NodeSpecificOpts {
    pub total_memory_bytes: Option<usize>,
    pub parallelism: Option<usize>,
    pub listen_addr: Option<String>,
    pub prometheus_endpoint: Option<String>,
    pub prometheus_selector: Option<String>,
    pub compaction_worker_threads_number: Option<usize>,
}

Node-Specific Options

Which node-specific options should be here?

This only includes the options displayed in the CLI parameters.

1. An option that will be forced to override by single-node deployment should not be here.
   • e.g. meta_addr will be automatically set to localhost.
2. An option defined in the config file and hidden in the command-line help should not be here.
   • e.g. sql_endpoint is encouraged to be set from config file or environment variables.
3. An option that is only for cloud deployment should not be here.
   • e.g. proxy_rpc_endpoint is used in cloud deployment only, and should not be used by open-source users.

How to add an new option here?

Options for the other nodes are defined with following convention:

1. The option name is the same as the definition in node’s Opts struct. May add a prefix to avoid conflicts when necessary.
2. The option doesn’t have a default value and must be Option<T>, so that the default value in the node’s Opts struct can be used.
3. The option doesn’t need to read from environment variables, which will be done in the node’s Opts struct.

Fields

total_memory_bytes: Option<usize>

Total available memory for all the nodes

parallelism: Option<usize>

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

listen_addr: Option<String>

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

prometheus_endpoint: Option<String>

The HTTP REST-API address of the Prometheus instance associated to this cluster. This address is used to serve PromQL queries to Prometheus. It is also used by Grafana Dashboard Service to fetch metrics and visualize them.

prometheus_selector: Option<String>

The additional selector used when querying Prometheus.

The format is same as PromQL. Example: instance="foo",namespace="bar"

compaction_worker_threads_number: Option<usize>

Trait Implementations

impl Args for NodeSpecificOpts

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 NodeSpecificOpts

fn clone(&self) -> NodeSpecificOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for NodeSpecificOpts

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 NodeSpecificOpts

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

Formats the value using the given formatter.

impl FromArgMatches for NodeSpecificOpts

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 Parser for NodeSpecificOpts

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.

impl PartialEq for NodeSpecificOpts

fn eq(&self, other: &NodeSpecificOpts) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NodeSpecificOpts

fn partial_cmp(&self, other: &NodeSpecificOpts) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for NodeSpecificOpts

impl StructuralPartialEq for NodeSpecificOpts