diff --git a/_meta/beat.yml b/_meta/beat.yml index 5530142f26f..43de767d1e8 100644 --- a/_meta/beat.yml +++ b/_meta/beat.yml @@ -213,115 +213,11 @@ apm-server: #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 -# options here, or by using the `-setup` CLI flag or the `setup` command. -#setup.dashboards.enabled: false - -# The directory from where to read the dashboards. The default is the `kibana` -# folder in the home path. -#setup.dashboards.directory: ${path.home}/kibana - -# The URL from where to download the dashboards archive. It is used instead of -# the directory if it has a value. -#setup.dashboards.url: - -# The file archive (zip file) from where to read the dashboards. It is used instead -# of the directory when it has a value. -#setup.dashboards.file: - -# The name of the Kibana index to use for setting the configuration. Default is ".kibana" -#setup.dashboards.kibana_index: .kibana - -# The Elasticsearch index name. This overwrites the index name defined in the -# dashboards and index pattern. Example: testbeat-* -# The dashboards.index needs to be changed in case the elasticsearch index pattern is modified. -#setup.dashboards.index: - -# Always use the Kibana API for loading the dashboards instead of autodetecting -# how to install the dashboards by first querying Elasticsearch. -#setup.dashboards.always_kibana: false - -# If true and Kibana is not reachable at the time when dashboards are loaded, -# it will retry to reconnect to Kibana instead of exiting with an error. -#setup.dashboards.retry.enabled: false - -# Duration interval between Kibana connection retries. -#setup.dashboards.retry.interval: 1s - -# Maximum number of retries before exiting with an error, 0 for unlimited retrying. -#setup.dashboards.retry.maximum: 0 - - -#============================== Deprecated: 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. - -#setup.kibana: - - # Kibana Host - # Scheme and port can be left out and will be set to the default (http and 5601) - # In case you specify and additional path, the scheme is required: http://localhost:5601/path - # IPv6 addresses should always be defined as: https://[2001:db8::1]:5601 - #host: "localhost:5601" - - # Optional protocol and basic auth credentials. - #protocol: "https" - #username: "elastic" - #password: "changeme" - - # Optional HTTP Path - #path: "" - - # Use SSL settings for HTTPS. Default is false. - #ssl.enabled: false - - # Configure SSL verification mode. If `none` is configured, all server hosts - # and certificates will be accepted. In this mode, SSL based connections are - # susceptible to man-in-the-middle attacks. Use only for testing. Default is - # `full`. - #ssl.verification_mode: full - - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to - # 1.2 are enabled. - #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - - # SSL configuration. By default is off. - # List of root certificates for HTTPS server verifications - #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"] - - # Certificate for SSL client authentication - #ssl.certificate: "/etc/pki/client/cert.pem" - - # Client Certificate Key - #ssl.key: "/etc/pki/client/cert.key" - - # Optional passphrase for decrypting the Certificate Key. - # It is recommended to use the provided keystore instead of entering the passphrase in plain text. - #ssl.key_passphrase: '' - - # Configure cipher suites to be used for SSL connections - #ssl.cipher_suites: [] - - # Configure curve types for ECDHE based cipher suites - #ssl.curve_types: [] - - #============================= Elastic Cloud ================================== # These settings simplify using APM Server with the Elastic Cloud (https://cloud.elastic.co/). -# The cloud.id setting overwrites the `output.elasticsearch.hosts` and -# [deprecated] `setup.kibana.host` options. +# The cloud.id setting overwrites the `output.elasticsearch.hosts` option. # You can find the `cloud.id` in the Elastic Cloud web UI. #cloud.id: @@ -372,12 +268,11 @@ output.elasticsearch: # end with the information of the day they got indexed. # e.g. "apm-6.3.0-transaction-2018.03.20" # - # Be aware that you can only specify one Elasticsearch template and one Kibana Index Pattern, + # Be aware that you can only specify one Elasticsearch template. # In case you modify the index patterns you must also update those configurations accordingly, # as they need to be aligned: # * `setup.template.name` # * `setup.template.pattern` - # * `setup.dashboards.index` #index: "apm-%{[beat.version]}-%{+yyyy.MM.dd}" indices: - index: "apm-%{[beat.version]}-sourcemap" @@ -730,7 +625,7 @@ output.elasticsearch: # The home path for the apm-server installation. This is the default base path # for all other path settings and for miscellaneous files that come with the -# distribution (for example, the sample dashboards). +# distribution. # If not set by a CLI flag or in the configuration file, the default for the # home path is the location of the binary. #path.home: diff --git a/apm-server.docker.yml b/apm-server.docker.yml index d46425cf05a..fe9b28ce60d 100644 --- a/apm-server.docker.yml +++ b/apm-server.docker.yml @@ -213,115 +213,11 @@ apm-server: #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 -# options here, or by using the `-setup` CLI flag or the `setup` command. -#setup.dashboards.enabled: false - -# The directory from where to read the dashboards. The default is the `kibana` -# folder in the home path. -#setup.dashboards.directory: ${path.home}/kibana - -# The URL from where to download the dashboards archive. It is used instead of -# the directory if it has a value. -#setup.dashboards.url: - -# The file archive (zip file) from where to read the dashboards. It is used instead -# of the directory when it has a value. -#setup.dashboards.file: - -# The name of the Kibana index to use for setting the configuration. Default is ".kibana" -#setup.dashboards.kibana_index: .kibana - -# The Elasticsearch index name. This overwrites the index name defined in the -# dashboards and index pattern. Example: testbeat-* -# The dashboards.index needs to be changed in case the elasticsearch index pattern is modified. -#setup.dashboards.index: - -# Always use the Kibana API for loading the dashboards instead of autodetecting -# how to install the dashboards by first querying Elasticsearch. -#setup.dashboards.always_kibana: false - -# If true and Kibana is not reachable at the time when dashboards are loaded, -# it will retry to reconnect to Kibana instead of exiting with an error. -#setup.dashboards.retry.enabled: false - -# Duration interval between Kibana connection retries. -#setup.dashboards.retry.interval: 1s - -# Maximum number of retries before exiting with an error, 0 for unlimited retrying. -#setup.dashboards.retry.maximum: 0 - - -#============================== Deprecated: 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. - -#setup.kibana: - - # Kibana Host - # Scheme and port can be left out and will be set to the default (http and 5601) - # In case you specify and additional path, the scheme is required: http://localhost:5601/path - # IPv6 addresses should always be defined as: https://[2001:db8::1]:5601 - #host: "localhost:5601" - - # Optional protocol and basic auth credentials. - #protocol: "https" - #username: "elastic" - #password: "changeme" - - # Optional HTTP Path - #path: "" - - # Use SSL settings for HTTPS. Default is false. - #ssl.enabled: false - - # Configure SSL verification mode. If `none` is configured, all server hosts - # and certificates will be accepted. In this mode, SSL based connections are - # susceptible to man-in-the-middle attacks. Use only for testing. Default is - # `full`. - #ssl.verification_mode: full - - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to - # 1.2 are enabled. - #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - - # SSL configuration. By default is off. - # List of root certificates for HTTPS server verifications - #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"] - - # Certificate for SSL client authentication - #ssl.certificate: "/etc/pki/client/cert.pem" - - # Client Certificate Key - #ssl.key: "/etc/pki/client/cert.key" - - # Optional passphrase for decrypting the Certificate Key. - # It is recommended to use the provided keystore instead of entering the passphrase in plain text. - #ssl.key_passphrase: '' - - # Configure cipher suites to be used for SSL connections - #ssl.cipher_suites: [] - - # Configure curve types for ECDHE based cipher suites - #ssl.curve_types: [] - - #============================= Elastic Cloud ================================== # These settings simplify using APM Server with the Elastic Cloud (https://cloud.elastic.co/). -# The cloud.id setting overwrites the `output.elasticsearch.hosts` and -# [deprecated] `setup.kibana.host` options. +# The cloud.id setting overwrites the `output.elasticsearch.hosts` option. # You can find the `cloud.id` in the Elastic Cloud web UI. #cloud.id: @@ -368,12 +264,11 @@ output.elasticsearch: # end with the information of the day they got indexed. # e.g. "apm-6.3.0-transaction-2018.03.20" # - # Be aware that you can only specify one Elasticsearch template and one Kibana Index Pattern, - # In case you modify the index patterns you must also update those configurations accordingly, + # Be aware that you can only specify one Elasticsearch template. + # In case you modify the index pattern you must also update those configurations accordingly, # as they need to be aligned: # * `setup.template.name` # * `setup.template.pattern` - # * `setup.dashboards.index` #index: "apm-%{[beat.version]}-%{+yyyy.MM.dd}" indices: - index: "apm-%{[beat.version]}-sourcemap" @@ -726,7 +621,7 @@ output.elasticsearch: # The home path for the apm-server installation. This is the default base path # for all other path settings and for miscellaneous files that come with the -# distribution (for example, the sample dashboards). +# distribution. # If not set by a CLI flag or in the configuration file, the default for the # home path is the location of the binary. #path.home: diff --git a/apm-server.yml b/apm-server.yml index 896de541ab9..ec7d8976259 100644 --- a/apm-server.yml +++ b/apm-server.yml @@ -213,115 +213,11 @@ apm-server: #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 -# options here, or by using the `-setup` CLI flag or the `setup` command. -#setup.dashboards.enabled: false - -# The directory from where to read the dashboards. The default is the `kibana` -# folder in the home path. -#setup.dashboards.directory: ${path.home}/kibana - -# The URL from where to download the dashboards archive. It is used instead of -# the directory if it has a value. -#setup.dashboards.url: - -# The file archive (zip file) from where to read the dashboards. It is used instead -# of the directory when it has a value. -#setup.dashboards.file: - -# The name of the Kibana index to use for setting the configuration. Default is ".kibana" -#setup.dashboards.kibana_index: .kibana - -# The Elasticsearch index name. This overwrites the index name defined in the -# dashboards and index pattern. Example: testbeat-* -# The dashboards.index needs to be changed in case the elasticsearch index pattern is modified. -#setup.dashboards.index: - -# Always use the Kibana API for loading the dashboards instead of autodetecting -# how to install the dashboards by first querying Elasticsearch. -#setup.dashboards.always_kibana: false - -# If true and Kibana is not reachable at the time when dashboards are loaded, -# it will retry to reconnect to Kibana instead of exiting with an error. -#setup.dashboards.retry.enabled: false - -# Duration interval between Kibana connection retries. -#setup.dashboards.retry.interval: 1s - -# Maximum number of retries before exiting with an error, 0 for unlimited retrying. -#setup.dashboards.retry.maximum: 0 - - -#============================== Deprecated: 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. - -#setup.kibana: - - # Kibana Host - # Scheme and port can be left out and will be set to the default (http and 5601) - # In case you specify and additional path, the scheme is required: http://localhost:5601/path - # IPv6 addresses should always be defined as: https://[2001:db8::1]:5601 - #host: "localhost:5601" - - # Optional protocol and basic auth credentials. - #protocol: "https" - #username: "elastic" - #password: "changeme" - - # Optional HTTP Path - #path: "" - - # Use SSL settings for HTTPS. Default is false. - #ssl.enabled: false - - # Configure SSL verification mode. If `none` is configured, all server hosts - # and certificates will be accepted. In this mode, SSL based connections are - # susceptible to man-in-the-middle attacks. Use only for testing. Default is - # `full`. - #ssl.verification_mode: full - - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to - # 1.2 are enabled. - #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - - # SSL configuration. By default is off. - # List of root certificates for HTTPS server verifications - #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"] - - # Certificate for SSL client authentication - #ssl.certificate: "/etc/pki/client/cert.pem" - - # Client Certificate Key - #ssl.key: "/etc/pki/client/cert.key" - - # Optional passphrase for decrypting the Certificate Key. - # It is recommended to use the provided keystore instead of entering the passphrase in plain text. - #ssl.key_passphrase: '' - - # Configure cipher suites to be used for SSL connections - #ssl.cipher_suites: [] - - # Configure curve types for ECDHE based cipher suites - #ssl.curve_types: [] - - #============================= Elastic Cloud ================================== # These settings simplify using APM Server with the Elastic Cloud (https://cloud.elastic.co/). -# The cloud.id setting overwrites the `output.elasticsearch.hosts` and -# [deprecated] `setup.kibana.host` options. +# The cloud.id setting overwrites the `output.elasticsearch.hosts` option. # You can find the `cloud.id` in the Elastic Cloud web UI. #cloud.id: @@ -372,12 +268,11 @@ output.elasticsearch: # end with the information of the day they got indexed. # e.g. "apm-6.3.0-transaction-2018.03.20" # - # Be aware that you can only specify one Elasticsearch template and one Kibana Index Pattern, + # Be aware that you can only specify one Elasticsearch template. # In case you modify the index patterns you must also update those configurations accordingly, # as they need to be aligned: # * `setup.template.name` # * `setup.template.pattern` - # * `setup.dashboards.index` #index: "apm-%{[beat.version]}-%{+yyyy.MM.dd}" indices: - index: "apm-%{[beat.version]}-sourcemap" @@ -730,7 +625,7 @@ output.elasticsearch: # The home path for the apm-server installation. This is the default base path # for all other path settings and for miscellaneous files that come with the -# distribution (for example, the sample dashboards). +# distribution. # If not set by a CLI flag or in the configuration file, the default for the # home path is the location of the binary. #path.home: diff --git a/docs/configuring.asciidoc b/docs/configuring.asciidoc index 84b725a2134..fbdfb184f3f 100644 --- a/docs/configuring.asciidoc +++ b/docs/configuring.asciidoc @@ -11,8 +11,6 @@ include::./copied-from-beats/shared-configuring.asciidoc[] * <> * <> * <> -* <> -* <> * <> * <> * <> @@ -31,10 +29,6 @@ include::./template-config.asciidoc[] include::./copied-from-beats/loggingconfig.asciidoc[] -include::./copied-from-beats/shared-kibana-config.asciidoc[] - -include::./copied-from-beats/dashboardsconfig.asciidoc[] - include::./configuration-rum.asciidoc[] :standalone: diff --git a/docs/copied-from-beats/dashboards.asciidoc b/docs/copied-from-beats/dashboards.asciidoc deleted file mode 100644 index 96bf17b5527..00000000000 --- a/docs/copied-from-beats/dashboards.asciidoc +++ /dev/null @@ -1,188 +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. The command shown here loads the dashboards from the {beatname_uc} -package. For more options, such as loading customized dashboards, see -{beatsdevguide}/import-dashboards.html[Importing Existing Beat Dashboards] in -the _Beats Developer Guide_. -ifndef::only-elasticsearch[] -If you've configured the Logstash output, see -<>. -endif::only-elasticsearch[] - -ifeval::["{requires-sudo}"=="yes"] - -include::../../libbeat/docs/shared-note-sudo.asciidoc[] - -endif::[] - -ifdef::deb_os,rpm_os[] -*deb and rpm:* - -["source","sh",subs="attributes"] ----------------------------------------------------------------------- -{beatname_lc} setup --dashboards ----------------------------------------------------------------------- -endif::deb_os,rpm_os[] - -ifdef::mac_os[] -*mac:* - -["source","sh",subs="attributes"] ----------------------------------------------------------------------- -./{beatname_lc} setup --dashboards ----------------------------------------------------------------------- -endif::mac_os[] - -ifdef::linux_os[] -*linux:* - -["source","sh",subs="attributes"] ----------------------------------------------------------------------- -./{beatname_lc} setup --dashboards ----------------------------------------------------------------------- -endif::linux_os[] - -ifdef::docker_platform[] -*docker:* - -["source","sh",subs="attributes"] ----------------------------------------------------------------------- -docker run --net="host" {dockerimage} setup --dashboards ----------------------------------------------------------------------- -endif::docker_platform[] - -ifdef::win_os[] -ifndef::win_only[] -*win:* -endif::win_only[] - -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 ----------------------------------------------------------------------- -endif::win_os[] - -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::deb_os,rpm_os[] -*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 ----- -endif::deb_os,rpm_os[] - -ifdef::mac_os[] -*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 ----- -endif::mac_os[] - -ifdef::linux_os[] -*linux:* - -["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 ----- -endif::linux_os[] - -ifdef::docker_platform[] -*docker:* - -["source","sh",subs="attributes"] ----- -docker run --net="host" {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 ----- -endif::docker_platform[] - -ifdef::win_os[] -ifndef::win_only[] -*win:* -endif::win_only[] - -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::win_os[] - -endif::only-elasticsearch[] - diff --git a/docs/copied-from-beats/dashboardsconfig.asciidoc b/docs/copied-from-beats/dashboardsconfig.asciidoc deleted file mode 100644 index 83099f84d16..00000000000 --- a/docs/copied-from-beats/dashboardsconfig.asciidoc +++ /dev/null @@ -1,128 +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/dashboardsconfig.asciidoc[] -////////////////////////////////////////////////////////////////////////// - -[[configuration-dashboards]] -== Load the Kibana dashboards -ifdef::deprecate_dashboard_loading[] - -deprecated[{deprecate_dashboard_loading}] - -endif::[] - -{beatname_uc} comes packaged with example Kibana dashboards, visualizations, -and searches for visualizing {beatname_uc} data in Kibana. - -To load the dashboards, you can either enable dashboard loading in the -`setup.dashboards` section of the +{beatname_lc}.yml+ config file, or you can -run the `setup` command. Dashboard loading is disabled by default. - -When dashboard loading is enabled, {beatname_uc} uses the Kibana API to load the -sample dashboards. Dashboard loading is only attempted when {beatname_uc} starts up. -If Kibana is not available at startup, {beatname_uc} will stop with an error. - -To enable dashboard loading, add the following setting to the config file: - -[source,yaml] ------------------------------------------------------------------------------- -setup.dashboards.enabled: true ------------------------------------------------------------------------------- - -[float] -=== Configuration options - -You can specify the following options in the `setup.dashboards` section of the -+{beatname_lc}.yml+ config file: - -[float] -==== `setup.dashboards.enabled` - -If this option is set to true, {beatname_uc} loads the sample Kibana dashboards -from the local `kibana` directory in the home path of the {beatname_uc} installation. - -NOTE: When dashboard loading is enabled, {beatname_uc} overwrites any existing -dashboards that match the names of the dashboards you are loading. This happens -every time {beatname_uc} starts. - -If no other options are set, the dashboard are loaded -from the local `kibana` directory in the home path of the {beatname_uc} installation. -To load dashboards from a different location, you can configure one of the -following options: <>, -<>, or -<>. - -[float] -[[directory-option]] -==== `setup.dashboards.directory` - -The directory that contains the dashboards to load. The default is the `kibana` -folder in the home path. - -[float] -[[url-option]] -==== `setup.dashboards.url` - -The URL to use for downloading the dashboard archive. If this option -is set, {beatname_uc} downloads the dashboard archive from the specified URL -instead of using the local directory. - -[float] -[[file-option]] -==== `setup.dashboards.file` - -The file archive (zip file) that contains the dashboards to load. If this option -is set, {beatname_uc} looks for a dashboard archive in the specified path -instead of using the local directory. - -[float] -==== `setup.dashboards.beat` - -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 -+"{beatname_lc}"+. - -[float] -==== `setup.dashboards.kibana_index` - -The name of the Kibana index to use for setting the configuration. The default -is `".kibana"` - - -[float] -==== `setup.dashboards.index` - -The Elasticsearch index name. This setting overwrites the index name defined -in the dashboards and index pattern. Example: `"testbeat-*"` - -NOTE: This setting only works for Kibana 6.0 and newer. - -[float] -==== `setup.dashboards.always_kibana` - -Force loading of dashboards using the Kibana API without querying Elasticsearch for the version -The default is `false`. - -[float] -==== `setup.dashboards.retry.enabled` - -If this option is set to true, and Kibana is not reachable at the time when dashboards are loaded, - {beatname_uc} will retry to reconnect to Kibana instead of exiting with an error. Disabled by default. - -[float] -==== `setup.dashboards.retry.interval` - -Duration interval between Kibana connection retries. Defaults to 1 second. - -[float] -==== `setup.dashboards.retry.maximum` - -Maximum number of retries before exiting with an error. Set to 0 for unlimited retrying. -Default is unlimited. diff --git a/docs/copied-from-beats/shared-kibana-config.asciidoc b/docs/copied-from-beats/shared-kibana-config.asciidoc deleted file mode 100644 index 0f72529efb8..00000000000 --- a/docs/copied-from-beats/shared-kibana-config.asciidoc +++ /dev/null @@ -1,120 +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/shared-kibana-config.asciidoc[] -////////////////////////////////////////////////////////////////////////// - -[[setup-kibana-endpoint]] -== Set up the Kibana endpoint -ifdef::deprecate_dashboard_loading[] - -deprecated[{deprecate_dashboard_loading}] - -endif::[] - -ifeval::["{beatname_lc}" == "apm-server"] -The Kibana dashboards are loaded into Kibana via the Kibana API. -This requires a Kibana endpoint configuration. -endif::[] - -ifeval::["{beatname_lc}" != "apm-server"] -Starting with {beatname_uc} 6.0.0, the Kibana dashboards are loaded into Kibana -via the Kibana API. This requires a Kibana endpoint configuration. -endif::[] - - -You configure the endpoint in the `setup.kibana` section of the -+{beatname_lc}.yml+ config file. - -Here is an example configuration: - -[source,yaml] ----- -setup.kibana.host: "http://localhost:5601" ----- - -[float] -=== Configuration options - -You can specify the following options in the `setup.kibana` section of the -+{beatname_lc}.yml+ config file: - -[float] -==== `setup.kibana.host` - -The Kibana host where the dashboards will be loaded. The default is -`127.0.0.1:5601`. The value of `host` can be a `URL` or `IP:PORT`. For example: `http://192.15.3.2`, `192:15.3.2:5601` or `http://192.15.3.2:6701/path`. If no -port is specified, `5601` is used. - -NOTE: When a node is defined as an `IP:PORT`, the _scheme_ and _path_ are taken -from the <> and -<> config options. - -IPv6 addresses must be defined using the following format: -`https://[2001:db8::1]:5601`. - -[float] -[[kibana-protocol-option]] -==== `setup.kibana.protocol` - -The name of the protocol Kibana is reachable on. The options are: `http` or -`https`. The default is `http`. However, if you specify a URL for host, the -value of `protocol` is overridden by whatever scheme you specify in the URL. - -Example config: - -[source,yaml] ----- -setup.kibana.host: "192.0.2.255:5601" -setup.kibana.protocol: "http" -setup.kibana.path: /kibana ----- - - -[float] -==== `setup.kibana.username` - -The basic authentication username for connecting to Kibana. If you don't -specify a value for this setting, {beatname_uc} uses the `username` specified -for the Elasticsearch output. - -[float] -==== `setup.kibana.password` - -The basic authentication password for connecting to Kibana. If you don't -specify a value for this setting, {beatname_uc} uses the `password` specified -for the Elasticsearch output. - -[float] -[[kibana-path-option]] -==== `setup.kibana.path` - -An HTTP path prefix that is prepended to the HTTP API calls. This is useful for -the cases where Kibana listens behind an HTTP reverse proxy that exports the API -under a custom prefix. - -[float] -==== `setup.kibana.ssl.enabled` - -Enables {beatname_uc} to use SSL settings when connecting to Kibana via HTTPS. -If you configure {beatname_uc} to connect over HTTPS, this setting defaults to -`true` and {beatname_uc} uses the default SSL settings. - -Example configuration: - -[source,yaml] ----- -setup.kibana.host: "https://192.0.2.255:5601" -setup.kibana.ssl.enabled: true -setup.kibana.ssl.certificate_authorities: ["/etc/pki/root/ca.pem"] -setup.kibana.ssl.certificate: "/etc/pki/client/cert.pem" -setup.kibana.ssl.key: "/etc/pki/client/cert.key ----- - -See <> for more information. - diff --git a/docs/dashboards.asciidoc b/docs/dashboards.asciidoc deleted file mode 100644 index bba9966f6fd..00000000000 --- a/docs/dashboards.asciidoc +++ /dev/null @@ -1,54 +0,0 @@ -[[load-kibana-dashboards]] -=== Dashboards - -From APM Server and Kibana 6.4 on you can load dashboards directly via the -{kibana-ref}/apm-getting-started.html[APM Kibana UI]. - -==== Setup via APM Server - -deprecated[{deprecate_dashboard_loading}] - -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/index.asciidoc b/docs/index.asciidoc index a22088b17b3..b36fe5f8ed2 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -24,6 +24,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :deprecate_dashboard_loading: 6.4.0 :no-processors: :no-indices-rules: +:no_dashboards: :requires-sudo: no :apm-server: :deb_os: diff --git a/docs/redirects.asciidoc b/docs/redirects.asciidoc index a5bf3bda145..237e5ce5d86 100644 --- a/docs/redirects.asciidoc +++ b/docs/redirects.asciidoc @@ -159,6 +159,8 @@ This is no longer helpful. Please see <>. This page has moved. Please see <>. +// V1 intake API + [role="exclude",id="request-too-large"] === HTTP 413: Request body too large @@ -218,3 +220,40 @@ This section has moved. Please see <> for current configurati === Tuning APM Server using both v1 and v2 intake API This section has moved. Please see <> for how to tune APM Server. + +// Dashboards + +[role="exclude",id="load-dashboards-logstash"] +=== Tuning APM Server using both v1 and v2 intake API + +Loading dashboards from APM Server is no longer supported. Please see the {kibana-ref}/xpack-apm.html[Kibana APM UI] documentation. + +[role="exclude",id="url-option"] +=== setup.dashboards.url + +Loading dashboards from APM Server is no longer supported. Please see the {kibana-ref}/xpack-apm.html[Kibana APM UI] documentation. + +[role="exclude",id="file-option"] +=== setup.dashboards.file + +Loading dashboards from APM Server is no longer supported. Please see the {kibana-ref}/xpack-apm.html[Kibana APM UI] documentation. + +[role="exclude",id="setup-kibana-endpoint"] +=== Set up the Kibana endpoint + +Loading dashboards from APM Server is no longer supported. Please see the {kibana-ref}/xpack-apm.html[Kibana APM UI] documentation. + +[role="exclude",id="kibana-protocol-option"] +=== setup.kibana.protocol + +Loading dashboards from APM Server is no longer supported. Please see the {kibana-ref}/xpack-apm.html[Kibana APM UI] documentation. + +[role="exclude",id="kibana-path-option"] +=== setup.kibana.path + +Loading dashboards from APM Server is no longer supported. Please see the {kibana-ref}/xpack-apm.html[Kibana APM UI] documentation. + +[role="exclude",id="load-kibana-dashboards"] +=== Dashboards + +Loading dashboards from APM Server is no longer supported. Please see the {kibana-ref}/xpack-apm.html[Kibana APM UI] documentation. \ No newline at end of file diff --git a/docs/setting-up-and-running.asciidoc b/docs/setting-up-and-running.asciidoc index 483c110ee99..a28e6e5f759 100644 --- a/docs/setting-up-and-running.asciidoc +++ b/docs/setting-up-and-running.asciidoc @@ -63,8 +63,6 @@ See <> for more configuration options. include::./high-availability.asciidoc[] -include::./dashboards.asciidoc[] - include::./copied-from-beats/keystore.asciidoc[] include::./copied-from-beats/command-reference.asciidoc[]