mirror of
https://github.com/elastic/logstash.git
synced 2025-04-24 22:57:16 -04:00
[DOCS] Add shared index for doc builds (#7510)
This commit is contained in:
Lisa Cawley
lcawley
parent
4c75aaca0d
commit
d201b3e82b
2 changed files with 188 additions and 179 deletions
186
docs/index-shared1.asciidoc
Normal file
186
docs/index-shared1.asciidoc
Normal file
|
|
@ -0,0 +1,186 @@
|
||||||
|
:branch: 5.3
|
||||||
|
:major-version: 5.x
|
||||||
|
:logstash_version: 5.3.3
|
||||||
|
:elasticsearch_version: 5.3.3
|
||||||
|
:kibana_version: 5.3.3
|
||||||
|
:docker-image: docker.elastic.co/logstash/logstash:{logstash_version}
|
||||||
|
|
||||||
|
//////////
|
||||||
|
release-state can be: released | prerelease | unreleased
|
||||||
|
//////////
|
||||||
|
:release-state: released
|
||||||
|
|
||||||
|
:jdk: 1.8.0
|
||||||
|
:guide: https://www.elastic.co/guide/en/elasticsearch/guide/current/
|
||||||
|
:ref: https://www.elastic.co/guide/en/elasticsearch/reference/5.3/
|
||||||
|
:xpack-ref: https://www.elastic.co/guide/en/x-pack/5.3/
|
||||||
|
:kibana-ref: https://www.elastic.co/guide/en/kibana/5.3/
|
||||||
|
:logstash: https://www.elastic.co/guide/en/logstash/5.3/
|
||||||
|
:libbeat: https://www.elastic.co/guide/en/beats/libbeat/5.3/
|
||||||
|
:filebeat: https://www.elastic.co/guide/en/beats/filebeat/5.3/
|
||||||
|
:lsissue: https://github.com/elastic/logstash/issues/
|
||||||
|
:security: X-Pack Security
|
||||||
|
:stack: https://www.elastic.co/guide/en/elastic-stack/5.3/
|
||||||
|
|
||||||
|
: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/5.3/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/5.3/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/5.3/docs/static/advanced-pipeline.asciidoc
|
||||||
|
include::static/advanced-pipeline.asciidoc[]
|
||||||
|
|
||||||
|
// Processing Pipeline
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/life-of-an-event.asciidoc
|
||||||
|
include::static/life-of-an-event.asciidoc[]
|
||||||
|
|
||||||
|
// Lostash setup
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/setting-up-logstash.asciidoc
|
||||||
|
include::static/setting-up-logstash.asciidoc[]
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/settings-file.asciidoc
|
||||||
|
include::static/settings-file.asciidoc[]
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/running-logstash-command-line.asciidoc
|
||||||
|
include::static/running-logstash-command-line.asciidoc[]
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/running-logstash.asciidoc
|
||||||
|
include::static/running-logstash.asciidoc[]
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/docker.asciidoc
|
||||||
|
include::static/docker.asciidoc[]
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/logging.asciidoc
|
||||||
|
include::static/logging.asciidoc[]
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/persistent-queues.asciidoc
|
||||||
|
include::static/persistent-queues.asciidoc[]
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/shutdown.asciidoc
|
||||||
|
include::static/shutdown.asciidoc[]
|
||||||
|
|
||||||
|
// Breaking Changes
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/breaking-changes.asciidoc
|
||||||
|
include::static/breaking-changes.asciidoc[]
|
||||||
|
|
||||||
|
// Upgrading Logstash
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/upgrading.asciidoc
|
||||||
|
include::static/upgrading.asciidoc[]
|
||||||
|
|
||||||
|
// Configuring Logstash
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/configuration.asciidoc
|
||||||
|
include::static/configuration.asciidoc[]
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/reloading-config.asciidoc
|
||||||
|
include::static/reloading-config.asciidoc[]
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/managing-multiline-events.asciidoc
|
||||||
|
include::static/managing-multiline-events.asciidoc[]
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/glob-support.asciidoc
|
||||||
|
include::static/glob-support.asciidoc[]
|
||||||
|
|
||||||
|
// Working with Filebeat Modules
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/filebeat-modules.asciidoc
|
||||||
|
include::static/filebeat-modules.asciidoc[]
|
||||||
|
|
||||||
|
// Deploying & Scaling
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/deploying.asciidoc
|
||||||
|
include::static/deploying.asciidoc[]
|
||||||
|
|
||||||
|
// Troubleshooting performance
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/performance-checklist.asciidoc
|
||||||
|
include::static/performance-checklist.asciidoc[]
|
||||||
|
|
||||||
|
// Monitoring APIs
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/monitoring-apis.asciidoc
|
||||||
|
include::static/monitoring-apis.asciidoc[]
|
||||||
|
|
||||||
|
// Working with Plugins
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/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/5.3/docs/static/contributing-patch.asciidoc
|
||||||
|
include::static/contributing-patch.asciidoc[]
|
||||||
|
|
||||||
|
// Logstash Community Maintainer Guide
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/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/5.3/docs/static/submitting-a-plugin.asciidoc
|
||||||
|
include::static/submitting-a-plugin.asciidoc[]
|
||||||
|
|
||||||
|
|
||||||
|
// Glossary of Terms
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/glossary.asciidoc
|
||||||
|
include::static/glossary.asciidoc[]
|
||||||
|
|
||||||
|
|
||||||
|
// Release Notes
|
||||||
|
|
||||||
|
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/releasenotes.asciidoc
|
||||||
|
include::static/releasenotes.asciidoc[]
|
||||||
|
|
@ -1,183 +1,6 @@
|
||||||
[[logstash-reference]]
|
[[logstash-reference]]
|
||||||
= Logstash Reference
|
= Logstash Reference
|
||||||
|
|
||||||
:branch: 5.3
|
:plugins-repo-dir: {docdir}/../../logstash-docs/docs
|
||||||
:major-version: 5.x
|
|
||||||
:logstash_version: 5.3.3
|
|
||||||
:elasticsearch_version: 5.3.3
|
|
||||||
:docker-image: docker.elastic.co/logstash/logstash:{logstash_version}
|
|
||||||
|
|
||||||
//////////
|
include::index-shared1.asciidoc[]
|
||||||
release-state can be: released | prerelease | unreleased
|
|
||||||
//////////
|
|
||||||
:release-state: released
|
|
||||||
|
|
||||||
:jdk: 1.8.0
|
|
||||||
:guide: https://www.elastic.co/guide/en/elasticsearch/guide/current/
|
|
||||||
:ref: https://www.elastic.co/guide/en/elasticsearch/reference/5.3/
|
|
||||||
:xpack: https://www.elastic.co/guide/en/x-pack/current/
|
|
||||||
:logstash: https://www.elastic.co/guide/en/logstash/5.3/
|
|
||||||
:libbeat: https://www.elastic.co/guide/en/beats/libbeat/5.3/
|
|
||||||
:filebeat: https://www.elastic.co/guide/en/beats/filebeat/5.3/
|
|
||||||
:lsissue: https://github.com/elastic/logstash/issues/
|
|
||||||
:security: X-Pack Security
|
|
||||||
:stack: https://www.elastic.co/guide/en/elastic-stack/5.3/
|
|
||||||
|
|
||||||
[[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/5.3/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/5.3/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/5.3/docs/static/advanced-pipeline.asciidoc
|
|
||||||
include::static/advanced-pipeline.asciidoc[]
|
|
||||||
|
|
||||||
// Processing Pipeline
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/life-of-an-event.asciidoc
|
|
||||||
include::static/life-of-an-event.asciidoc[]
|
|
||||||
|
|
||||||
// Lostash setup
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/setting-up-logstash.asciidoc
|
|
||||||
include::static/setting-up-logstash.asciidoc[]
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/settings-file.asciidoc
|
|
||||||
include::static/settings-file.asciidoc[]
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/running-logstash-command-line.asciidoc
|
|
||||||
include::static/running-logstash-command-line.asciidoc[]
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/running-logstash.asciidoc
|
|
||||||
include::static/running-logstash.asciidoc[]
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/docker.asciidoc
|
|
||||||
include::static/docker.asciidoc[]
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/logging.asciidoc
|
|
||||||
include::static/logging.asciidoc[]
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/persistent-queues.asciidoc
|
|
||||||
include::static/persistent-queues.asciidoc[]
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/shutdown.asciidoc
|
|
||||||
include::static/shutdown.asciidoc[]
|
|
||||||
|
|
||||||
// Breaking Changes
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/breaking-changes.asciidoc
|
|
||||||
include::static/breaking-changes.asciidoc[]
|
|
||||||
|
|
||||||
// Upgrading Logstash
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/upgrading.asciidoc
|
|
||||||
include::static/upgrading.asciidoc[]
|
|
||||||
|
|
||||||
// Configuring Logstash
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/configuration.asciidoc
|
|
||||||
include::static/configuration.asciidoc[]
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/reloading-config.asciidoc
|
|
||||||
include::static/reloading-config.asciidoc[]
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/managing-multiline-events.asciidoc
|
|
||||||
include::static/managing-multiline-events.asciidoc[]
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/glob-support.asciidoc
|
|
||||||
include::static/glob-support.asciidoc[]
|
|
||||||
|
|
||||||
// Working with Filebeat Modules
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/filebeat-modules.asciidoc
|
|
||||||
include::static/filebeat-modules.asciidoc[]
|
|
||||||
|
|
||||||
// Deploying & Scaling
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/deploying.asciidoc
|
|
||||||
include::static/deploying.asciidoc[]
|
|
||||||
|
|
||||||
// Troubleshooting performance
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/performance-checklist.asciidoc
|
|
||||||
include::static/performance-checklist.asciidoc[]
|
|
||||||
|
|
||||||
// Monitoring APIs
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/monitoring-apis.asciidoc
|
|
||||||
include::static/monitoring-apis.asciidoc[]
|
|
||||||
|
|
||||||
// Working with Plugins
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/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/5.3/docs/static/contributing-patch.asciidoc
|
|
||||||
include::static/contributing-patch.asciidoc[]
|
|
||||||
|
|
||||||
// Logstash Community Maintainer Guide
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/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/5.3/docs/static/submitting-a-plugin.asciidoc
|
|
||||||
include::static/submitting-a-plugin.asciidoc[]
|
|
||||||
|
|
||||||
|
|
||||||
// Glossary of Terms
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/glossary.asciidoc
|
|
||||||
include::static/glossary.asciidoc[]
|
|
||||||
|
|
||||||
|
|
||||||
// Release Notes
|
|
||||||
|
|
||||||
:edit_url: https://github.com/elastic/logstash/edit/5.3/docs/static/releasenotes.asciidoc
|
|
||||||
include::static/releasenotes.asciidoc[]
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue