mirror of
https://github.com/elastic/logstash.git
synced 2025-04-24 06:37:19 -04:00
[DOCS] Updates to index.asciidoc (#7480)
* [DOCS] Updates to index.asciidoc * [DOCS] Split index-shared.asciidoc for re-use * [DOCS] Add path for logstash-docs repo * [DOCS] Merge info about monitoring UI * [DOCS] Added kibana branch attribute * [DOCS] Fix xpack reference links
This commit is contained in:
Lisa Cawley
GitHub
parent
64cdafb7e8
commit
5adf10fae5
5 changed files with 213 additions and 203 deletions
92
docs/index-shared1.asciidoc
Normal file
92
docs/index-shared1.asciidoc
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
|
||||
:branch: master
|
||||
:major-version: 6.x
|
||||
:logstash_version: 6.0.0-alpha3
|
||||
:elasticsearch_version: 6.0.0-alpha3
|
||||
:kibana_version: 6.0.0-alpha3
|
||||
:docker-image: docker.elastic.co/logstash/logstash:{logstash_version}
|
||||
|
||||
//////////
|
||||
release-state can be: released | prerelease | unreleased
|
||||
//////////
|
||||
:release-state: prerelease
|
||||
|
||||
:jdk: 1.8.0
|
||||
:guide: https://www.elastic.co/guide/en/elasticsearch/guide/current/
|
||||
:ref: https://www.elastic.co/guide/en/elasticsearch/reference/current/
|
||||
:xpack-ref: https://www.elastic.co/guide/en/x-pack/current/
|
||||
:kibana-ref: https://www.elastic.co/guide/en/kibana/current/
|
||||
:logstash: https://www.elastic.co/guide/en/logstash/current/
|
||||
:libbeat: https://www.elastic.co/guide/en/beats/libbeat/current/
|
||||
:filebeat: https://www.elastic.co/guide/en/beats/filebeat/current/
|
||||
:metricbeat: https://www.elastic.co/guide/en/beats/metricbeat/current/
|
||||
:lsissue: https://github.com/elastic/logstash/issues/
|
||||
:security: X-Pack security
|
||||
:stack: https://www.elastic.co/guide/en/elastic-stack/current/
|
||||
|
||||
:xpack: X-Pack
|
||||
:es: Elasticsearch
|
||||
:kib: Kibana
|
||||
|
||||
[[introduction]]
|
||||
== Logstash Introduction
|
||||
|
||||
Logstash is an open source data collection engine with real-time pipelining capabilities. Logstash can dynamically
|
||||
unify data from disparate sources and normalize the data into destinations of your choice. Cleanse and democratize all
|
||||
your data for diverse advanced downstream analytics and visualization use cases.
|
||||
|
||||
While Logstash originally drove innovation in log collection, its capabilities extend well beyond that use case. Any
|
||||
type of event can be enriched and transformed with a broad array of input, filter, and output plugins, with many
|
||||
native codecs further simplifying the ingestion process. Logstash accelerates your insights by harnessing a greater
|
||||
volume and variety of data.
|
||||
|
||||
// The pass blocks here point to the correct repository for the edit links in the guide.
|
||||
|
||||
// Introduction
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/introduction.asciidoc
|
||||
include::static/introduction.asciidoc[]
|
||||
|
||||
// Glossary and core concepts go here
|
||||
|
||||
// Getting Started with Logstash
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/getting-started-with-logstash.asciidoc
|
||||
include::static/getting-started-with-logstash.asciidoc[]
|
||||
|
||||
// Advanced LS Pipelines
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/advanced-pipeline.asciidoc
|
||||
include::static/advanced-pipeline.asciidoc[]
|
||||
|
||||
// Processing Pipeline
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/life-of-an-event.asciidoc
|
||||
include::static/life-of-an-event.asciidoc[]
|
||||
|
||||
// Lostash setup
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/setting-up-logstash.asciidoc
|
||||
include::static/setting-up-logstash.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/settings-file.asciidoc
|
||||
include::static/settings-file.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/running-logstash-command-line.asciidoc
|
||||
include::static/running-logstash-command-line.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/running-logstash.asciidoc
|
||||
include::static/running-logstash.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/docker.asciidoc
|
||||
include::static/docker.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/logging.asciidoc
|
||||
include::static/logging.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/persistent-queues.asciidoc
|
||||
include::static/persistent-queues.asciidoc[]
|
||||
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/shutdown.asciidoc
|
||||
include::static/shutdown.asciidoc[]
|
||||
111
docs/index-shared2.asciidoc
Normal file
111
docs/index-shared2.asciidoc
Normal file
|
|
@ -0,0 +1,111 @@
|
|||
|
||||
// Breaking Changes
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/breaking-changes.asciidoc
|
||||
include::static/breaking-changes.asciidoc[]
|
||||
|
||||
// Upgrading Logstash
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/upgrading.asciidoc
|
||||
include::static/upgrading.asciidoc[]
|
||||
|
||||
// Configuring Logstash
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/configuration.asciidoc
|
||||
include::static/configuration.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/multiple-pipelines.asciidoc
|
||||
include::static/multiple-pipelines.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/reloading-config.asciidoc
|
||||
include::static/reloading-config.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/managing-multiline-events.asciidoc
|
||||
include::static/managing-multiline-events.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/glob-support.asciidoc
|
||||
include::static/glob-support.asciidoc[]
|
||||
|
||||
// Working with Filebeat Modules
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/filebeat-modules.asciidoc
|
||||
include::static/filebeat-modules.asciidoc[]
|
||||
|
||||
// Transforming Data
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/transforming-data.asciidoc
|
||||
include::static/transforming-data.asciidoc[]
|
||||
|
||||
// Deploying & Scaling
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/deploying.asciidoc
|
||||
include::static/deploying.asciidoc[]
|
||||
|
||||
// Troubleshooting performance
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/performance-checklist.asciidoc
|
||||
include::static/performance-checklist.asciidoc[]
|
||||
|
||||
// Monitoring overview
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/monitoring.asciidoc
|
||||
include::static/monitoring.asciidoc[]
|
||||
|
||||
// Monitoring APIs
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/monitoring-apis.asciidoc
|
||||
include::static/monitoring-apis.asciidoc[]
|
||||
|
||||
// Working with Plugins
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/plugin-manager.asciidoc
|
||||
include::static/plugin-manager.asciidoc[]
|
||||
|
||||
// These files do their own pass blocks
|
||||
|
||||
include::{plugins-repo-dir}/plugins/inputs.asciidoc[]
|
||||
include::{plugins-repo-dir}/plugins/outputs.asciidoc[]
|
||||
include::{plugins-repo-dir}/plugins/filters.asciidoc[]
|
||||
include::{plugins-repo-dir}/plugins/codecs.asciidoc[]
|
||||
|
||||
:edit_url:
|
||||
|
||||
// Contributing to Logstash
|
||||
|
||||
include::static/contributing-to-logstash.asciidoc[]
|
||||
|
||||
include::static/input.asciidoc[]
|
||||
include::static/codec.asciidoc[]
|
||||
include::static/filter.asciidoc[]
|
||||
include::static/output.asciidoc[]
|
||||
|
||||
// Contributing a Patch to a Logstash Plugin
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/contributing-patch.asciidoc
|
||||
include::static/contributing-patch.asciidoc[]
|
||||
|
||||
// Logstash Community Maintainer Guide
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/maintainer-guide.asciidoc
|
||||
include::static/maintainer-guide.asciidoc[]
|
||||
|
||||
// A space is necessary here ^^^
|
||||
|
||||
|
||||
// Submitting a Plugin
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/submitting-a-plugin.asciidoc
|
||||
include::static/submitting-a-plugin.asciidoc[]
|
||||
|
||||
// Glossary of Terms
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/glossary.asciidoc
|
||||
include::static/glossary.asciidoc[]
|
||||
|
||||
// This is in the pluginbody.asciidoc itself
|
||||
//
|
||||
|
||||
// Release Notes
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/releasenotes.asciidoc
|
||||
include::static/releasenotes.asciidoc[]
|
||||
|
|
@ -1,200 +1,7 @@
|
|||
[[logstash-reference]]
|
||||
= Logstash Reference
|
||||
|
||||
:branch: master
|
||||
:major-version: 6.x
|
||||
:logstash_version: 6.0.0-alpha3
|
||||
:elasticsearch_version: 6.0.0-alpha3
|
||||
:docker-image: docker.elastic.co/logstash/logstash:{logstash_version}
|
||||
|
||||
//////////
|
||||
release-state can be: released | prerelease | unreleased
|
||||
//////////
|
||||
:release-state: prerelease
|
||||
|
||||
:jdk: 1.8.0
|
||||
:guide: https://www.elastic.co/guide/en/elasticsearch/guide/current/
|
||||
:ref: https://www.elastic.co/guide/en/elasticsearch/reference/current/
|
||||
:xpack: https://www.elastic.co/guide/en/x-pack/current
|
||||
:logstash: https://www.elastic.co/guide/en/logstash/current/
|
||||
:libbeat: https://www.elastic.co/guide/en/beats/libbeat/current/
|
||||
:filebeat: https://www.elastic.co/guide/en/beats/filebeat/current/
|
||||
:metricbeat: https://www.elastic.co/guide/en/beats/metricbeat/current/
|
||||
:lsissue: https://github.com/elastic/logstash/issues/
|
||||
:security: X-Pack security
|
||||
:stack: https://www.elastic.co/guide/en/elastic-stack/current/
|
||||
|
||||
[[introduction]]
|
||||
== Logstash Introduction
|
||||
|
||||
Logstash is an open source data collection engine with real-time pipelining capabilities. Logstash can dynamically
|
||||
unify data from disparate sources and normalize the data into destinations of your choice. Cleanse and democratize all
|
||||
your data for diverse advanced downstream analytics and visualization use cases.
|
||||
|
||||
While Logstash originally drove innovation in log collection, its capabilities extend well beyond that use case. Any
|
||||
type of event can be enriched and transformed with a broad array of input, filter, and output plugins, with many
|
||||
native codecs further simplifying the ingestion process. Logstash accelerates your insights by harnessing a greater
|
||||
volume and variety of data.
|
||||
|
||||
// The pass blocks here point to the correct repository for the edit links in the guide.
|
||||
|
||||
// Introduction
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/introduction.asciidoc
|
||||
include::static/introduction.asciidoc[]
|
||||
|
||||
// Glossary and core concepts go here
|
||||
|
||||
// Getting Started with Logstash
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/getting-started-with-logstash.asciidoc
|
||||
include::static/getting-started-with-logstash.asciidoc[]
|
||||
|
||||
// Advanced LS Pipelines
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/advanced-pipeline.asciidoc
|
||||
include::static/advanced-pipeline.asciidoc[]
|
||||
|
||||
// Processing Pipeline
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/life-of-an-event.asciidoc
|
||||
include::static/life-of-an-event.asciidoc[]
|
||||
|
||||
// Lostash setup
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/setting-up-logstash.asciidoc
|
||||
include::static/setting-up-logstash.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/settings-file.asciidoc
|
||||
include::static/settings-file.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/running-logstash-command-line.asciidoc
|
||||
include::static/running-logstash-command-line.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/running-logstash.asciidoc
|
||||
include::static/running-logstash.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/docker.asciidoc
|
||||
include::static/docker.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/logging.asciidoc
|
||||
include::static/logging.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/persistent-queues.asciidoc
|
||||
include::static/persistent-queues.asciidoc[]
|
||||
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/shutdown.asciidoc
|
||||
include::static/shutdown.asciidoc[]
|
||||
|
||||
// Breaking Changes
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/breaking-changes.asciidoc
|
||||
include::static/breaking-changes.asciidoc[]
|
||||
|
||||
// Upgrading Logstash
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/upgrading.asciidoc
|
||||
include::static/upgrading.asciidoc[]
|
||||
|
||||
// Configuring Logstash
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/configuration.asciidoc
|
||||
include::static/configuration.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/multiple-pipelines.asciidoc
|
||||
include::static/multiple-pipelines.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/reloading-config.asciidoc
|
||||
include::static/reloading-config.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/managing-multiline-events.asciidoc
|
||||
include::static/managing-multiline-events.asciidoc[]
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/glob-support.asciidoc
|
||||
include::static/glob-support.asciidoc[]
|
||||
|
||||
// Working with Filebeat Modules
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/filebeat-modules.asciidoc
|
||||
include::static/filebeat-modules.asciidoc[]
|
||||
|
||||
// Transforming Data
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/transforming-data.asciidoc
|
||||
include::static/transforming-data.asciidoc[]
|
||||
|
||||
// Deploying & Scaling
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/deploying.asciidoc
|
||||
include::static/deploying.asciidoc[]
|
||||
|
||||
// Troubleshooting performance
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/performance-checklist.asciidoc
|
||||
include::static/performance-checklist.asciidoc[]
|
||||
|
||||
// Monitoring overview
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/monitoring.asciidoc
|
||||
include::static/monitoring.asciidoc[]
|
||||
|
||||
// Monitoring APIs
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/monitoring-apis.asciidoc
|
||||
include::static/monitoring-apis.asciidoc[]
|
||||
|
||||
// Working with Plugins
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/plugin-manager.asciidoc
|
||||
include::static/plugin-manager.asciidoc[]
|
||||
|
||||
// These files do their own pass blocks
|
||||
|
||||
include::plugins/inputs.asciidoc[]
|
||||
include::plugins/outputs.asciidoc[]
|
||||
include::plugins/filters.asciidoc[]
|
||||
include::plugins/codecs.asciidoc[]
|
||||
|
||||
:edit_url:
|
||||
|
||||
// Contributing to Logstash
|
||||
|
||||
include::static/contributing-to-logstash.asciidoc[]
|
||||
|
||||
include::static/input.asciidoc[]
|
||||
include::static/codec.asciidoc[]
|
||||
include::static/filter.asciidoc[]
|
||||
include::static/output.asciidoc[]
|
||||
|
||||
// Contributing a Patch to a Logstash Plugin
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/contributing-patch.asciidoc
|
||||
include::static/contributing-patch.asciidoc[]
|
||||
|
||||
// Logstash Community Maintainer Guide
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/maintainer-guide.asciidoc
|
||||
include::static/maintainer-guide.asciidoc[]
|
||||
|
||||
// A space is necessary here ^^^
|
||||
|
||||
|
||||
// Submitting a Plugin
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/submitting-a-plugin.asciidoc
|
||||
include::static/submitting-a-plugin.asciidoc[]
|
||||
|
||||
// Glossary of Terms
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/glossary.asciidoc
|
||||
include::static/glossary.asciidoc[]
|
||||
|
||||
// This is in the pluginbody.asciidoc itself
|
||||
//
|
||||
|
||||
// Release Notes
|
||||
|
||||
:edit_url: https://github.com/elastic/logstash/edit/master/docs/static/releasenotes.asciidoc
|
||||
include::static/releasenotes.asciidoc[]
|
||||
:plugins-repo-dir: {docdir}/../../logstash-docs/docs
|
||||
|
||||
include::index-shared1.asciidoc[]
|
||||
include::index-shared2.asciidoc[]
|
||||
|
|
|
|||
8
docs/static/deploying.asciidoc
vendored
8
docs/static/deploying.asciidoc
vendored
|
|
@ -119,12 +119,12 @@ Make sure to check out the other <<filter-plugins,available filter plugins>>.
|
|||
Enterprise-grade security is available across the entire delivery chain.
|
||||
|
||||
* Wire encryption is recommended for both the transport from
|
||||
{filebeat}configuring-ssl-logstash.html[Beats to Logstash] and from
|
||||
{xpack}/logstash.html[Logstash to Elasticsearch].
|
||||
{filebeat}configuring-ssl-logstash.html[Beats to Logstash] and from
|
||||
{xpack-ref}/logstash.html[Logstash to Elasticsearch].
|
||||
* There’s a wealth of security options when communicating with Elasticsearch
|
||||
including basic authentication, TLS, PKI, LDAP, AD, and other custom realms.
|
||||
To enable Elasticsearch security, consult the
|
||||
{xpack}/xpack-security.html[X-Pack documentation].
|
||||
{xpack-ref}/xpack-security.html[X-Pack documentation].
|
||||
|
||||
[float]
|
||||
==== Monitoring
|
||||
|
|
@ -134,7 +134,7 @@ the https://www.elastic.co/products/x-pack/monitoring[Monitoring UI] provides
|
|||
deep visibility into your deployment metrics, helping observe performance and
|
||||
alleviate bottlenecks as you scale. Monitoring is an X-Pack feature under the
|
||||
Basic License and is therefore *free to use*. To get started, consult the
|
||||
{xpack}/monitoring-logstash.html[X-Pack Monitoring documentation].
|
||||
{xpack-ref}/monitoring-logstash.html[X-Pack Monitoring documentation].
|
||||
|
||||
If external monitoring is preferred, there are <<monitoring,Monitoring APIs>>
|
||||
that return point-in-time metrics snapshots.
|
||||
|
|
|
|||
6
docs/static/monitoring.asciidoc
vendored
6
docs/static/monitoring.asciidoc
vendored
|
|
@ -24,7 +24,7 @@ to retrieve these metrics.
|
|||
|
||||
NOTE: Monitoring is an X-Pack feature under the Basic License and is therefore
|
||||
*free to use*. To get started, consult the
|
||||
{xpack}/monitoring-logstash.html[Logstash monitoring documentation].
|
||||
{xpack-ref}/monitoring-logstash.html[Logstash monitoring documentation].
|
||||
|
||||
When running Logstash 5.2 or greater, you can use the
|
||||
https://www.elastic.co/products/x-pack/monitoring[monitoring feature in X-Pack]
|
||||
|
|
@ -34,9 +34,9 @@ info about memory usage and uptime:
|
|||
|
||||
image::static/images/overviewstats.png[Logstash monitoring overview dashboard in Kibana]
|
||||
|
||||
Then you can drill down to see stats about a specific node:
|
||||
Then you can drill down to see stats about a specific node:
|
||||
|
||||
image::static/images/nodestats.png[Logstash monitoring node stats dashboard in Kibana]
|
||||
|
||||
See the {xpack}/monitoring-logstash.html[Logstash monitoring documentation] to learn
|
||||
See the {xpack-ref}/monitoring-logstash.html[Logstash monitoring documentation] to learn
|
||||
how to set up and use this feature.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue