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

« Set up APM Server Secrets keystore for secure settings »

›

Directory layout

edit

Directory layout

edit

This method of installing APM Server will be deprecated and removed in a future release. Please consider getting started with the Elastic APM integration instead.

The directory layout of an installation is as follows:

Type	Description	Default Location	Config Option
home	Home of the APM Server installation.		`path.home`
bin	The location for the binary files.	`{path.home}/bin`
config	The location for configuration files.	`{path.home}`	`path.config`
data	The location for persistent data files.	`{path.home}/data`	`path.data`
logs	The location for the logs created by APM Server.	`{path.home}/logs`	`path.logs`

You can change these settings by using CLI flags or setting path options in the configuration file.

Default paths

edit

APM Server uses the following default paths unless you explicitly change them.

deb and rpm

edit

Type	Description	Location
home	Home of the APM Server installation.	`/usr/share/apm-server`
bin	The location for the binary files.	`/usr/share/apm-server/bin`
config	The location for configuration files.	`/etc/apm-server`
data	The location for persistent data files.	`/var/lib/apm-server`
logs	The location for the logs created by APM Server.	`/var/log/apm-server`

For the deb and rpm distributions, these paths are set in the init script or in the systemd unit file. Make sure that you start the APM Server service by using the preferred operating system method (init scripts or systemctl). Otherwise the paths might be set incorrectly.

docker

edit

Type	Description	Location
home	Home of the APM Server installation.	`/usr/share/apm-server`
bin	The location for the binary files.	`/usr/share/apm-server`
config	The location for configuration files.	`/usr/share/apm-server`
data	The location for persistent data files.	`/usr/share/apm-server/data`
logs	The location for the logs created by APM Server.	`/usr/share/apm-server/logs`

zip, tar.gz, or tgz

edit

Type	Description	Location
home	Home of the APM Server installation.	`{extract.path}`
bin	The location for the binary files.	`{extract.path}`
config	The location for configuration files.	`{extract.path}`
data	The location for persistent data files.	`{extract.path}/data`
logs	The location for the logs created by APM Server.	`{extract.path}/logs`

For the zip, tar.gz, or tgz distributions, these paths are based on the location of the extracted binary file. This means that if you start APM Server with the following simple command, all paths are set correctly:

./apm-server

brew

edit

Type	Description	Location
home	Home of the APM Server installation.	`/usr/local/var/homebrew/linked/apm-server-full`
bin	The location for the binary files.	`/usr/local/var/homebrew/linked/apm-server-full/bin`
config	The location for configuration files.	`/usr/local/etc/apm-server`
data	The location for persistent data files.	`/usr/local/var/lib/apm-server`
logs	The location for the logs created by APM Server.	`/usr/local/var/log/apm-server`

« Set up APM Server Secrets keystore for secure settings »