IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Secrets keystore for secure settings Repositories for APT and YUM »

› ›

Metricbeat command reference

edit

Metricbeat command reference

edit

Metricbeat provides a command-line interface for starting Metricbeat and performing common tasks, like testing configuration files and loading dashboards.

The command-line also supports global flags for controlling global behaviors.

Use sudo to run the following commands if:

the config file is owned by root, or
Metricbeat is configured to capture data that requires root access

Some of the features described here require an Elastic license. For more information, see https://www.elastic.co/subscriptions and License Management.

Commands
`export`	Exports the configuration, index template, ILM policy, or a dashboard to stdout.
`help`	Shows help for any command.
`keystore`	Manages the secrets keystore.
`modules`	Manages configured modules.
`run`	Runs Metricbeat. This command is used by default if you start Metricbeat without specifying a command.
`setup`	Sets up the initial environment, including the index template, ILM policy and write alias, and Kibana dashboards (when available).
`test`	Tests the configuration.
`version`	Shows information about the current version.

Also see Global flags.

`export` command

edit

Exports the configuration, index template, ILM policy, or a dashboard to stdout. You can use this command to quickly view your configuration, see the contents of the index template and the ILM policy, or export a dashboard from Kibana.

SYNOPSIS

metricbeat export SUBCOMMAND [FLAGS]

SUBCOMMANDS

config

Exports the current configuration to stdout. If you use the -c flag, this command exports the configuration that’s defined in the specified file.

dashboard

Exports a dashboard. You can use this option to store a dashboard on disk in a module and load it automatically. For example, to export the dashboard to a JSON file, run:

metricbeat export dashboard --id="DASHBOARD_ID" > dashboard.json

To find the DASHBOARD_ID, look at the URL for the dashboard in Kibana. By default, export dashboard writes the dashboard to stdout. The example shows how to write the dashboard to a JSON file so that you can import it later. The JSON file will contain the dashboard with all visualizations and searches. You must load the index pattern separately for Metricbeat.

To load the dashboard, copy the generated dashboard.json file into the kibana/6/dashboard directory of Metricbeat, and run metricbeat setup --dashboards to import the dashboard.

If Kibana is not running on localhost:5061, you must also adjust the Metricbeat configuration under setup.kibana.

template

Exports the index template to stdout. You can specify the --es.version and --index flags to further define what gets exported. Furthermore you can export the template to a file instead of stdout by defining a directory via --dir.

ilm-policy: Exports the index lifecycle management policy to stdout. You can specify the --es.version and a --dir to which the policy should be exported as a file rather than exporting to stdout.

FLAGS

--es.version VERSION: When used with template, exports an index template that is compatible with the specified version. When used with ilm-policy, exports the ILM policy if the specified ES version is enabled for ILM.
-h, --help: Shows help for the export command.
--index BASE_NAME: When used with template, sets the base name to use for the index template. If this flag is not specified, the default base name is metricbeat.
--dir DIRNAME: Define a directory to which the template, pipelines, and ILM policy should be exported to as files instead of printing them to stdout.
--id DASHBOARD_ID: When used with dashboard, specifies the dashboard ID.

Also see Global flags.

EXAMPLES

metricbeat export config
metricbeat export template --es.version 8.12.2 --index myindexname
metricbeat export dashboard --id="a7b35890-8baa-11e8-9676-ef67484126fb" > dashboard.json

`help` command

edit

Shows help for any command. If no command is specified, shows help for the run command.

SYNOPSIS

metricbeat help COMMAND_NAME [FLAGS]

COMMAND_NAME: Specifies the name of the command to show help for.

FLAGS

-h, --help: Shows help for the help command.

Also see Global flags.

EXAMPLE

metricbeat help export

`keystore` command

edit

Manages the secrets keystore.

SYNOPSIS

metricbeat keystore SUBCOMMAND [FLAGS]

SUBCOMMANDS

add KEY: Adds the specified key to the keystore. Use the --force flag to overwrite an existing key. Use the --stdin flag to pass the value through stdin.
create: Creates a keystore to hold secrets. Use the --force flag to overwrite the existing keystore.
list: Lists the keys in the keystore.
remove KEY: Removes the specified key from the keystore.

FLAGS

--force: Valid with the add and create subcommands. When used with add, overwrites the specified key. When used with create, overwrites the keystore.
--stdin: When used with add, uses the stdin as the source of the key’s value.
-h, --help: Shows help for the keystore command.

Also see Global flags.

EXAMPLES

metricbeat keystore create
metricbeat keystore add ES_PWD
metricbeat keystore remove ES_PWD
metricbeat keystore list

See Secrets keystore for more examples.

`modules` command

edit

Manages configured modules. You can use this command to enable and disable specific module configurations defined in the modules.d directory. The changes you make with this command are persisted and used for subsequent runs of Metricbeat.

To see which modules are enabled and disabled, run the list subcommand.

SYNOPSIS

metricbeat modules SUBCOMMAND [FLAGS]

SUBCOMMANDS

disable MODULE_LIST: Disables the modules specified in the space-separated list.
enable MODULE_LIST: Enables the modules specified in the space-separated list.
list: Lists the modules that are currently enabled and disabled.

FLAGS

-h, --help: Shows help for the modules command.

Also see Global flags.

EXAMPLES

metricbeat modules list
metricbeat modules enable apache nginx system

`run` command

edit

Runs Metricbeat. This command is used by default if you start Metricbeat without specifying a command.

SYNOPSIS

metricbeat run [FLAGS]

Or:

metricbeat [FLAGS]

FLAGS

-N, --N: Disables publishing for testing purposes. This option disables all outputs except the File output.
--cpuprofile FILE: Writes CPU profile data to the specified file. This option is useful for troubleshooting Metricbeat.
-h, --help: Shows help for the run command.
--httpprof [HOST]:PORT: Starts an http server for profiling. This option is useful for troubleshooting and profiling Metricbeat.
--memprofile FILE: Writes memory profile data to the specified output file. This option is useful for troubleshooting Metricbeat.
--system.hostfs MOUNT_POINT: Specifies the mount point of the host’s filesystem for use in monitoring a host. This flag is depricated, and an alternate hostfs should be specified via the hostfs module config value.

Also see Global flags.

EXAMPLE

metricbeat run -e

Or:

metricbeat -e

`setup` command

edit

Sets up the initial environment, including the index template, ILM policy and write alias, and Kibana dashboards (when available)

The index template ensures that fields are mapped correctly in Elasticsearch. If index lifecycle management is enabled it also ensures that the defined ILM policy and write alias are connected to the indices matching the index template. The ILM policy takes care of the lifecycle of an index, when to do a rollover, when to move an index from the hot phase to the next phase, etc.
The Kibana dashboards make it easier for you to visualize Metricbeat data in Kibana.

This command sets up the environment without actually running Metricbeat and ingesting data. Specify optional flags to set up a subset of assets.

SYNOPSIS

metricbeat setup [FLAGS]

FLAGS

--dashboards: Sets up the Kibana dashboards (when available). This option loads the dashboards from the Metricbeat package. For more options, such as loading customized dashboards, see Importing Existing Beat Dashboards in the Beats Developer Guide.
-h, --help: Shows help for the setup command.
--index-management: Sets up components related to Elasticsearch index management including template, ILM policy, and write alias (if supported and configured).

Also see Global flags.

EXAMPLES

metricbeat setup --dashboards
metricbeat setup --index-management

`test` command

edit

Tests the configuration.

SYNOPSIS

metricbeat test SUBCOMMAND [FLAGS]

SUBCOMMANDS

config: Tests the configuration settings.
modules [MODULE_NAME] [METRICSET_NAME]: Tests module settings for all configured modules. When you run this command, Metricbeat does a test run that applies the current settings, retrieves the metrics, and shows them as output. To test the settings for a specific module, specify MODULE_NAME. To test the settings for a specific metricset in the module, also specify METRICSET_NAME.
output: Tests that Metricbeat can connect to the output by using the current settings.

FLAGS

-h, --help: Shows help for the test command.

Also see Global flags.

EXAMPLES

metricbeat test config
metricbeat test modules system cpu

`version` command

edit

Shows information about the current version.

SYNOPSIS

metricbeat version [FLAGS]

FLAGS

-h, --help: Shows help for the version command.

Also see Global flags.

EXAMPLE

metricbeat version

Global flags

edit

These global flags are available whenever you run Metricbeat.

-E, --E "SETTING_NAME=VALUE"

Overrides a specific configuration setting. You can specify multiple overrides. For example:

metricbeat -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"

This setting is applied to the currently running Metricbeat process. The Metricbeat configuration file is not changed.

-c, --c FILE

Specifies the configuration file to use for Metricbeat. The file you specify here is relative to path.config. If the -c flag is not specified, the default config file, metricbeat.yml, is used.

-d, --d SELECTORS

Enables debugging for the specified selectors. For the selectors, you can specify a comma-separated list of components, or you can use -d "*" to enable debugging for all components. For example, -d "publisher" displays all the publisher-related messages.

-e, --e

Logs to stderr and disables syslog/file output.

-environment

For logging purposes, specifies the environment that Metricbeat is running in. This setting is used to select a default log output when no log output is configured. Supported values are: systemd, container, macos_service, and windows_service. If systemd or container is specified, Metricbeat will log to stdout and stderr by default.

--path.config

Sets the path for configuration files. See the Directory layout section for details.

--path.data

Sets the path for data files. See the Directory layout section for details.

--path.home

Sets the path for miscellaneous files. See the Directory layout section for details.

--path.logs

Sets the path for log files. See the Directory layout section for details.

--strict.perms

Sets strict permission checking on configuration files. The default is -strict.perms=true. See Config file ownership and permissions for more information.

-v, --v

Logs INFO-level messages.

« Secrets keystore for secure settings Repositories for APT and YUM »

Metricbeat command reference

Metricbeat command reference

export command

help command

keystore command

modules command

run command

setup command

test command

version command

Global flags

`export` command

`help` command

`keystore` command

`modules` command

`run` command

`setup` command

`test` command

`version` command