NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« Secrets keystore for secure settings Directory layout »

›

APM Server command reference

edit

APM Server command reference

edit

APM Server provides a command-line interface for starting APM Server and performing common tasks, like testing configuration files and loading dashboards (deprecated).

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
APM Server is configured to capture data that requires root access

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

Also see Global flags.

`export` command

edit

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

SYNOPSIS

apm-server 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

Exporting a dashboard allows to store a dashboard on disk in a module and load it automatically. The following command can be used:

apm-server export dashboard --id="dashboard-id" > dashboard.json

The dashboard-id can be found in the Kibana URL. By default export dashboard will write the dashboard to stdout. Above it’s written into dashboard.json so it can later imported again. The file contains the dashboard with all visualizations and searches. The index pattern is removed as it is expected to be loaded separately for APM Server.

The generated dashboard.json file can be copied into the kibana/6/dashboard directory of apm-server and next time apm-server setup dashboards is run the dashboard will be imported.

In case Kibana is not running on localhost:5061 the APM Server configuration under setup.kibana must be adjusted.

template: Exports the index template to stdout. You can specify the --es.version and --index flags to further define what gets exported.

FLAGS

--es.version VERSION: When specified along with template, exports an index template that is compatible with the specified version.
-h, --help: Shows help for the export command.
--index BASE_NAME: When specified along with template, sets the base name to use for the index template. If this flag is not specified, the default base name is apm-server.

Also see Global flags.

EXAMPLES

apm-server export config
apm-server export template --es.version 6.8.11 --index myindexname

`help` command

edit

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

SYNOPSIS

apm-server 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

apm-server help export

`keystore` command

edit

Manages the secrets keystore.

SYNOPSIS

apm-server 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

apm-server keystore create
apm-server keystore add ES_PWD
apm-server keystore remove ES_PWD
apm-server keystore list

see Secrets keystore for more examples.

`run` command

edit

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

SYNOPSIS

apm-server run [FLAGS]

Or:

apm-server [FLAGS]

FLAGS

-N, --N

Disables the publishing of events to the defined output. This option is useful only for testing APM Server.

--cpuprofile FILE

Writes CPU profile data to the specified file. This option is useful for troubleshooting APM Server.

-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 APM Server.

--memprofile FILE

Writes memory profile data to the specified output file. This option is useful for troubleshooting APM Server.

--setup

[6.4.0] Deprecated in 6.4.0.

Loads the initial setup, including Elasticsearch template, Kibana index pattern and Kibana dashboards. If you want to use the command without running APM Server, use the setup command instead.

Also see Global flags.

EXAMPLE

apm-server run -e --setup

Or:

apm-server -e --setup

`setup` command

edit

Sets up the initial environment, including the ES index template and Kibana dashboards (deprecated).

The index template ensures that fields are mapped correctly in Elasticsearch.
The Kibana dashboards make it easier for you to visualize APM Server data in Kibana.

Use this command instead of run --setup when you want to set up the environment without actually running APM Server and ingesting data.

SYNOPSIS

apm-server setup [FLAGS]

FLAGS

--dashboards

[6.4.0] Deprecated in 6.4.0.

Sets up the Kibana dashboards only.

-h, --help

Shows help for the setup command.

--template

Sets up the index template only.

Also see Global flags.

EXAMPLE

apm-server setup --dashboards

`test` command

edit

Tests the configuration.

SYNOPSIS

apm-server test SUBCOMMAND [FLAGS]

SUBCOMMANDS

config: Tests the configuration settings.
output: Tests that APM Server can connect to the output by using the current settings.

FLAGS

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

Also see Global flags.

EXAMPLE

apm-server test config

`version` command

edit

Shows information about the current version.

SYNOPSIS

apm-server version [FLAGS]

FLAGS

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

Also see Global flags.

EXAMPLE

apm-server version

Global flags

edit

These global flags are available whenever you run APM Server.

-E, --E "SETTING_NAME=VALUE"

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

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

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

-c, --c FILE

Specifies the configuration file to use for APM Server. The file you specify here is relative to path.config. If the -c flag is not specified, the default config file, apm-server.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 "publish" displays all the "publish" related messages.

-e, --e

Logs to stderr and disables syslog/file output.

--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 in the Beats Platform Reference for more information.

-v, --v

Logs INFO-level messages.

« Secrets keystore for secure settings Directory layout »

APM Server command reference

APM Server command reference

export command

help command

keystore command

run command

setup command

test command

version command

Global flags

`export` command

`help` command

`keystore` command

`run` command

`setup` command

`test` command

`version` command