APM Server commandsedit

APM Server provides a command-line interface for starting APM Server and performing common tasks, like testing configuration files and loading dashboards. The command-line also supports global flags for controlling global behaviors.

Tip

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

export

Exports the configuration or index template to stdout.

help

Shows help for any command.

run

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

setup

test

Tests the configuration.

version

Shows information about the current version.

Also see Global flags.

export commandedit

Exports the configuration or index template to stdout. You can use this command to quickly view your configuration or the contents of the index template.

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.
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.2.1 --index myindexname

help commandedit

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

run commandedit

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
Loads the sample Kibana dashboards. If you want to load the dashboards 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 commandedit

  • 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
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 commandedit

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 commandedit

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 flagsedit

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.