aboutsummaryrefslogtreecommitdiff
path: root/docs/index.asciidoc
blob: cd4a8a5d476331ebcd9f0f557537f2f43d5832a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
[[logstash-reference]]
= Logstash Reference

:include-xpack:         true
:lang:                  en
:xls-repo-dir:          {docdir}/../x-pack/docs/{lang}
:log-repo-dir:          {docdir}
:plugins-repo-dir:      {docdir}/../../logstash-docs/docs
:branch:                master
:major-version:         7.x
:logstash_version:      7.0.0-alpha1
:elasticsearch_version: 7.0.0-alpha1
:kibana_version:        7.0.0-alpha1
:docker-repo:           docker.elastic.co/logstash/logstash
:docker-image:          {docker-repo}:{logstash_version}

//////////
release-state can be: released | prerelease | unreleased
//////////
:release-state:         unreleased
:versioned_docs:        false

:jdk:                   1.8.0
:lsissue:               https://github.com/elastic/logstash/issues
:lsplugindocs:          https://www.elastic.co/guide/en/logstash-versioned-plugins/current

include::{asciidoc-dir}/../../shared/attributes.asciidoc[]

[[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/{branch}/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/{branch}/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/{branch}/docs/static/advanced-pipeline.asciidoc
include::static/advanced-pipeline.asciidoc[]

// Processing Pipeline

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/life-of-an-event.asciidoc
include::static/life-of-an-event.asciidoc[]

// Lostash setup

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/setting-up-logstash.asciidoc
include::static/setting-up-logstash.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/settings-file.asciidoc
include::static/settings-file.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/keystore.asciidoc
include::static/keystore.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/running-logstash-command-line.asciidoc
include::static/running-logstash-command-line.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/running-logstash.asciidoc
include::static/running-logstash.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/docker.asciidoc
include::static/docker.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/logging.asciidoc
include::static/logging.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/shutdown.asciidoc
include::static/shutdown.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/setting-up-xpack.asciidoc
include::static/setup/setting-up-xpack.asciidoc[]

// Breaking Changes

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/breaking-changes.asciidoc
include::static/breaking-changes.asciidoc[]


// Upgrading Logstash

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/upgrading.asciidoc
include::static/upgrading.asciidoc[]

// Configuring Logstash

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/configuration.asciidoc
include::static/configuration.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/multiple-pipelines.asciidoc
include::static/multiple-pipelines.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/pipeline-pipeline-config.asciidoc
include::static/pipeline-pipeline-config.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/reloading-config.asciidoc
include::static/reloading-config.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/managing-multiline-events.asciidoc
include::static/managing-multiline-events.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/glob-support.asciidoc
include::static/glob-support.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/ingest-convert.asciidoc
include::static/ingest-convert.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/ls-ls-config.asciidoc
include::static/ls-ls-config.asciidoc[]

ifdef::include-xpack[]
:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/management/configuring-centralized-pipelines.asciidoc
include::static/management/configuring-centralized-pipelines.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/monitoring/configuring-logstash.asciidoc
include::static/monitoring/configuring-logstash.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/security/logstash.asciidoc
include::static/security/logstash.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/setup/configuring-xls.asciidoc
include::static/setup/configuring-xls.asciidoc[]
endif::include-xpack[]

// Centralized configuration managements
:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/config-management.asciidoc
include::static/config-management.asciidoc[]

// Working with Logstash Modules
:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/modules.asciidoc
include::static/modules.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/arcsight-module.asciidoc
include::static/arcsight-module.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/netflow-module.asciidoc
include::static/netflow-module.asciidoc[]

// Working with Filebeat Modules

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/filebeat-modules.asciidoc
include::static/filebeat-modules.asciidoc[]

// Data resiliency

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/resiliency.asciidoc
include::static/resiliency.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/persistent-queues.asciidoc
include::static/persistent-queues.asciidoc[]

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/dead-letter-queues.asciidoc
include::static/dead-letter-queues.asciidoc[]

// Transforming Data

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/transforming-data.asciidoc
include::static/transforming-data.asciidoc[]

// Deploying & Scaling

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/deploying.asciidoc
include::static/deploying.asciidoc[]

// Troubleshooting performance

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/performance-checklist.asciidoc
include::static/performance-checklist.asciidoc[]

// Monitoring overview

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/monitoring.asciidoc
include::static/monitoring.asciidoc[]

// Monitoring APIs

:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/monitoring-apis.asciidoc
include::static/monitoring-apis.asciidoc[]

// Working with Plugins

:edit_url: https://github.com/elastic/logstash/edit/{branch}/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/{branch}/docs/static/contributing-patch.asciidoc
include::static/contributing-patch.asciidoc[]

// Logstash Community Maintainer Guide

:edit_url: https://github.com/elastic/logstash/edit/{branch}/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/{branch}/docs/static/submitting-a-plugin.asciidoc
include::static/submitting-a-plugin.asciidoc[]

// Glossary of Terms

:edit_url: https://github.com/elastic/logstash/edit/{branch}/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/{branch}/docs/static/releasenotes.asciidoc
include::static/releasenotes.asciidoc[]