html/server/6.3/configuration-dashboards.html

<!DOCTYPE html>
<html lang="en-us">
  <head>
    
<meta charset="UTF-8">
<title>Load the Kibana dashboards | APM Server Reference [6.3] | Elastic</title>
<meta class="elastic" name="content" content="Load the Kibana dashboards | APM Server Reference [6.3]">

<link rel="home" href="index.html" title="APM Server Reference [6.3]"/>
<link rel="up" href="configuring-howto-apm-server.html" title="Configuring APM Server"/>
<link rel="prev" href="setup-kibana-endpoint.html" title="Set up the Kibana endpoint"/>
<link rel="next" href="configuration-frontend.html" title="Set up Frontend support"/>
<meta class="elastic" name="product_version" content="6.3"/>
<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/6.3"/>
<meta name="DC.subject" content="APM"/>
<meta name="DC.identifier" content="6.3"/>
<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="setup-kibana-endpoint.html">« Set up the Kibana endpoint</a>
</span>
<span class="next">
<a href="configuration-frontend.html">Set up Frontend support »</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="configuring-howto-apm-server.html">Configuring APM Server</a></span>
</div>
<div>
<div><h1 class="title"><a id="id-1"></a>Load the Kibana dashboards</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.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="chapter">
<div class="titlepage"><div><div>
<div class="position-relative"><h2 class="title"><a id="configuration-dashboards"></a>Load the Kibana dashboards</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
</div></div></div>
<p>APM Server comes packaged with example Kibana dashboards, visualizations,
and searches for visualizing APM Server data in Kibana.</p>
<p>To load the dashboards, you can either enable dashboard loading in the
<code class="literal">setup.dashboards</code> section of the <code class="literal">apm-server.yml</code> config file, or you can
run the <code class="literal">setup</code> command. Dashboard loading is disabled by default.</p>
<p>When dashboard loading is enabled, APM Server uses the Kibana API to load the
sample dashboards. Dashboard loading is only attempted when APM Server starts up.
If Kibana is not available at startup, APM Server will stop with an error.</p>
<p>To enable dashboard loading, add the following setting to the config file:</p>
<div class="pre_wrapper lang-yaml">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-yaml">setup.dashboards.enabled: true</pre>
</div>
<div class="position-relative"><h3><a id="_configuration_options_5"></a>Configuration options</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
<p>You can specify the following options in the <code class="literal">setup.dashboards</code> section of the
<code class="literal">apm-server.yml</code> config file:</p>
<div class="position-relative"><h4><a id="_setup_dashboards_enabled"></a><code class="literal">setup.dashboards.enabled</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
<p>If this option is set to true, APM Server loads the sample Kibana dashboards
automatically on startup. If no other options are set, the dashboard are loaded
from the local <code class="literal">kibana</code> directory in the home path of the installation.</p>
<p>To load dashboards from a different location, you can configure one of the
following options: <a class="xref" href="configuration-dashboards.html#directory-option" title="setup.dashboards.directory"><code class="literal">setup.dashboards.directory</code></a>,
<a class="xref" href="configuration-dashboards.html#url-option" title="setup.dashboards.url"><code class="literal">setup.dashboards.url</code></a>, or
<a class="xref" href="configuration-dashboards.html#file-option" title="setup.dashboards.file"><code class="literal">setup.dashboards.file</code></a>.</p>
<div class="position-relative"><h4><a id="directory-option"></a><code class="literal">setup.dashboards.directory</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
<p>The directory that contains the dashboards to load. The default is the <code class="literal">kibana</code>
folder in the home path.</p>
<div class="position-relative"><h4><a id="url-option"></a><code class="literal">setup.dashboards.url</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
<p>The URL to use for downloading the dashboard archive. If this option
is set, APM Server downloads the dashboard archive from the specified URL
instead of using the local directory.</p>
<div class="position-relative"><h4><a id="file-option"></a><code class="literal">setup.dashboards.file</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
<p>The file archive (zip file) that contains the dashboards to load. If this option
is set, APM Server looks for a dashboard archive in the specified path
instead of using the local directory.</p>
<div class="position-relative"><h4><a id="_setup_dashboards_beat"></a><code class="literal">setup.dashboards.beat</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
<p>In case the archive contains the dashboards for multiple Beats, this setting
lets you select the Beat for which you want to load dashboards. To load all the
dashboards in the archive, set this option to an empty string. The default is
<code class="literal">"apm-server"</code>.</p>
<div class="position-relative"><h4><a id="_setup_dashboards_kibana_index"></a><code class="literal">setup.dashboards.kibana_index</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
<p>The name of the Kibana index to use for setting the configuration. The default
is <code class="literal">".kibana"</code></p>
<div class="position-relative"><h4><a id="_setup_dashboards_index"></a><code class="literal">setup.dashboards.index</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
<p>The Elasticsearch index name. This setting overwrites the index name defined
in the dashboards and index pattern. Example: <code class="literal">"testbeat-*"</code></p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>This setting only works for Kibana 6.0 and newer.</p>
</div>
</div>
<div class="position-relative"><h4><a id="_setup_dashboards_always_kibana"></a><code class="literal">setup.dashboards.always_kibana</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
<p>Force loading of dashboards using the Kibana API without querying Elasticsearch for the version
The default is <code class="literal">false</code>.</p>
<div class="position-relative"><h4><a id="_setup_dashboards_retry_enabled"></a><code class="literal">setup.dashboards.retry.enabled</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
<p>If this option is set to true, and Kibana is not reachable at the time when dashboards are loaded,
 APM Server will retry to reconnect to Kibana instead of exiting with an error. Disabled by default.</p>
<div class="position-relative"><h4><a id="_setup_dashboards_retry_interval"></a><code class="literal">setup.dashboards.retry.interval</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
<p>Duration interval between Kibana connection retries. Defaults to 1 second.</p>
<div class="position-relative"><h4><a id="_setup_dashboards_retry_maximum"></a><code class="literal">setup.dashboards.retry.maximum</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/dashboardsconfig.asciidoc">edit</a></div>
<p>Maximum number of retries before exiting with an error. Set to 0 for unlimited retrying.
Default is unlimited.</p>
</div>
</div>
</div><div class="navfooter">
<span class="prev">
<a href="setup-kibana-endpoint.html">« Set up the Kibana endpoint</a>
</span>
<span class="next">
<a href="configuration-frontend.html">Set up Frontend support »</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>