Commit graph

938 commits

Author SHA1 Message Date
Lisa Cawley
35df9aa331
[DOCS] Fixes occurrences of xpack-ref attribute (#11360) (#11368) 2019-12-03 10:14:04 -08:00
Nik Everett
d96902061d Docs: Fix formatting in table (#11016)
Fixes formatting in a table cell in `logstash-monitoring-overview.html`.
A `+` which was required by AsciiDoc was leaking into the output when
the doc is built with Asciidoctor.
2019-08-22 15:40:07 -04:00
Nik Everett
b9ed990ecb Docs: Add more missing subs for asciidoctor (#10991)
Adds a few missing `[attributes="subs"]` clauses for asciidoctor.
2019-07-24 15:35:38 -04:00
Karen Metts
6368688bf2 Fix formatting for nested version attributes
Fixes #10949
2019-07-12 23:58:34 +00:00
Rob Waight
b5c2de47f0 Document running Logstash on Windows (#10805)
* Create running-logstash-windows.asciidoc
Initial commit for #4005

* Update running-logstash-windows
1. Added section to validate JVM pre-requisites and shell sections for nssm, task scheduler, and PowerShell
2. Updated options to run Logstash on Windows, update section headers
3. Clarified JVM pre-requisites and included example to add environmental variables using SETX
4. Added example Logstash configuration, added steps for running Logstash manually with PowerShell
5. Removed `WIP` from the PowerShell section; updated the example to include output to Elasticsearch; Added notes for running Logstash as a service with NSSM
6. Removed `WIP` from the NSSM section; Added notes for running Logstash as a Scheduled Task; Added notes to stopping Logstash for each section; Removed `WIP` from the Scheduled Task section; Removed `WIP` from the page header
7. Updated initial section; moved the running manually section as the first configuration; added notes to the NSSM and Schedule Task sections.
8. Push headings down one level
9. Clarify this document contains examples for running Logstash on Windows.  Updated which NSSM file should be extracted for use.
10. Updated formatting for the example Logstash configuration
11. Update formatting for the command examples
12. Update the instructions in the Task Scheduler section
13. Update the instructions in the run Logstash manually section, the NSSM section, and update formatting
14. Update formatting
15. Add note regarding support for running multiple pipelines
16. Clarify use of command line options.  Re-state what is mentioned in the `Running Logstash from the Command Line` doc that: "Specifying command line options is useful when you are testing Logstash. However, in a production environment, we recommend that you use [logstash-settings-file] to control Logstash execution."
17. Clarify steps to accessing the Windows Environmental Variables window (i.e., link to Microsoft docs).
18. Remove unnecessary plus signs
19. Updated source types for examples, updated documents for specific Logstash versions with `{logstash_version}`

* Update running-logstash-command-line
1. Add note for running Logstash on Windows with `bin\logstash.bat`
2. Update formatting for running Logstash from the Windows command line

Fixes #10946
2019-07-12 23:39:49 +00:00
Karen Metts
83e80225e5 Add structure for new windows topic
Added coming notice

Fixes #10809
2019-05-21 17:11:39 +00:00
Karen Metts
304e73c173
Cherrypick asciidoctor formatting changes 2019-05-06 18:46:58 -04:00
Nik Everett
322b485c0a [Docs] Asciidoctor support (#10730)
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite
work on this repo, but it comes closer with these changes.
2019-05-01 14:32:17 -04:00
Karen Metts
07ddd85e47 CPM note
Fixes #10028
2018-09-28 13:29:36 +00:00
Alex Scoble
90e4222792 Quotes around pipeline names with dashes
Added quotes surrounding pipeline references that have dashes as logstash will throw an error otherwise

Fixes #9903
2018-09-04 20:57:51 +00:00
dedemorton
431a3afbec Light edit to remove passive voice and fix misplaced modifier
Fixes #9856
2018-07-25 18:48:17 +00:00
Colin Surprenant
5dbf6ca782
6.3.2 release notes (#9850) 2018-07-23 15:33:17 -04:00
Colin Surprenant
14bda8f965
bump docs for 6.3.2 (#9851) 2018-07-23 15:15:46 -04:00
Lisa Cawley
9202a1b0d9 [DOCS] Clarify methods for stopping Logstash (#9828) 2018-07-11 09:17:48 -07:00
Lisa Cawley
74421fcbf3 [DOCS] Removes alternative docker pull example (#9831) 2018-07-11 08:59:54 -07:00
Ry Biesemeyer
513f8c5474 release notes for 6.3.1
Fixes #9804
2018-07-05 16:54:11 +00:00
lcawl
bdd4224bdd [DOCS] Updates version to 6.3.1 2018-07-05 07:35:24 -07:00
Karen Metts
cb062c5699 Add info on backward compatibility; add anchor for draining queue
Fixes #9796
2018-07-02 22:09:11 +00:00
Shaunak Kashyap
f491c27cd7 Encourage central management UI users to add the monitoring_user role as well
Fixes #9759
2018-06-22 14:12:33 +00:00
lcawl
5838097db0 [DOCS] Adds link in breaking changes 2018-06-15 12:55:08 -07:00
Joao Duarte
59bcecbab9 set release-state of 6.3 docs to released
Fixes #9725
2018-06-13 13:27:54 +00:00
Shaunak Kashyap
f1dd302560 Fixing reference syntax
Fixes #9644
2018-06-13 13:18:23 +00:00
Shaunak Kashyap
474ecdd5df Changing NOTE to IMPORTANT
Fixes #9644
2018-06-13 13:18:23 +00:00
Shaunak Kashyap
abe7c32f66 Used shared attribute for linking instead of hardcoding
Fixes #9644
2018-06-13 13:18:23 +00:00
Shaunak Kashyap
73bab8e0dd Move note under 6.3.0 section
Fixes #9644
2018-06-13 13:18:23 +00:00
Shaunak Kashyap
df7297fa0d Adding Logstash 6.3.0 link to summary
Fixes #9644
2018-06-13 13:18:23 +00:00
Shaunak Kashyap
9b4e287996 Converting PR #s to links
Fixes #9644
2018-06-13 13:18:23 +00:00
Shaunak Kashyap
fab10c6516 Fleshing out plugins' release notes
Fixes #9644
2018-06-13 13:18:23 +00:00
Shaunak Kashyap
8fa3417cde Adding core release notes for 6.3.0
Fixes #9644
2018-06-13 13:18:23 +00:00
Toby McLaughlin
62875dbfd1 [DOCS] Update config steps for open X-Pack (#9674) 2018-06-04 09:58:42 +10:00
Lisa Cawley
bc6e7c638d [DOCS] Moves management folder to docs (#9680) 2018-05-30 09:29:15 -07:00
Lisa Cawley
2ab15f9a45 [DOCS] Move monitoring folder to docs (#9677) 2018-05-30 09:08:02 -07:00
Lisa Cawley
8e2ffcbef7 [DOCS] Moves security folder to docs (#9678) 2018-05-30 09:01:47 -07:00
Lisa Cawley
0c1fea98ed [DOCS] Move setup folder to docs (#9681) 2018-05-30 08:25:56 -07:00
Lisa Cawley
67b2b2be2f [DOCS] Moves settings folder to docs (#9679) 2018-05-30 08:12:04 -07:00
Andrew Cholakian
f155d3b9ec Label inter-pipeline comms beta
Fixes #9650
2018-05-24 12:48:54 +00:00
Andrew Cholakian
567fcc50e8 The initial implementation of inter-pipeline comms doesn't handle inter-pipeline dependencies correctly.
It just blocks and doesn't handle the concurrency situation. One can think of the network of connected pipelines as a DAG (We explicitly ask users not to create cycles in our docs). In fact there are two different correct answers to the pipeline shutdown and reload problem.

When reloading pipelines we should assume the user understands whatever changes they're making to the topology. If a downstream pipeline is to be removed, we can assume that's intentional. We don't lose any data from upstream pipelines since those block until that downstream pipeline is restored. To accomplish this none of the `PipelineBus` methods block by default.

When shutting down Logstash we must: 1.) not lose in-flight data, and 2.) not deadlock. The only way to do both is to shutdown the pipelines in order. All state changes happen simultaneously on all piping via multithreading. As a result we don't need to implement a Topological sort or other algorithm to order dependencies, we simply issue a shutdown to all pipelines, and have ones that are dependent block waiting for upstream pipelines.

This patch also correctly handles the case where multiple signals cause pipeline actions to be created simultaneously. If we see two concurrent creates or stops, one of those actions becomes a noop.

Currently the Logstash plugin API has lifecycle methods for starting and stopping, but not reloading. We need to call a different method when a `pipeline` input is stopped due to a pipeline reload vs an agent shutdown. Ideally, we would enrich our plugin API. In the interest of expedience here, however, I added a flag to the `PipelineBus` that changes the shutdown mode of `pipeline` inputs, to be either blocking or non-blocking. It is switched to blocking if a shutdown is triggered.

Fixes #9650
2018-05-24 12:48:54 +00:00
João Duarte
003511e6f2 Release notes for 6.2.4 (#9381) 2018-05-22 14:04:58 -07:00
Karen Metts
19fbd51bf5 Fix breaking changes doc structure
Fixes #9606
2018-05-21 23:56:30 +00:00
Lisa Cawley
82cd7105e4 [DOCS] Removes redundant index.asciidoc files (#9607) 2018-05-18 12:26:43 -07:00
Lisa Cawley
cc8dc19d9a [DOCS] Moves X-Pack configuration pages in table of contents (#9604) 2018-05-17 18:02:34 -07:00
Karen Metts
23dcac2a18 Reuse old link for SEO
Fixes #9595
2018-05-17 13:22:14 +00:00
Karen Metts
e1a2f72caa Add instructions for upgrading PQ pre-6.3.0
Fixes #9580
2018-05-15 21:21:00 +00:00
DeDe Morton
a8bab06e09 Update life-of-an-event.asciidoc
Fixes #9558
2018-05-15 01:19:35 +00:00
Andrew Cholakian
f6a1a26412 Update breaking-changes.asciidoc
Fixes #9550
2018-05-11 16:16:26 +00:00
Andrew Cholakian
bf6e5ca632 Fix formatting of breaking changes to not split across pages
The current formatting results in multiple pages, which is confusing, as seen on https://www.elastic.co/guide/en/logstash/current/breaking-changes.html

Fixes #9550
2018-05-11 16:16:26 +00:00
Andrew Cholakian
e18aa41df8 Improve breaking PQ change doc for 6.3.0
Once 6.3.0 is the newest release the phrasing should reflect that.

Fixes #9548
2018-05-09 20:06:27 +00:00
Andrew Cholakian
5bb3e757c4 Improve phrasing of version ranges in PQ upgrade advice
Fixes #9546
2018-05-09 19:47:12 +00:00
Andrew Cholakian
8352f926e8 Add greater context to PQ backward compat breakage
Fixes #9545
2018-05-09 19:32:26 +00:00
Andrew Cholakian
4ab834c94e Use @karenzone 's improved wording
Fixes #9542
2018-05-09 18:59:29 +00:00