diff --git a/docs/general-options.asciidoc b/docs/general-options.asciidoc index 5b80774711f..12dfc390b31 100644 --- a/docs/general-options.asciidoc +++ b/docs/general-options.asciidoc @@ -29,26 +29,28 @@ data path. See the <> section for details. The default is `${p ---- [float] -==== `backoff` +==== `backoff` deprecated[5.6.1,Use the option under `paths` instead.] + This option is valid as a global setting under the +{beatname_lc}+ namespace or under `paths`. For a description of this option, see <<{beatname_lc}-backoff,`backoff`>>. [float] -==== `max_backoff` +==== `max_backoff` deprecated[5.6.1,Use the option under `paths` instead.] + This option is valid as a global setting under the +{beatname_lc}+ namespace or under `paths`. For a description of this option, see <<{beatname_lc}-max-backoff,`max_backoff`>>. [float] -==== `seek` +==== `seek` deprecated[5.6.1,Use the option under `paths` instead.] This option is valid as a global setting under the +{beatname_lc}+ namespace or under `paths`. For a description of this option, see <<{beatname_lc}-seek,`seek`>>. [float] -==== `include_matches` +==== `include_matches` deprecated[5.6.1,Use the option under `paths` instead.] This option is valid as a global setting under the +{beatname_lc}+ namespace or under `paths`. For a description of this option, see diff --git a/docs/getting-started.asciidoc b/docs/getting-started.asciidoc index f598948a93e..df2f124555e 100644 --- a/docs/getting-started.asciidoc +++ b/docs/getting-started.asciidoc @@ -6,7 +6,9 @@ include::{libbeat-dir}/docs/shared-getting-started-intro.asciidoc[] * <<{beatname_lc}-installation>> * <<{beatname_lc}-configuration>> * <<{beatname_lc}-template>> +* <> * <<{beatname_lc}-starting>> +* <> * <> [id="{beatname_lc}-installation"] @@ -159,8 +161,15 @@ include::{libbeat-dir}/docs/step-look-at-config.asciidoc[] include::{libbeat-dir}/docs/shared-template-load.asciidoc[] +[[load-kibana-dashboards]] +=== Step 4: Set up the Kibana dashboards + +:requires-sudo: yes +include::../../libbeat/docs/dashboards.asciidoc[] +:requires-sudo!: + [id="{beatname_lc}-starting"] -=== Step 4: Start {beatname_uc} +=== Step 5: Start {beatname_uc} Start {beatname_uc} by issuing the appropriate command for your platform. If you are accessing a secured Elasticsearch cluster, make sure you've configured @@ -193,18 +202,27 @@ in the _Beats Platform Reference_. {beatname_uc} is now ready to send journal events to the defined output. [[view-kibana-dashboards]] -=== Step 5: View your data in Kibana +=== Step 6: View the sample Kibana dashboards + +To make it easier for you to visualize your log data, we have created example +{beatname_uc} dashboards. You loaded the dashboards earlier when you ran the +`setup` command. + +include::../../libbeat/docs/opendashboards.asciidoc[] + +The dashboards are provided as examples. We recommend that you +{kibana-ref}/dashboard.html[customize] them to meet your needs. -There are currently no example dashboards available for {beatname_uc}. +[role="screenshot"] +image:./images/journald-log-data.png[Journald data] -To learn how to view and explore your data, see the -_{kibana-ref}/index.html[{kib} User Guide]_. [NOTE] ===== -By default, the Logs UI in {kib} only shows logs from `filebeat-*` -indexes. To show {beatname_uc} indexes, add the following settings to the {kib} -configuration: +You can also use the {infra-guide}/logs-ui-overview.html[Logs UI] in {kib} to +tail logs in real time. By default, however, the Logs UI only shows logs from +`filebeat-*` indexes. To show {beatname_uc} indexes, add the following settings +to the {kib} configuration: [source,yaml] ---- diff --git a/docs/images/journald-log-data.png b/docs/images/journald-log-data.png new file mode 100644 index 00000000000..9a746e96837 Binary files /dev/null and b/docs/images/journald-log-data.png differ diff --git a/docs/images/kibana-created-indexes.png b/docs/images/kibana-created-indexes.png index ad9c65ae1c7..0906a90e71c 100644 Binary files a/docs/images/kibana-created-indexes.png and b/docs/images/kibana-created-indexes.png differ diff --git a/docs/images/kibana-navigation-vis.png b/docs/images/kibana-navigation-vis.png index 8f7ce06c5cd..881157e7a1b 100644 Binary files a/docs/images/kibana-navigation-vis.png and b/docs/images/kibana-navigation-vis.png differ diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 48194e4607b..c8967c01664 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -17,7 +17,6 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :rpm_os: :linux_os: :docker_platform: -:no_dashboards: include::{libbeat-dir}/docs/shared-beats-attributes.asciidoc[] diff --git a/docs/overview.asciidoc b/docs/overview.asciidoc index 815de9bc8a0..96f7098981b 100644 --- a/docs/overview.asciidoc +++ b/docs/overview.asciidoc @@ -13,3 +13,9 @@ https://www.elastic.co/products/elasticsearch[Elasticsearch] or https://www.elastic.co/products/logstash[Logstash]. include::{libbeat-dir}/docs/shared-libbeat-description.asciidoc[] + +[float] +=== Compatibility + +{beatname_uc} requires systemd v233 or later. Versions prior to systemd v233 +have a defect that prevents {beatname_uc} from reading rotated journals.