NAME¶

alumet-agent - Alumet standard agent: measure energy and performance metrics

SYNOPSIS¶

alumet-agent [OPTIONS] [COMMAND]

DESCRIPTION¶

Alumet standard agent: measure energy and performance metrics

OPTIONS¶

--config <CONFIG>

Path to the config file

[env: ALUMET_CONFIG=] [default: alumet-config.toml]

--no-default-config

If set, the config file must exist, otherwise the agent will fail to start with an error

--config-override <CONFIG_OVERRIDE>

Config options overrides.

Use dots to separate TOML levels, ex. `plugins.rapl.poll_interval='1ms'`

--plugins <PLUGINS>

List of plugins to enable, separated by commas, ex. `csv,rapl`.

All the other plugins will be disabled.

--max-update-interval <MAX_UPDATE_INTERVAL>

Maximum amount of time between two updates of the sources' commands.

A lower value means that the latency of source commands will be lower, i.e. commands will be applied faster, at the cost of a higher overhead.

--source-channel-size <SOURCE_CHANNEL_SIZE>

How many `MeasurementBuffer`s can be stored in the channel that sources write to.

You may want to increase this if you get "buffer is full" errors, which can happen if you have a large number of sources that flush at the same time.

--normal-worker-threads <NORMAL_WORKER_THREADS>

How many "normal" worker threads to spawn

[env: ALUMET_NORMAL_THREADS=]

--priority-worker-threads <PRIORITY_WORKER_THREADS>

How many "high-priority" worker threads to spawn

[env: ALUMET_PRIORITY_THREADS=]

--output-file <OUTPUT_FILE>

Path to the output file (CSV plugin)

--relay-out <RELAY_OUT>

Address and port of the server to connect to with the relay client (relay-client plugin)

--relay-in <RELAY_IN>

Address and/or port that the relay server should listen to (relay-server plugin)

-h, --help

Print help (see a summary with '-h')

-V, --version

Print version