html/server/7.2/command-line-options.html

<!DOCTYPE html>
<html lang="en-us">
  <head>
    
<meta charset="UTF-8">
<title>APM Server command reference | APM Server Reference [7.2] | Elastic</title>
<meta class="elastic" name="content" content="APM Server command reference | APM Server Reference [7.2]">

<link rel="home" href="index.html" title="APM Server Reference [7.2]"/>
<link rel="up" href="setting-up-and-running.html" title="Setting up APM Server"/>
<link rel="prev" href="keystore.html" title="Secrets keystore for secure settings"/>
<link rel="next" href="high-availability.html" title="High Availability"/>
<meta class="elastic" name="product_version" content="7.2"/>
<meta class="elastic" name="product_name" content="APM"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/APM Server/Reference/7.2"/>
<meta name="DC.subject" content="APM"/>
<meta name="DC.identifier" content="7.2"/>
<meta name="robots" content="noindex,nofollow"/>

    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="https://cdn.optimizely.com/js/18132920325.js"></script>
    <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
    <link rel="manifest" href="/manifest.json">
    <meta name="apple-mobile-web-app-title" content="Elastic">
    <meta name="application-name" content="Elastic">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd" />
    <meta name="yandex-verification" content="d8a47e95d0972434" />
    <meta name="localized" content="true" />
    <meta name="st:robots" content="follow,index" />
    <meta property="og:image" content="https://static-www.elastic.co/v3/assets/bltefdd0b53724fa2ce/blt280217a63b82a734/6202d3378b1f312528798412/elastic-logo.svg" />
    <meta property="og:image:width" content="500" />
    <meta property="og:image:height" content="172" />
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
    <link rel="icon" href="/favicon.ico" type="image/x-icon">
    <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
    <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
    <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="/guide/static/styles-v1.css" />
  </head>

  <!--© 2015-2025 Elasticsearch B.V. -->
  <!-- All Elastic documentation is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. -->
  <!-- http://creativecommons.org/licenses/by-nc-nd/4.0/ -->

  <body>
    <!-- Google Tag Manager -->
    <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
    <!-- End Google Tag Manager -->

    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-12395217-16');
    </script>

    <!-- Google Tag Manager for GA4 -->
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KNJMG2M');</script>
    <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KNJMG2M" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <!-- End Google Tag Manager for GA4-->

    <div id='elastic-nav' style="display:none;"></div>
    <script src='https://www.elastic.co/elastic-nav.js'></script>

    <div class="main-container">
      <section id="content" >
        <div class="content-wrapper">

          <section id="guide" lang="en">
            <div class="container-fluid">
              <div class="row pb-3">
                <div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
                  <!-- The TOC is appended here -->
                </div>

                <div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
                  <!-- start body -->
                  
<div class="page_header">
A newer version is available. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div class="navheader">
<span class="prev">
<a href="keystore.html">« Secrets keystore for secure settings</a>
</span>
<span class="next">
<a href="high-availability.html">High Availability »</a>
</span>
</div>
<div class="book" lang="en">
<div class="titlepage">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link">
  <div id="related-products" class="dropdown">
  <div class="related-products-title">APM:</div>
  <div class="dropdown-anchor" tabindex="0">Server Reference<span class="dropdown-icon"></span></div>
  <div class="dropdown-content">
  <ul>
  <li class="dropdown-category">APM</li>
  <ul>
  <li><a href="/guide/en/observability/current/apm.html">Observability › APM</a></li>
  </ul>
  <li class="dropdown-category">APM agents</li>
  <ul>
  <li><a href="/guide/en/apm/agent/android/current/intro.html">Android Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/go/current/introduction.html">Go Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/swift/current/intro.html">iOS Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/java/current/intro.html">Java Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/dotnet/current/intro.html">.NET Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/nodejs/current/intro.html">Node.js Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/php/current/intro.html">PHP Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/python/current/getting-started.html">Python Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/ruby/current/introduction.html">Ruby Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/rum-js/current/intro.html">Real User Monitoring JavaScript Agent Reference</a></li>
  </ul>
  <li class="dropdown-category">APM extensions</li>
  <ul>
  <li><a href="/guide/en/apm/lambda/current/aws-lambda-arch.html">AWS Lambda extension</a></li>
  <li><a href="/guide/en/apm/attacher/current/apm-attacher.html">Attacher</a></li>
  </ul>
  </ul>
  </div>
  </div>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="setting-up-and-running.html">Setting up APM Server</a></span>
</div>
<div>
<div><h1 class="title"><a id="id-1"></a>APM Server command reference</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div>
<!--EXTRA-->
</div>
<div id="content">
<div id="url-to-v3" class="version-warning">
    <strong>IMPORTANT</strong>: This documentation is no longer updated. Refer to <a href="https://www.elastic.co/support/eol">Elastic's version policy</a> and the <a href="https://www.elastic.co/docs">latest documentation</a>.
</div>
<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h2 class="title"><a id="command-line-options"></a>APM Server command reference</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>

<p>APM Server provides a command-line interface for starting APM Server and
performing common tasks, like testing configuration files.</p>
<p>The command-line also supports <a class="xref" href="command-line-options.html#global-flags" title="Global flags">global flags</a>
for controlling global behaviors.</p>
<div class="tip admon">
<div class="icon"></div>
<div class="admon_content">
<p>Use <code class="literal">sudo</code> to run the following commands if:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
the config file is owned by <code class="literal">root</code>, or
</li>
<li class="listitem">
APM Server is configured to capture data that requires <code class="literal">root</code> access
</li>
</ul>
</div>
</div>
</div>
<div class="informaltable">
<table border="1" cellpadding="4px">
<colgroup>
<col class="col_1"/>
<col class="col_2"/>
</colgroup>
<thead>
<tr>
<th align="left" valign="top">Commands</th>
<th align="left" valign="top"></th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p><a class="xref" href="command-line-options.html#export-command" title="export command"><code class="literal">export</code></a></p></td>
<td align="left" valign="top"><p>Exports the configuration, index template, or ilm-policy to stdout.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="command-line-options.html#help-command" title="help command"><code class="literal">help</code></a></p></td>
<td align="left" valign="top"><p>Shows help for any command.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="command-line-options.html#keystore-command" title="keystore command"><code class="literal">keystore</code></a></p></td>
<td align="left" valign="top"><p>Manages the <a class="xref" href="keystore.html" title="Secrets keystore for secure settings">secrets keystore</a>.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="command-line-options.html#run-command" title="run command"><code class="literal">run</code></a></p></td>
<td align="left" valign="top"><p>Runs APM Server. This command is used by default if you start APM Server without specifying a command.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="command-line-options.html#setup-command" title="setup command"><code class="literal">setup</code></a></p></td>
<td align="left" valign="top"><p>Sets up the initial environment, including the ES index template, ilm policy and write alias.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="command-line-options.html#test-command" title="test command"><code class="literal">test</code></a></p></td>
<td align="left" valign="top"><p>Tests the configuration.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="command-line-options.html#version-command" title="version command"><code class="literal">version</code></a></p></td>
<td align="left" valign="top"><p>Shows information about the current version.</p></td>
</tr>
</tbody>
</table>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="export-command"></a><code class="literal">export</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Exports the configuration, index template, or ilm-policy to stdout. You can use this
command to quickly view your configuration or see the contents of the index
template or the ilm policy.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server export SUBCOMMAND [FLAGS]</pre>
</div>
<p><span class="strong strong"><strong>SUBCOMMANDS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">config</code></strong></span>
</span>
</dt>
<dd>
Exports the current configuration to stdout. If you use the <code class="literal">-c</code> flag, this
command exports the configuration that&#8217;s defined in the specified file.
</dd>
<dt>
<span class="term">
<a id="template-subcommand"></a><span class="strong strong"><strong><code class="literal">template</code></strong></span>
</span>
</dt>
<dd>
Exports the index template to stdout. You can specify the <code class="literal">--es.version</code> and
<code class="literal">--index</code> flags to further define what gets exported. Furthermore you can export
the template to a file instead of <code class="literal">stdout</code> by defining a directory via <code class="literal">--dir</code>.
</dd>
</dl>
</div>
<div class="variablelist">
<a id="ilm-policy-subcommand"></a>
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">ilm-policy</code></strong></span>
</span>
</dt>
<dd>
Exports ILM policy to stdout. You can specify the <code class="literal">--es.version</code> and a <code class="literal">--dir</code>
to which the policy should be exported as a file rather than exporting to <code class="literal">stdout</code>.
</dd>
</dl>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--es.version VERSION</code></strong></span>
</span>
</dt>
<dd>
When used with <a class="xref" href="command-line-options.html#template-subcommand"><code class="literal">template</code></a>, exports an index
template that is compatible with the specified version.
When used with <a class="xref" href="command-line-options.html#ilm-policy-subcommand"><code class="literal">ilm-policy</code></a>, exports the ilm policy
if the specified ES version is enabled for ILM.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">export</code> command.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--index BASE_NAME</code></strong></span>
</span>
</dt>
<dd>
When used with <a class="xref" href="command-line-options.html#template-subcommand"><code class="literal">template</code></a>, sets the base name to use for
the index template. If this flag is not specified, the default base name is
<code class="literal">apm-server</code>.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--dir DIRNAME</code></strong></span>
</span>
</dt>
<dd>
Define a directory to which the template and ilm-policy should be exported to
as files instead of printing them to <code class="literal">stdout</code>.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLES</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server export config
apm-server export template --es.version 7.2.1 --index myindexname</pre>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="help-command"></a><code class="literal">help</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Shows help for any command. If no command is specified, shows help for the
<code class="literal">run</code> command.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server help COMMAND_NAME [FLAGS]</pre>
</div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">COMMAND_NAME</code></strong></span>
</span>
</dt>
<dd>
Specifies the name of the command to show help for.
</dd>
</dl>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">help</code> command.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLE</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server help export</pre>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="keystore-command"></a><code class="literal">keystore</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Manages the <a class="xref" href="keystore.html" title="Secrets keystore for secure settings">secrets keystore</a>.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server keystore SUBCOMMAND [FLAGS]</pre>
</div>
<p><span class="strong strong"><strong>SUBCOMMANDS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">add KEY</code></strong></span>
</span>
</dt>
<dd>
Adds the specified key to the keystore. Use the <code class="literal">--force</code> flag to overwrite an
existing key. Use the <code class="literal">--stdin</code> flag to pass the value through <code class="literal">stdin</code>.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">create</code></strong></span>
</span>
</dt>
<dd>
Creates a keystore to hold secrets. Use the <code class="literal">--force</code> flag to overwrite the
existing keystore.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">list</code></strong></span>
</span>
</dt>
<dd>
Lists the keys in the keystore.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">remove KEY</code></strong></span>
</span>
</dt>
<dd>
Removes the specified key from the keystore.
</dd>
</dl>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--force</code></strong></span>
</span>
</dt>
<dd>
Valid with the <code class="literal">add</code> and <code class="literal">create</code> subcommands. When used with <code class="literal">add</code>, overwrites
the specified key. When used with <code class="literal">create</code>, overwrites the keystore.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--stdin</code></strong></span>
</span>
</dt>
<dd>
When used with <code class="literal">add</code>, uses the stdin as the source of the key&#8217;s value.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">keystore</code> command.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLES</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server keystore create
apm-server keystore add ES_PWD
apm-server keystore remove ES_PWD
apm-server keystore list</pre>
</div>
<p>See <a class="xref" href="keystore.html" title="Secrets keystore for secure settings">Secrets keystore</a> for more examples.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="run-command"></a><code class="literal">run</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Runs APM Server. This command is used by default if you start APM Server without specifying a command.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server run [FLAGS]</pre>
</div>
<p>Or:</p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server [FLAGS]</pre>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-N, --N</code></strong></span>
</span>
</dt>
<dd>
Disables publishing for testing purposes.
This option disables all outputs except the <a class="xref" href="file-output.html" title="Configure the File output">File output</a>.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--cpuprofile FILE</code></strong></span>
</span>
</dt>
<dd>
Writes CPU profile data to the specified file. This option is useful for
troubleshooting APM Server.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">run</code> command.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--httpprof [HOST]:PORT</code></strong></span>
</span>
</dt>
<dd>
Starts an http server for profiling. This option is useful for troubleshooting
and profiling APM Server.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--memprofile FILE</code></strong></span>
</span>
</dt>
<dd>
Writes memory profile data to the specified output file. This option is useful
for troubleshooting APM Server.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLE</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server run -e</pre>
</div>
<p>Or:</p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server -e</pre>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="setup-command"></a><code class="literal">setup</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Sets up the initial environment, including the ES index template, ilm policy and write alias</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
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.
</li>
</ul>
</div>
<p>This command sets up the environment without actually running
APM Server and ingesting data.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<p>tag::setup-command-tag[]</p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server setup [FLAGS]</pre>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">setup</code> command.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--index-management</code></strong></span>
</span>
</dt>
<dd>
Sets up components related to Elasticsearch index management including
template, ilm policy, and write alias.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--pipelines</code></strong></span>
</span>
</dt>
<dd>
Registers the <a class="xref" href="configuring-ingest-node.html" title="Parse data using ingest node pipelines">pipeline</a> definitions set in <code class="literal">ingest/pipeline/definition.json</code>.
end::apm-server[]
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--template</code></strong></span>
</span>
</dt>
<dd>
<span class="Admonishment Admonishment--change">
[<span class="Admonishment-version u-mono u-strikethrough">7.2</span>]
<span class="Admonishment-detail">
Deprecated in 7.2.
</span>
</span>
Sets up the index template only.
It is recommended to use <code class="literal">--index-management</code> instead.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--ilm-policy</code></strong></span>
</span>
</dt>
<dd>
<span class="Admonishment Admonishment--change">
[<span class="Admonishment-version u-mono u-strikethrough">7.2</span>]
<span class="Admonishment-detail">
Deprecated in 7.2.
</span>
</span>
Sets up the index lifecycle policy.
It is recommended to use <code class="literal">--index-management</code> instead.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLES</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server setup --index-management
apm-server setup --pipelines</pre>
</div>
<p>end::setup-command-tag[]</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="test-command"></a><code class="literal">test</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Tests the configuration.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server test SUBCOMMAND [FLAGS]</pre>
</div>
<p><span class="strong strong"><strong>SUBCOMMANDS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">config</code></strong></span>
</span>
</dt>
<dd>
Tests the configuration settings.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">output</code></strong></span>
</span>
</dt>
<dd>
Tests that APM Server can connect to the output by using the
current settings.
</dd>
</dl>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">test</code> command.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLE</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server test config</pre>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="version-command"></a><code class="literal">version</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Shows information about the current version.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server version [FLAGS]</pre>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">version</code> command.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLE</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server version</pre>
</div>
<div class="position-relative"><h3><a id="global-flags"></a>Global flags</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
<p>These global flags are available whenever you run APM Server.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-E, --E "SETTING_NAME=VALUE"</code></strong></span>
</span>
</dt>
<dd>
<p>
Overrides a specific configuration setting. You can specify multiple overrides.
For example:
</p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"</pre>
</div>
<p>This setting is applied to the currently running APM Server process.
The APM Server configuration file is not changed.</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-c, --c FILE</code></strong></span>
</span>
</dt>
<dd>
Specifies the configuration file to use for APM Server. The file you specify
here is relative to <code class="literal">path.config</code>. If the <code class="literal">-c</code> flag is not specified, the
default config file, <code class="literal">apm-server.yml</code>, is used.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-d, --d SELECTORS</code></strong></span>
</span>
</dt>
<dd>
Enables debugging for the specified selectors. For the selectors, you can
specify a comma-separated
list of components, or you can use <code class="literal">-d "*"</code> to enable debugging for all
components. For example, <code class="literal">-d "publish"</code> displays all the "publish" related
messages.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-e, --e</code></strong></span>
</span>
</dt>
<dd>
Logs to stderr and disables syslog/file output.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--path.config</code></strong></span>
</span>
</dt>
<dd>
Sets the path for configuration files. See the <a class="xref" href="directory-layout.html" title="Directory layout">Directory layout</a> section for
details.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--path.data</code></strong></span>
</span>
</dt>
<dd>
Sets the path for data files. See the <a class="xref" href="directory-layout.html" title="Directory layout">Directory layout</a> section for details.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--path.home</code></strong></span>
</span>
</dt>
<dd>
Sets the path for miscellaneous files. See the <a class="xref" href="directory-layout.html" title="Directory layout">Directory layout</a> section for
details.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--path.logs</code></strong></span>
</span>
</dt>
<dd>
Sets the path for log files. See the <a class="xref" href="directory-layout.html" title="Directory layout">Directory layout</a> section for details.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--strict.perms</code></strong></span>
</span>
</dt>
<dd>
Sets strict permission checking on configuration files. The default is
<code class="literal">-strict.perms=true</code>. See
<a href="/guide/en/beats/libbeat/7.2/config-file-permissions.html" class="ulink" target="_top">Config file ownership and permissions</a> in
the <em>Beats Platform Reference</em> for more information.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-v, --v</code></strong></span>
</span>
</dt>
<dd>
Logs INFO-level messages.
</dd>
</dl>
</div>
</div>

</div>
</div>
</div><div class="navfooter">
<span class="prev">
<a href="keystore.html">« Secrets keystore for secure settings</a>
</span>
<span class="next">
<a href="high-availability.html">High Availability »</a>
</span>
</div>

                  <!-- end body -->
                </div>

                <div class="col-12 order-3 col-lg-2 order-lg-3 h-almost-full-lg sticky-top-lg" id="right_col">
                  <div id="sticky_content">
                    <!-- The OTP is appended here -->
                    <div class="row">
                      <div class="col-0 col-md-4 col-lg-0" id="bottom_left_col"></div>
                      <div class="col-12 col-md-8 col-lg-12">
                        <div id="rtpcontainer">
                          <div class="mktg-promo" id="most-popular">
                            <p class="aside-heading">Most Popular</p>
                            <div class="pb-2">
                              <p class="media-type">Video</p>
                              <a href="https://www.elastic.co/webinars/getting-started-elasticsearch?page=docs&placement=top-video">
                                <p class="mb-0">Get Started with Elasticsearch</p>
                              </a>
                            </div>
                            <div class="pb-2">
                              <p class="media-type">Video</p>
                              <a href="https://www.elastic.co/webinars/getting-started-kibana?page=docs&placement=top-video">
                                <p class="mb-0">Intro to Kibana</p>
                              </a>
                            </div>
                            <div class="pb-2">
                              <p class="media-type">Video</p>
                              <a href="https://www.elastic.co/webinars/introduction-elk-stack?page=docs&placement=top-video">
                                <p class="mb-0">ELK for Logs & Metrics</p>
                              </a>
                            </div>
                          </div>
                        </div>

                        <!-- Feedback widget -->
                        <div id="feedbackWidgetContainer"></div>
                      </div>
                    </div>
                  </div>
                </div>
              </div>
            </div>
          </section>

        </div>


        <div id='elastic-footer'></div>
        <script src='https://www.elastic.co/elastic-footer.js'></script>
        <!-- Footer Section end-->

      </section>
    </div>

    <!-- Feedback modal -->
    <div id="feedbackModalContainer"></div>

    <script src="/guide/static/jquery.js"></script>
    <script type="text/javascript" src="/guide/static/docs-v1.js"></script>
    <script type="text/javascript">
  window.initial_state = {}</script>
  </body>
</html>