Add Elasticsearch and Logstash output settings to Elastic Agent docs #460

dedemorton · 2021-03-19T21:17:37Z

First pass at adding the settings.

NOTE: I've created a PR that we can merge for 7.14 in case we don't have time to sort out all the detailed info here before GA ships.

Preview: Click here

Reviewers:

Identify settings that are missing, don’t belong, or are not yet supported. (I’ve removed settings that didn’t seem relevant, like index and ilm)
Confirm/test examples.
Identify missing/incorrect defaults and types.
Suggest newexamples where they would help.
Answer any questions that appear inline in the source.

Writer tasks remaining:

Fix examples to use correct syntax for agent config.
Check for changes that were introduced in the Elasticsearch docs between March 19 and now.
Add missing settings for ssl.
Look at this topic to see if there's anything missing that we need to add to the agent docs: https://www.elastic.co/guide/en/beats/filebeat/current/securing-communication-elasticsearch.html
Add missing settings for kerberos.
Fix structure of config overview topic (elastic-agent-configuration.asciidoc)

apmmachine · 2021-03-19T21:18:16Z

A documentation preview will be available soon:

dedemorton · 2021-05-11T00:39:14Z

@elasticmachine run elasticsearch-ci/docs

dedemorton · 2021-05-11T01:07:40Z

@mostlyjason Here's a PR that demonstrates the topic structure I am using for the settings reference. Specifically I'd like to know what you think about breaking each section down into categories (when it makes sense...probably doesn't for Fleet Server) and the general format (tables etc).

Please stop reading when you get to "Beats monitoring settings." That content belongs on a different page (the fix is in a different PR). Thanks for taking a look.

dedemorton · 2021-05-12T00:41:59Z

@elasticmachine run elasticsearch-ci/docs

mostlyjason · 2021-05-14T14:42:06Z

@dedemorton LGTM!

docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc

EricDavisX

I think we could move the HTML escaping section as noted, but it isn't critical to do so, you can merge as is or make any smaller adjustments. I think we should capture all of these good valid questions you note in an email perhaps. Help push folks to follow up with us on them! :)

docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc

faec

Finished a fairly complete pass -- answered all the explicit questions I noticed, and vetted most of the specific configuration fields. I want to double check a couple more things about overall file structure, and I'll try and get you a couple more example configurations shortly.

docs/en/ingest-management/elastic-agent/configuration/elastic-agent-monitoring.asciidoc

docs/en/ingest-management/elastic-agent/configuration/outputs/output-logstash.asciidoc

docs/en/ingest-management/elastic-agent/configuration/outputs/output-shared-settings.asciidoc

docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc

dedemorton · 2021-08-14T01:05:13Z

@faec I've addressed your comments and added the SSL and Kerberos settings. Can you take another look? Thanks!

dedemorton · 2021-08-24T19:34:55Z

OK, this content is ready for a final review as soon as the CI completes. Thanks everyone (especially Fae) for helping me with this.

faec

Looks good!

…lastic#460) * Add output settings to Elastic Agent docs * Changes applied after merge to preserve earlier changes * First batch of changes from the review * Add missing proxy settings * Add kerberos settings * Add SSL settings * Add ssl settings to logstash output docs * Fix ssl examples * Add link to pipeline ES docs

…460) (#1001) * Add output settings to Elastic Agent docs * Changes applied after merge to preserve earlier changes * First batch of changes from the review * Add missing proxy settings * Add kerberos settings * Add SSL settings * Add ssl settings to logstash output docs * Fix ssl examples * Add link to pipeline ES docs

…460) (#1002) * Add output settings to Elastic Agent docs * Changes applied after merge to preserve earlier changes * First batch of changes from the review * Add missing proxy settings * Add kerberos settings * Add SSL settings * Add ssl settings to logstash output docs * Fix ssl examples * Add link to pipeline ES docs

…lastic#460) * Add output settings to Elastic Agent docs * Changes applied after merge to preserve earlier changes * First batch of changes from the review * Add missing proxy settings * Add kerberos settings * Add SSL settings * Add ssl settings to logstash output docs * Fix ssl examples * Add link to pipeline ES docs

…460) (#1003) * Add output settings to Elastic Agent docs * Changes applied after merge to preserve earlier changes * First batch of changes from the review * Add missing proxy settings * Add kerberos settings * Add SSL settings * Add ssl settings to logstash output docs * Fix ssl examples * Add link to pipeline ES docs

…lastic#460) * Add output settings to Elastic Agent docs * Changes applied after merge to preserve earlier changes * First batch of changes from the review * Add missing proxy settings * Add kerberos settings * Add SSL settings * Add ssl settings to logstash output docs * Fix ssl examples * Add link to pipeline ES docs

dedemorton added v7.12.0 Team:Elastic-Agent Label for the Agent team labels Mar 19, 2021

dedemorton requested a review from ph March 19, 2021 21:17

dedemorton self-assigned this Mar 19, 2021

dedemorton mentioned this pull request Mar 19, 2021

[Meta] Migrate outputs documentation to Elastic Agent elastic/beats#23742

Closed

3 tasks

EricDavisX reviewed May 27, 2021

View reviewed changes

docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc Outdated Show resolved Hide resolved

EricDavisX reviewed May 27, 2021

View reviewed changes

docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc Outdated Show resolved Hide resolved

EricDavisX reviewed May 27, 2021

View reviewed changes

docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc Outdated Show resolved Hide resolved

EricDavisX approved these changes May 27, 2021

View reviewed changes

mostlyjason reviewed May 28, 2021

View reviewed changes

docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc Outdated Show resolved Hide resolved

dedemorton requested a review from a team as a code owner July 15, 2021 23:13

dedemorton mentioned this pull request Jul 15, 2021

Document Logstash output in Agent #535

Closed

dedemorton changed the title ~~Add Elasticsearch output settings to Elastic Agent docs~~ [WIP] Add Elasticsearch output settings to Elastic Agent docs Jul 17, 2021

dedemorton changed the title ~~[WIP] Add Elasticsearch output settings to Elastic Agent docs~~ [WIP] Add Elasticsearch and Logstash output settings to Elastic Agent docs Jul 17, 2021

dedemorton force-pushed the issue#23742_elasticsearch_output branch 2 times, most recently from 9fb2fe6 to 7547488 Compare July 21, 2021 02:45

dedemorton added v7.14.0 and removed v7.12.0 labels Jul 21, 2021

dedemorton requested review from EricDavisX and removed request for a team, ph and EricDavisX July 21, 2021 02:47

Add output settings to Elastic Agent docs

3fd79a8

dedemorton force-pushed the issue#23742_elasticsearch_output branch from 7547488 to 3fd79a8 Compare July 22, 2021 01:46

dedemorton changed the title ~~[WIP] Add Elasticsearch and Logstash output settings to Elastic Agent docs~~ Add Elasticsearch and Logstash output settings to Elastic Agent docs Jul 22, 2021

dedemorton mentioned this pull request Jul 29, 2021

Add logstash section to existing elastic agent configuration docs #904

Merged

1 task

faec reviewed Jul 29, 2021

View reviewed changes

dedemorton added 7 commits August 10, 2021 16:55

Merge branch 'master' into issue#23742_elasticsearch_output

3b6fcb5

Changes applied after merge to preserve earlier changes

cab4195

First batch of changes from the review

9825927

Add missing proxy settings

2b536a0

Add kerberos settings

9cf4d50

Add SSL settings

c882747

Add ssl settings to logstash output docs

affb00d

dedemorton requested a review from faec August 14, 2021 01:04

dedemorton added 3 commits August 24, 2021 11:49

Merge branch 'master' into issue#23742_elasticsearch_output

bdc6c72

Fix ssl examples

47d7685

Add link to pipeline ES docs

bd69368

Merge branch 'master' into issue#23742_elasticsearch_output

6750d94

faec approved these changes Aug 25, 2021

View reviewed changes

dedemorton merged commit 752fc5c into elastic:master Aug 25, 2021

dedemorton deleted the issue#23742_elasticsearch_output branch August 25, 2021 21:53

dedemorton mentioned this pull request Aug 25, 2021

[7.x] Add Elasticsearch and Logstash output settings to Elastic Agent docs (#460) #1001

Merged

dedemorton mentioned this pull request Aug 25, 2021

[7.15] Add Elasticsearch and Logstash output settings to Elastic Agent docs (#460) #1002

Merged

dedemorton mentioned this pull request Aug 25, 2021

[7.14] Add Elasticsearch and Logstash output settings to Elastic Agent docs (#460) #1003

Merged

dedemorton mentioned this pull request Sep 13, 2021

[meta] Improve standalone agent docs #1059

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Elasticsearch and Logstash output settings to Elastic Agent docs #460

Add Elasticsearch and Logstash output settings to Elastic Agent docs #460

dedemorton commented Mar 19, 2021 •

edited

Loading

apmmachine commented Mar 19, 2021 •

edited

Loading

dedemorton commented May 11, 2021

dedemorton commented May 11, 2021

dedemorton commented May 12, 2021

mostlyjason commented May 14, 2021

EricDavisX left a comment

faec left a comment

dedemorton commented Aug 14, 2021

dedemorton commented Aug 24, 2021

faec left a comment

Add Elasticsearch and Logstash output settings to Elastic Agent docs #460

Add Elasticsearch and Logstash output settings to Elastic Agent docs #460

Conversation

dedemorton commented Mar 19, 2021 • edited Loading

apmmachine commented Mar 19, 2021 • edited Loading

dedemorton commented May 11, 2021

dedemorton commented May 11, 2021

dedemorton commented May 12, 2021

mostlyjason commented May 14, 2021

EricDavisX left a comment

Choose a reason for hiding this comment

faec left a comment

Choose a reason for hiding this comment

dedemorton commented Aug 14, 2021

dedemorton commented Aug 24, 2021

faec left a comment

Choose a reason for hiding this comment

dedemorton commented Mar 19, 2021 •

edited

Loading

apmmachine commented Mar 19, 2021 •

edited

Loading