From ddb5458fe7988b2534a03627cac4407267911a5e Mon Sep 17 00:00:00 2001 From: simitt Date: Mon, 16 Jul 2018 14:41:25 +0200 Subject: [PATCH] Docs: deprecate loading dashboards and index pattern. Add deprecation notes to apm-server.yml and docs for loading dashboards and index patterns via Kibana. Add deprecation note for setting up Kibana endpoint as it won't be needed any more. implements #1135 --- _meta/beat.yml | 95 ++++++----- apm-server.yml | 95 ++++++----- docs/configuring.asciidoc | 4 +- .../command-reference.asciidoc | 63 ++++++- docs/copied-from-beats/dashboards.asciidoc | 156 ------------------ .../dashboardsconfig.asciidoc | 2 +- docs/copied-from-beats/outputconfig.asciidoc | 28 +++- .../shared-kibana-config.asciidoc | 2 +- .../shared-ssl-config.asciidoc | 8 + .../shared-template-load.asciidoc | 5 + docs/dashboards.asciidoc | 52 +++++- docs/guide/index.asciidoc | 12 +- docs/index.asciidoc | 1 + docs/setting-up-and-running.asciidoc | 18 -- 14 files changed, 252 insertions(+), 289 deletions(-) delete mode 100644 docs/copied-from-beats/dashboards.asciidoc diff --git a/_meta/beat.yml b/_meta/beat.yml index 032afa5d7da..168737c745f 100644 --- a/_meta/beat.yml +++ b/_meta/beat.yml @@ -141,7 +141,51 @@ setup.template.settings: #number_of_routing_shards: 30 -#============================== Dashboards ===================================== +#============================== Template ===================================== + +# A template is used to set the mapping in Elasticsearch +# By default template loading is enabled and the template is loaded. +# These settings can be adjusted to load your own template or overwrite existing ones. + +# Set to false to disable template loading. +#setup.template.enabled: true + +# Template name. By default the template name is "apm-%{[beat.version]}" +# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +#setup.template.name: "apm-%{[beat.version]}" + +# Template pattern. By default the template pattern is "apm-%{[beat.version]}-*" to apply to the default index settings. +# The first part is the version of the beat and then -* is used to match all daily indices. +# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +#setup.template.pattern: "apm-%{[beat.version]}-*" + +# Path to fields.yml file to generate the template +#setup.template.fields: "${path.config}/fields.yml" + +# Overwrite existing template +#setup.template.overwrite: false + +# Elasticsearch template settings +#setup.template.settings: + + # A dictionary of settings to place into the settings.index dictionary + # of the Elasticsearch template. For more details, please check + # https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html + #index: + #number_of_shards: 1 + #codec: best_compression + #number_of_routing_shards: 30 + + # A dictionary of settings for the _source field. For more details, please check + # https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html + #_source: + #enabled: false + + +#============================== Deprecated: Dashboards ===================================== +# +# Deprecated: Loading dashboards from the APM Server into Kibana is deprecated from 6.4 on. +# We suggest to use the Kibana UI to load APM Server dashboards and index pattern instead. # # These settings control loading the sample dashboards to the Kibana index. Loading # the dashboards are disabled by default and can be enabled either by setting the @@ -183,51 +227,14 @@ setup.template.settings: #setup.dashboards.retry.maximum: 0 -#============================== Template ===================================== - -# A template is used to set the mapping in Elasticsearch -# By default template loading is enabled and the template is loaded. -# These settings can be adjusted to load your own template or overwrite existing ones. +#============================== Deprecated: Kibana ===================================== -# Set to false to disable template loading. -#setup.template.enabled: true - -# Template name. By default the template name is "apm-%{[beat.version]}" -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. -#setup.template.name: "apm-%{[beat.version]}" - -# Template pattern. By default the template pattern is "apm-%{[beat.version]}-*" to apply to the default index settings. -# The first part is the version of the beat and then -* is used to match all daily indices. -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. -#setup.template.pattern: "apm-%{[beat.version]}-*" - -# Path to fields.yml file to generate the template -#setup.template.fields: "${path.config}/fields.yml" - -# Overwrite existing template -#setup.template.overwrite: false - -# Elasticsearch template settings -#setup.template.settings: - - # A dictionary of settings to place into the settings.index dictionary - # of the Elasticsearch template. For more details, please check - # https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html - #index: - #number_of_shards: 1 - #codec: best_compression - #number_of_routing_shards: 30 - - # A dictionary of settings for the _source field. For more details, please check - # https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html - #_source: - #enabled: false - - -#============================== Kibana ===================================== +# Deprecated: Starting with APM Server version 6.4, loading dashboards and index pattern +# from the APM Server into Kibana is deprecated. +# We suggest to use the Kibana UI to load APM Server dashboards and index pattern instead. +# +# Setting up a Kibana endpoint is not necessary when loading the index pattern and dashboards via the UI. -# Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API. -# This requires a Kibana endpoint configuration. #setup.kibana: # Kibana Host diff --git a/apm-server.yml b/apm-server.yml index 8ee7b2c5e7d..5c7f5a4c277 100644 --- a/apm-server.yml +++ b/apm-server.yml @@ -141,7 +141,51 @@ setup.template.settings: #number_of_routing_shards: 30 -#============================== Dashboards ===================================== +#============================== Template ===================================== + +# A template is used to set the mapping in Elasticsearch +# By default template loading is enabled and the template is loaded. +# These settings can be adjusted to load your own template or overwrite existing ones. + +# Set to false to disable template loading. +#setup.template.enabled: true + +# Template name. By default the template name is "apm-%{[beat.version]}" +# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +#setup.template.name: "apm-%{[beat.version]}" + +# Template pattern. By default the template pattern is "apm-%{[beat.version]}-*" to apply to the default index settings. +# The first part is the version of the beat and then -* is used to match all daily indices. +# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +#setup.template.pattern: "apm-%{[beat.version]}-*" + +# Path to fields.yml file to generate the template +#setup.template.fields: "${path.config}/fields.yml" + +# Overwrite existing template +#setup.template.overwrite: false + +# Elasticsearch template settings +#setup.template.settings: + + # A dictionary of settings to place into the settings.index dictionary + # of the Elasticsearch template. For more details, please check + # https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html + #index: + #number_of_shards: 1 + #codec: best_compression + #number_of_routing_shards: 30 + + # A dictionary of settings for the _source field. For more details, please check + # https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html + #_source: + #enabled: false + + +#============================== Deprecated: Dashboards ===================================== +# +# Deprecated: Loading dashboards from the APM Server into Kibana is deprecated from 6.4 on. +# We suggest to use the Kibana UI to load APM Server dashboards and index pattern instead. # # These settings control loading the sample dashboards to the Kibana index. Loading # the dashboards are disabled by default and can be enabled either by setting the @@ -183,51 +227,14 @@ setup.template.settings: #setup.dashboards.retry.maximum: 0 -#============================== Template ===================================== - -# A template is used to set the mapping in Elasticsearch -# By default template loading is enabled and the template is loaded. -# These settings can be adjusted to load your own template or overwrite existing ones. +#============================== Deprecated: Kibana ===================================== -# Set to false to disable template loading. -#setup.template.enabled: true - -# Template name. By default the template name is "apm-%{[beat.version]}" -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. -#setup.template.name: "apm-%{[beat.version]}" - -# Template pattern. By default the template pattern is "apm-%{[beat.version]}-*" to apply to the default index settings. -# The first part is the version of the beat and then -* is used to match all daily indices. -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. -#setup.template.pattern: "apm-%{[beat.version]}-*" - -# Path to fields.yml file to generate the template -#setup.template.fields: "${path.config}/fields.yml" - -# Overwrite existing template -#setup.template.overwrite: false - -# Elasticsearch template settings -#setup.template.settings: - - # A dictionary of settings to place into the settings.index dictionary - # of the Elasticsearch template. For more details, please check - # https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html - #index: - #number_of_shards: 1 - #codec: best_compression - #number_of_routing_shards: 30 - - # A dictionary of settings for the _source field. For more details, please check - # https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html - #_source: - #enabled: false - - -#============================== Kibana ===================================== +# Deprecated: Starting with APM Server version 6.4, loading dashboards and index pattern +# from the APM Server into Kibana is deprecated. +# We suggest to use the Kibana UI to load APM Server dashboards and index pattern instead. +# +# Setting up a Kibana endpoint is not necessary when loading the index pattern and dashboards via the UI. -# Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API. -# This requires a Kibana endpoint configuration. #setup.kibana: # Kibana Host diff --git a/docs/configuring.asciidoc b/docs/configuring.asciidoc index 5fb8f7c6e33..d33a0a3544b 100644 --- a/docs/configuring.asciidoc +++ b/docs/configuring.asciidoc @@ -12,8 +12,8 @@ The following topics describe how to configure APM Server: * <> * <> * <> -* <> -* <> +* <> +* <> * <> * <> * <> diff --git a/docs/copied-from-beats/command-reference.asciidoc b/docs/copied-from-beats/command-reference.asciidoc index 2392ffb5378..0945c3cd003 100644 --- a/docs/copied-from-beats/command-reference.asciidoc +++ b/docs/copied-from-beats/command-reference.asciidoc @@ -20,12 +20,23 @@ :modules-command-short-desc: Manages configured modules :run-command-short-desc: Runs {beatname_uc}. This command is used by default if you start {beatname_uc} without specifying a command +ifndef::deprecate_dashboard_loading[] + ifdef::has_ml_jobs[] :setup-command-short-desc: Sets up the initial environment, including the index template, Kibana dashboards (when available), and machine learning jobs (when available) endif::[] ifndef::has_ml_jobs[] -:setup-command-short-desc: Sets up the initial environment, including the index template, Kibana dashboards (when available) +:setup-command-short-desc: Sets up the initial environment, including the index template and Kibana dashboards (when available) +endif::[] + +endif::[] + +ifdef::deprecate_dashboard_loading[] + +:setup-command-short-desc: Sets up the initial environment, +including the ES index template and Kibana dashboards (deprecated). + endif::[] :test-command-short-desc: Tests the configuration @@ -39,9 +50,17 @@ endif::[] Command reference ++++ +ifndef::deprecate_dashboard_loading[] {beatname_uc} provides a command-line interface for starting {beatname_uc} and -performing common tasks, like testing configuration files and loading -dashboards. The command-line also supports <> +performing common tasks, like testing configuration files and loading dashboards. +endif::[] + +ifdef::deprecate_dashboard_loading[] +{beatname_uc} provides a command-line interface for starting {beatname_uc} and +performing common tasks, like testing configuration files and loading dashboards (deprecated). +endif::[] + +The command-line also supports <> for controlling global behaviors. ifeval::["{beatname_lc}"!="winlogbeat"] @@ -390,9 +409,24 @@ the end of the file is reached. By default harvesters are closed after endif::[] -*`--setup`*:: -Loads the sample Kibana dashboards. If you want to load the dashboards without -running {beatname_uc}, use the <> command instead. +ifndef::deprecate_dashboard_loading[] +*`--setup`*:: +endif::[] + +ifdef::deprecate_dashboard_loading[] +*`--setup (deprecated)`*:: +endif::[] + +ifdef::has_ml_jobs[] +Loads the initial setup, including Elasticsearch template, Kibana index pattern, +Kibana dashboards and Machine learning jobs. +endif::[] + +ifndef::has_ml_jobs[] +Loads the initial setup, including Elasticsearch template, Kibana index pattern and Kibana dashboards. +endif::[] + +If you want to use the command without running {beatname_uc}, use the <> command instead. ifeval::["{beatname_lc}"=="metricbeat"] @@ -434,10 +468,17 @@ Or: {setup-command-short-desc}. * The index template ensures that fields are mapped correctly in Elasticsearch. + * The Kibana dashboards make it easier for you to visualize {beatname_uc} data in Kibana. +ifdef::deprecate_dashboard_loading[] +(deprecated) +endif::[] + +ifdef::has_ml_jobs[] * The machine learning jobs contain the configuration information and metadata necessary to analyze data for anomalies. +endif::[] Use this command instead of `run --setup` when you want to set up the environment without actually running {beatname_uc} and ingesting data. @@ -452,15 +493,25 @@ environment without actually running {beatname_uc} and ingesting data. *FLAGS* +ifndef::deprecate_dashboard_loading[] *`--dashboards`*:: +endif::[] +ifdef::deprecate_dashboard_loading[] +*`--dashboards` (deprecated)*:: +endif::[] + Sets up the Kibana dashboards only. *`-h, --help`*:: Shows help for the `setup` command. +ifdef::has_ml_jobs[] + *`--machine-learning`*:: Sets up machine learning job configurations only. +endif::[] + ifeval::["{beatname_lc}"=="filebeat"] *`--modules MODULE_LIST`*:: diff --git a/docs/copied-from-beats/dashboards.asciidoc b/docs/copied-from-beats/dashboards.asciidoc deleted file mode 100644 index 80d78bfea38..00000000000 --- a/docs/copied-from-beats/dashboards.asciidoc +++ /dev/null @@ -1,156 +0,0 @@ -////////////////////////////////////////////////////////////////////////// -//// This content is shared by all Elastic Beats. Make sure you keep the -//// descriptions here generic enough to work for all Beats that include -//// this file. When using cross references, make sure that the cross -//// references resolve correctly for any files that include this one. -//// Use the appropriate variables defined in the index.asciidoc file to -//// resolve Beat names: beatname_uc and beatname_lc. -//// Use the following include to pull this content into a doc file: -//// include::../../libbeat/docs/dashboards.asciidoc[] -////////////////////////////////////////////////////////////////////////// - -{beatname_uc} comes packaged with example Kibana dashboards, visualizations, -and searches for visualizing {beatname_uc} data in Kibana. Before you can use -the dashboards, you need to create the index pattern, +{beat_default_index_prefix}-*+, and -load the dashboards into Kibana. To do this, you can either run the `setup` -command (as described here) or -<> in the -+{beatname_lc}.yml+ config file. - -This requires a Kibana endpoint configuration. If you didn't already configure -a Kibana endpoint, see <<{beatname_lc}-configuration,configure {beatname_uc}>>. - -Make sure Kibana is running before you perform this step. If you are accessing a -secured Kibana instance, make sure you've configured credentials as described in -<<{beatname_lc}-configuration>>. - -To set up the Kibana dashboards for {beatname_uc}, use the appropriate command -for your system. -ifndef::only-elasticsearch[] -If you've configured the Logstash output, see -<>. -endif::[] - -ifdef::allplatforms[] - -ifeval::["{requires-sudo}"=="yes"] - -include::../../libbeat/docs/shared-note-sudo.asciidoc[] - -endif::[] - -*deb and rpm:* - -["source","sh",subs="attributes"] ----------------------------------------------------------------------- -{beatname_lc} setup --dashboards ----------------------------------------------------------------------- - - -*mac:* - -["source","sh",subs="attributes"] ----------------------------------------------------------------------- -./{beatname_lc} setup --dashboards ----------------------------------------------------------------------- - - -*docker:* - -["source","sh",subs="attributes"] ----------------------------------------------------------------------- -docker run {dockerimage} setup --dashboards ----------------------------------------------------------------------- - -*win:* - -endif::allplatforms[] - -Open a PowerShell prompt as an Administrator (right-click the PowerShell icon -and select *Run As Administrator*). - -From the PowerShell prompt, change to the directory where you installed {beatname_uc}, -and run: - -["source","sh",subs="attributes"] ----------------------------------------------------------------------- -PS > .{backslash}{beatname_lc}.exe setup --dashboards ----------------------------------------------------------------------- - -ifndef::only-elasticsearch[] -[[load-dashboards-logstash]] -==== Set up dashboards for Logstash output - -During dashboard loading, {beatname_uc} connects to Elasticsearch to check -version information. To load dashboards when the Logstash output is enabled, you -need to temporarily disable the Logstash output and enable Elasticsearch. To -connect to a secured Elasticsearch cluster, you also need to pass Elasticsearch -credentials. - -TIP: The example shows a hard-coded password, but you should store sensitive -values in the <>. - -ifdef::allplatforms[] - -*deb and rpm:* - -["source","sh",subs="attributes"] ----- -{beatname_lc} setup -e \ - -E output.logstash.enabled=false \ - -E output.elasticsearch.hosts=['localhost:9200'] \ - -E output.elasticsearch.username={beat_default_index_prefix}_internal \ - -E output.elasticsearch.password={pwd} \ - -E setup.kibana.host=localhost:5601 ----- - - -*mac:* - -["source","sh",subs="attributes"] ----- -./{beatname_lc} setup -e \ - -E output.logstash.enabled=false \ - -E output.elasticsearch.hosts=['localhost:9200'] \ - -E output.elasticsearch.username={beat_default_index_prefix}_internal \ - -E output.elasticsearch.password={pwd} \ - -E setup.kibana.host=localhost:5601 ----- - - -*docker:* - -["source","sh",subs="attributes"] ----- -docker run {dockerimage} setup -e \ - -E output.logstash.enabled=false \ - -E output.elasticsearch.hosts=['localhost:9200'] \ - -E output.elasticsearch.username={beat_default_index_prefix}_internal \ - -E output.elasticsearch.password={pwd} \ - -E setup.kibana.host=localhost:5601 ----- - - -*win:* - -endif::allplatforms[] - -Open a PowerShell prompt as an Administrator (right-click the PowerShell icon -and select *Run As Administrator*). - -From the PowerShell prompt, change to the directory where you installed {beatname_uc}, -and run: - -["source","sh",subs="attributes"] ----- -PS > .{backslash}{beatname_lc}.exe setup -e ` - -E output.logstash.enabled=false ` - -E output.elasticsearch.hosts=['localhost:9200'] ` - -E output.elasticsearch.username={beat_default_index_prefix}_internal ` - -E output.elasticsearch.password={pwd} ` - -E setup.kibana.host=localhost:5601 ----- - - -endif::only-elasticsearch[] - diff --git a/docs/copied-from-beats/dashboardsconfig.asciidoc b/docs/copied-from-beats/dashboardsconfig.asciidoc index fbc9f1a202d..cb0313772e6 100644 --- a/docs/copied-from-beats/dashboardsconfig.asciidoc +++ b/docs/copied-from-beats/dashboardsconfig.asciidoc @@ -10,7 +10,7 @@ ////////////////////////////////////////////////////////////////////////// [[configuration-dashboards]] -== Load the Kibana dashboards +== Load the Kibana dashboards (deprecated) {beatname_uc} comes packaged with example Kibana dashboards, visualizations, and searches for visualizing {beatname_uc} data in Kibana. diff --git a/docs/copied-from-beats/outputconfig.asciidoc b/docs/copied-from-beats/outputconfig.asciidoc index 8eeb5566251..733e581402d 100644 --- a/docs/copied-from-beats/outputconfig.asciidoc +++ b/docs/copied-from-beats/outputconfig.asciidoc @@ -216,10 +216,21 @@ The index name to write events to. The default is +"{beatname_lc}-%\{[beat.version]\}-%\{+yyyy.MM.dd\}"+ (for example, +"{beatname_lc}-{version}-2017.04.26"+). If you change this setting, you also need to configure the `setup.template.name` and `setup.template.pattern` options -(see <>). If you are using the pre-built Kibana -dashboards, you also need to set the `setup.dashboards.index` option (see -<>). +(see <>). +ifndef::deprecate_dashboard_loading[] + +If you are using the pre-built Kibana dashboards, +you also need to set the `setup.dashboards.index` option (see <>). + +endif::[] + +ifdef::deprecate_dashboard_loading[] + +If you are using the pre-built Kibana dashboards, +you also need to set the index pattern properly when loading the dashboards in Kibana. + +endif::[] ===== `indices` @@ -1266,8 +1277,13 @@ overwrites the `output.elasticsearch.hosts` and `setup.kibana.host` settings. ==== `cloud.auth` When specified, the `cloud.auth` overwrites the `output.elasticsearch.username` and -`output.elasticsearch.password` settings. Because the Kibana settings inherit -the username and password from the Elasticsearch output, this can also be used -to set the `setup.kibana.username` and `setup.kibana.password` options. +`output.elasticsearch.password` settings. + +ifndef::deprecate_dashboard_loading[] + +Because the Kibana settings inherit the username and password from the Elasticsearch output, +this can also be used to set the `setup.kibana.username` and `setup.kibana.password` options. + +endif::[] endif::[] diff --git a/docs/copied-from-beats/shared-kibana-config.asciidoc b/docs/copied-from-beats/shared-kibana-config.asciidoc index d373a5bc0b3..b43477aa14e 100644 --- a/docs/copied-from-beats/shared-kibana-config.asciidoc +++ b/docs/copied-from-beats/shared-kibana-config.asciidoc @@ -10,7 +10,7 @@ ////////////////////////////////////////////////////////////////////////// [[setup-kibana-endpoint]] -== Set up the Kibana endpoint +== Set up the Kibana endpoint (deprecated) ifeval::["{beatname_lc}" == "apm-server"] The Kibana dashboards are loaded into Kibana via the Kibana API. diff --git a/docs/copied-from-beats/shared-ssl-config.asciidoc b/docs/copied-from-beats/shared-ssl-config.asciidoc index 407a47fca26..56870223343 100644 --- a/docs/copied-from-beats/shared-ssl-config.asciidoc +++ b/docs/copied-from-beats/shared-ssl-config.asciidoc @@ -4,7 +4,11 @@ You can specify SSL options when you configure: * <> that support SSL + +ifndef::deprecate_dashboard_loading[] * the <> +endif::[] + ifeval::["{beatname_lc}"=="heartbeat"] * <> that support SSL endif::[] @@ -23,6 +27,8 @@ ifndef::only-elasticsearch[] Also see <>. endif::[] +ifndef::deprecate_dashboard_loading[] + Example Kibana endpoint config with SSL enabled: [source,yaml] @@ -35,6 +41,8 @@ setup.kibana.ssl.certificate: "/etc/pki/client/cert.pem" setup.kibana.ssl.key: "/etc/pki/client/cert.key" ---- +endif::[] + ifeval::["{beatname_lc}"=="heartbeat"] Example monitor with SSL enabled: diff --git a/docs/copied-from-beats/shared-template-load.asciidoc b/docs/copied-from-beats/shared-template-load.asciidoc index e3bc17cea90..d97011bc76e 100644 --- a/docs/copied-from-beats/shared-template-load.asciidoc +++ b/docs/copied-from-beats/shared-template-load.asciidoc @@ -101,11 +101,16 @@ setup.template.name: "customname" setup.template.pattern: "customname-*" setup.dashboards.index: "customname-*" <1> ----- + +ifndef::deprecate_dashboard_loading[] + <1> If you plan to <>, also set this option to overwrite the index name defined in the dashboards and index pattern. +endif::[] + See <> for the full list of configuration options. diff --git a/docs/dashboards.asciidoc b/docs/dashboards.asciidoc index cf10ae8f515..ab3e9a73f50 100644 --- a/docs/dashboards.asciidoc +++ b/docs/dashboards.asciidoc @@ -1,5 +1,55 @@ [[load-kibana-dashboards]] === Dashboards +From APM Server and Kibana 6.4 on you can load dashboards directly via the Kibana UI. -include::./copied-from-beats/dashboards.asciidoc[] \ No newline at end of file +NOTE: Loading index pattern and dashboards through the APM Server is deprecated. + It is recommended to use the Kibana UI instead. + If you still want to load the dashboards via the APM Server, + you can do so by following the deprecated instructions: + +==== Deprecated Setup +Loading via APM Server requires a <>. +If you are accessing a secured Kibana instance, make sure you've configured credentials. + +You have to either <> in the ++{beatname_lc}.yml+ config file, +or run the appropriate `setup` command for your system: + +*deb and rpm:* + +["source","sh",subs="attributes"] +---------------------------------------------------------------------- +{beatname_lc} setup --dashboards +---------------------------------------------------------------------- + + +*mac:* + +["source","sh",subs="attributes"] +---------------------------------------------------------------------- +./{beatname_lc} setup --dashboards +---------------------------------------------------------------------- + + +*docker:* + +["source","sh",subs="attributes"] +---------------------------------------------------------------------- +docker run {dockerimage} setup --dashboards +---------------------------------------------------------------------- + +*win:* + +endif::allplatforms[] + +Open a PowerShell prompt as an Administrator (right-click the PowerShell icon +and select *Run As Administrator*). + +From the PowerShell prompt, change to the directory where you installed {beatname_uc}, +and run: + +["source","sh",subs="attributes"] +---------------------------------------------------------------------- +PS > .{backslash}{beatname_lc}.exe setup --dashboards +---------------------------------------------------------------------- diff --git a/docs/guide/index.asciidoc b/docs/guide/index.asciidoc index b9c9b852414..163394fda49 100644 --- a/docs/guide/index.asciidoc +++ b/docs/guide/index.asciidoc @@ -58,7 +58,7 @@ APM Server creates documents from the data received from agents and stores them To visualize the data after it's sent to Elasticsearch, you can use the the dedicated APM UI bundled in X-Pack, -or the pre-built open source Kibana dashboards that come with APM Server. +or the pre-built open source Kibana dashboards that can be loaded directly in the Kibana UI. We designed Elastic APM to run on anything from a regular laptop to thousands of machines, and it's easy to get started. @@ -148,16 +148,8 @@ You can also configure APM Server to listen on a Unix domain socket. [[kibana-dashboards]] [float] ==== Install the Kibana dashboards -APM Server comes with predefined Kibana dashboards and index templates for APM data. -To install those run the following command: - -[source,bash] ----------------------------------- -./apm-server setup ----------------------------------- - -NOTE: Due to a bug in Kibana 6.0.0.-rc2 the dashboards don't work in Kibana 6.0.0-rc2. +From APM Server and Kibana 6.4 on you can load dashboards directly via the Kibana UI. See an example screenshot of a Kibana dashboard: diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 9e0ddc2121f..c92d003b9d1 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -17,6 +17,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :logstashdoc: https://www.elastic.co/guide/en/logstash/{doc-branch} :elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/{doc-branch} :securitydoc: https://www.elastic.co/guide/en/elastic-stack-overview/{doc-branch} +:deprecate_dashboard_loading: true ifdef::env-github[] NOTE: For the best reading experience, diff --git a/docs/setting-up-and-running.asciidoc b/docs/setting-up-and-running.asciidoc index c83a91883cd..994d25b2e84 100644 --- a/docs/setting-up-and-running.asciidoc +++ b/docs/setting-up-and-running.asciidoc @@ -57,24 +57,6 @@ output.elasticsearch: password: "elastic" ---- -If you plan to use the sample Kibana dashboards provided with {beatname_uc}, -configure the Kibana endpoint: - -[source,yaml] ----------------------------------------------------------------------- -setup.kibana: - host: "localhost:5601" ----------------------------------------------------------------------- - --- -Where `host` is the hostname and port of the machine where Kibana is running, -for example, `localhost:5601`. - -NOTE: If you specify a path after the port number, you need to include -the scheme and port: `http://localhost:5601/path`. - --- - See <> for more configuration options.