diff --git a/filebeat/docs/running-on-kubernetes.asciidoc b/filebeat/docs/running-on-kubernetes.asciidoc index b19ebe0b3c2..d7d92650032 100644 --- a/filebeat/docs/running-on-kubernetes.asciidoc +++ b/filebeat/docs/running-on-kubernetes.asciidoc @@ -97,6 +97,28 @@ oc patch namespace kube-system -p \ This command sets the node selector for the project to an empty string. If you don't run this command, the default node selector will skip master nodes. +[float] +==== Load {kib} dashboards + +{beatname_uc} comes packaged with various pre-built {kib} dashboards +that you can use to visualize logs from your Kubernetes environment. + +If these dashboards are not already loaded into {kib}, you must <<{beatname_lc}-installation-configuration,install {beatname_uc}>> +on any system that can connect to the {stack}, and then run the `setup` command to load the dashboards. +To learn how, see <>. + +The `setup` command does not load the ingest pipelines used to parse log lines. By default, ingest pipelines +are set up automatically the first time you run {beatname_uc} and connect to {es}. + +[IMPORTANT] +======================================= +If you are using a different output other than {es}, such as {ls}, you +need to: + +* <> +* <> +* <> +======================================= [float] ==== Deploy diff --git a/libbeat/docs/howto/load-dashboards.asciidoc b/libbeat/docs/howto/load-dashboards.asciidoc index c03b512d636..2b70e48e3ff 100644 --- a/libbeat/docs/howto/load-dashboards.asciidoc +++ b/libbeat/docs/howto/load-dashboards.asciidoc @@ -15,98 +15,44 @@ ifdef::has_solutions[] TIP: For deeper observability into your infrastructure, you can use the {metrics-app} and the {logs-app} in {kib}. -For more details, see {observability-guide}/analyze-metrics.html[Analyze metrics] -and {observability-guide}/monitor-logs.html[Monitor logs]. +For more details, see {observability-guide}/analyze-metrics.html[Metrics monitoring] +and {observability-guide}/monitor-logs.html[Log monitoring]. endif::has_solutions[] {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` +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 ++{beatname_lc}.yml+ config file. This requires a Kibana endpoint configuration. If you didn't already configure a Kibana endpoint, see <>. +[float] +[[load-dashboards]] +=== Load dashboards + 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 the <<{beatname_lc}-installation-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::no-output-logstash[] -If you've configured the Logstash output, see -<>. -endif::[] +To load the recommended index template for writing to {es} and deploy the sample dashboards +for visualizing the data in {kib}, use the command that works with your system. ifdef::requires-sudo[] include::{libbeat-dir}/shared-note-sudo.asciidoc[] endif::requires-sudo[] -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 ----------------------------------------------------------------------- - -*brew:* - -["source","sh",subs="attributes"] ----------------------------------------------------------------------- -{beatname_lc} setup --dashboards ----------------------------------------------------------------------- -endif::mac_os[] +include::{libbeat-dir}/tab-widgets/load-dashboards-widget.asciidoc[] -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[] +For more options, such as loading customized dashboards, see +{beatsdevguide}/import-dashboards.html[Importing Existing Beat Dashboards]. +ifndef::no-output-logstash[] +If you've configured the Logstash output, see +<>. +endif::[] ifndef::no-output-logstash[] [float] @@ -128,95 +74,9 @@ ifdef::serverless[] in environment variables. endif::[] -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 ----- - -*brew:* - -["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::no-output-logstash[] +include::{libbeat-dir}/tab-widgets/load-dashboards-logstash-widget.asciidoc[] + +// Add Javascript and CSS for tabbed panels +include::{libbeat-dir}/tab-widgets/code.asciidoc[] diff --git a/libbeat/docs/shared-cloudfoundry.asciidoc b/libbeat/docs/shared-cloudfoundry.asciidoc index 1219a6312bc..ad75a2ba310 100644 --- a/libbeat/docs/shared-cloudfoundry.asciidoc +++ b/libbeat/docs/shared-cloudfoundry.asciidoc @@ -53,6 +53,35 @@ curl -L -O https://raw.githubusercontent.com/elastic/beats/{branch}/deploy/cloud You need to modify the +{beatname_lc}.yml+ file to set the `api_address`, `client_id` and `client_secret`. +==== Load {kib} dashboards + +{beatname_uc} comes packaged with various pre-built {kib} dashboards +that you can use to visualize data in {kib}. + +If these dashboards are not already loaded into {kib}, you must run the {beatname_uc} `setup` command. +To learn how, see <>. + +ifeval::["{beatname_lc}"=="metricbeat"] +[IMPORTANT] +======================================= +If you are using a different output other than {es}, such as {ls}, you +need to <> and <>. +======================================= +endif::[] +ifeval::["{beatname_lc}"=="filebeat"] +The `setup` command does not load the ingest pipelines used to parse log lines. By default, ingest pipelines +are set up automatically the first time you run {beatname_uc} and connect to {es}. + +[IMPORTANT] +======================================= +If you are using a different output other than {es}, such as {ls}, you +need to: + +* <> +* <> +* <> +======================================= +endif::[] ==== Deploy {beatname_uc} diff --git a/libbeat/docs/tab-widgets/load-dashboards-logstash-widget.asciidoc b/libbeat/docs/tab-widgets/load-dashboards-logstash-widget.asciidoc new file mode 100644 index 00000000000..899775edccd --- /dev/null +++ b/libbeat/docs/tab-widgets/load-dashboards-logstash-widget.asciidoc @@ -0,0 +1,130 @@ +++++ +
+
+ + + + + + + +
+
+++++ + +include::load-dashboards-logstash.asciidoc[tag=deb] + +++++ +
+ + + + + + +
+++++ \ No newline at end of file diff --git a/libbeat/docs/tab-widgets/load-dashboards-logstash.asciidoc b/libbeat/docs/tab-widgets/load-dashboards-logstash.asciidoc new file mode 100644 index 00000000000..c49aefcfa19 --- /dev/null +++ b/libbeat/docs/tab-widgets/load-dashboards-logstash.asciidoc @@ -0,0 +1,88 @@ +// tag::deb[] +["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 +---- +// end::deb[] + +// tag::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 +---- +// end::rpm[] + +// tag::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 +---- +// end::mac[] + +// tag::brew[] +["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 +---- +// end::brew[] + +// tag::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 +---- +// end::linux[] + +// tag::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 +---- +// end::docker[] + +// tag::win[] + +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 +---- +// end::win[] \ No newline at end of file diff --git a/libbeat/docs/tab-widgets/load-dashboards-widget.asciidoc b/libbeat/docs/tab-widgets/load-dashboards-widget.asciidoc new file mode 100644 index 00000000000..52d191b66a6 --- /dev/null +++ b/libbeat/docs/tab-widgets/load-dashboards-widget.asciidoc @@ -0,0 +1,130 @@ +++++ +
+
+ + + + + + + +
+
+++++ + +include::load-dashboards.asciidoc[tag=deb] + +++++ +
+ + + + + + +
+++++ \ No newline at end of file diff --git a/libbeat/docs/tab-widgets/load-dashboards.asciidoc b/libbeat/docs/tab-widgets/load-dashboards.asciidoc new file mode 100644 index 00000000000..6f93e08aa3b --- /dev/null +++ b/libbeat/docs/tab-widgets/load-dashboards.asciidoc @@ -0,0 +1,55 @@ +// tag::deb[] +["source","sh",subs="attributes"] +---- +{beatname_lc} setup --dashboards +---- +// end::deb[] + +// tag::rpm[] +["source","sh",subs="attributes"] +---- +{beatname_lc} setup --dashboards +---- +// end::rpm[] + +// tag::mac[] +["source","sh",subs="attributes"] +---- +./{beatname_lc} setup --dashboards +---- +// end::mac[] + +// tag::brew[] +["source","sh",subs="attributes"] +---- +{beatname_lc} setup --dashboards +---- +// end::brew[] + +// tag::linux[] +["source","sh",subs="attributes"] +---- +./{beatname_lc} setup --dashboards +---- +// end::linux[] + +// tag::docker[] +["source","sh",subs="attributes"] +---- +docker run --net="host" {dockerimage} setup --dashboards +---- +// end::docker[] + +// tag::win[] + +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 +---- +// end::win[] \ No newline at end of file diff --git a/metricbeat/docs/running-on-kubernetes.asciidoc b/metricbeat/docs/running-on-kubernetes.asciidoc index 024c3132287..c70cb129638 100644 --- a/metricbeat/docs/running-on-kubernetes.asciidoc +++ b/metricbeat/docs/running-on-kubernetes.asciidoc @@ -154,6 +154,22 @@ oc patch namespace kube-system -p \ This command sets the node selector for the project to an empty string. If you don't run this command, the default node selector will skip master nodes. +[float] +==== Load {kib} dashboards + +{beatname_uc} comes packaged with various pre-built {kib} dashboards +that you can use to visualize metrics about your Kubernetes environment. + +If these dashboards are not already loaded into {kib}, you must <<{beatname_lc}-installation-configuration,install {beatname_uc}>> +on any system that can connect to the {stack}, and then run the `setup` command to load the dashboards. To learn how, +see <>. + +[IMPORTANT] +======================================= +If you are using a different output other than {es}, such as {ls}, you +need to <> and <>. +======================================= + [float] ==== Deploy