Doc: Add Elastic Agent collection #15528

karenzone · 2023-11-03T21:41:53Z

Related: https://github.com/elastic/ingest-dev/issues/2462
Related: #15439
Based on : #15508

This work starts with all the goodness in #15508 from @robbavey, removes extra heading levels for easier parsing, smooths flow, and ideally, sets us up for easier maintenance going forward.

PREVIEW: https://logstash_15528.docs-preview.app.elstc.co/guide/en/logstash/master/monitoring-with-ea.html

karenzone · 2023-11-03T22:09:29Z

docs/static/monitoring/monitoring-ea-dashboards.asciidoc

+=== Confirm Enrollment
+// Include section about confirming enrollment
+include::monitoring-confirm.asciidoc[tag=confirm-enrollment-widget]


The heading is "Confirm Enrollment," but the section leads off with "After enrollment is confirmed..." This makes me think that "Confirm Enrollment" should be part of the previous section, and that we need a more appropriate name for what's going on in this section.

I think that makes sense - I think confirming enrollment is just the resolution of "installing agents"

karenzone · 2023-11-03T22:09:54Z

docs/static/monitoring/monitoring-ea.asciidoc

+// Include section about confirming enrollment
+include::monitoring-confirm.asciidoc[tag=confirm-enrollment-widget]


The heading is "Confirm Enrollment," but the section leads off with "After enrollment is confirmed..." This makes me think that "Confirm Enrollment" should be part of the previous section, and that we need a more appropriate name for what's going on in this section.

robbavey · 2023-11-06T14:50:05Z

docs/static/monitoring/monitoring-ea-intro.asciidoc

+include::monitoring-mb.asciidoc[tag=define-cluster-uuid]
+
+[discrete]
+[[set-up-monitoring]]


What do you think about moving this to the stack monitoring section, instead of having this here?

Makes sense! Working on a better approach.

robbavey · 2023-11-06T14:51:31Z

docs/static/monitoring/monitoring-ea-intro.asciidoc

+[[create-user]]
+=== Create a monitoring user (stack monitoring only)
+
+Create a user on the production cluster that has the


We will need to do this for standalone agent too - what do you think about adding this to the stack monitoring section, and the standalone agent tab?

Or, even adding a tabbed section here for Stack Monitoring, Standalone Agent and Fleet managed?

robbavey · 2023-11-06T14:53:04Z

docs/static/monitoring/monitoring-overview.asciidoc

@@ -1,6 +1,6 @@
 [role="xpack"]
 [[configuring-logstash]]
-== Monitoring {ls}
+== Monitoring {ls} (legacy)


We'll need to figure out if we want to call this "legacy" yet, while dashboards are still in beta

If a user was implementing monitoring from the ground up, we'd likely encourage them to go with agent. Maybe we can add a note in the MB section saying it's still a viable option, but they might want to consider one of the new approaches instead? Let's get Trevor's input.

robbavey · 2023-11-06T14:54:20Z

docs/static/monitoring/monitoring-ea-dashboards.asciidoc

+=== Confirm Enrollment
+// Include section about confirming enrollment
+include::monitoring-confirm.asciidoc[tag=confirm-enrollment-widget]


I think that makes sense - I think confirming enrollment is just the resolution of "installing agents"

robbavey · 2023-11-06T14:56:32Z

docs/static/monitoring/monitoring-ea-intro.asciidoc

+
+You can use {agent} to collect monitoring data for:
+
+- dashboard. <Brief description with link>


Suggested change

- dashboard. <Brief description with link>

- {ls} Dashboards. <Brief description with link>

robbavey · 2023-11-06T14:59:27Z

docs/static/monitoring/monitoring-ea-intro.asciidoc

+You can use {agent} to collect monitoring data for:
+
+- dashboard. <Brief description with link>
+- stack. <Brief description with link> 


Suggested change

- stack. <Brief description with link>

- Legacy Stack Monitoring UI. <Brief description with link>

I'm not sure how best to distinguish between the two - I think "Legacy Stack Monitoring UI" might work

robbavey · 2023-11-06T14:59:43Z

docs/static/monitoring/monitoring-ea-intro.asciidoc

+When you've completed the prerequisites, you're ready to install and configure {agent} for your monitoring use case. 
+
+- dashboard. <Brief description with link>
+- stack. <Brief description with link> 


Same comments as earlier on how we reference each of these UIs

robbavey

This is looking great - I like the changes and the organization that you've put in here

docs/static/monitoring/monitoring-ea-dashboards.asciidoc

robbavey · 2023-11-10T20:38:25Z

docs/static/monitoring/monitoring-ea-dashboards.asciidoc

+
+Install and configure {agent} to collect {ls} monitoring data for dashboards.
+We'll walk you through the process in these steps:
+


What do you think about adding a link to the general agent installation page somewhere, for more details than we will give here? I'm not sure if this is the right place, but it might work here, or at the bottom of this section?

robbavey · 2023-11-10T20:39:13Z

docs/static/monitoring/monitoring-ea-dashboards.asciidoc

+--
+[role="screenshot"]
+image::images/kibana-home.png[{kib} home page]
+--


What do you think about having a widget in a follow-up PR that shows the serverless flow?

I agree with the "follow-up PR" idea, but I have a different approach I'll run by you.

robbavey · 2023-11-10T20:41:43Z

docs/static/monitoring/monitoring-ea.asciidoc


-Prerequisites:
+[[create-user-ea]]
+.Create a monitoring user 


Suggested change

.Create a monitoring user

.Create a monitoring user (standalone agent only)

We don't need to create a monitoring user if the user is using fleet here

robbavey · 2023-11-10T20:46:31Z

docs/static/monitoring/monitoring-ea-dashboards.asciidoc

+[[view-assets-ead]]
+=== View assets
+// Include section about viewing assets
+include::monitoring-confirm.asciidoc[tag=confirm-enrollment-widget]


What do you think about splitting this content into logs and metrics - Logs dashboards are common to both, and could be a shared doc.

While, sadly, both sets of assets are installed regardless of which metric collection method is used, they only have relevance in the Dashboards.

I was wondering if we should have a an explanatory section for Dashboards, which explains what each of the dashboards are (or at least an inventory), and one for Stack Monitoring, which says that these dashboards are not populated when dashboard collection is disabled?

Definitely worth exploring in a follow-up PR.

robbavey · 2023-11-14T18:12:41Z

@karenzone I updated the screenshots, removing those that weren't used, and fixed up the differences between the fleet managed and standalone screenshots

robbavey

I'm happy with this as a first pass - I think we can add extra information on the dashboard contents, and I'd like to add a section on how to install on serverless, but this LGTM

Co-authored-by: Rob Bavey <[email protected]>

Clean up screenshots - delete those that aren't used, and use the same font size for agent flyout

elastic-sonarqube · 2023-11-14T18:30:06Z

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

elasticmachine · 2023-11-14T18:49:10Z

💚 Build Succeeded

Buildkite Build
Commit: 179d5f3

History

💔 Build #361 failed d262339
💔 Build #358 failed d3c1042
💔 Build #357 failed 3b3445b
💔 Build #346 failed 6e9be19
💔 Build #345 failed c4cf77b

cc @robbavey @karenzone

karenzone · 2023-11-14T18:56:00Z

#48869

karenzone · 2023-11-14T19:06:55Z

@logstashmachine backport 8.11

Co-authored-by: Rob Bavey <[email protected]> (cherry picked from commit c060c00)

Co-authored-by: Rob Bavey <[email protected]> (cherry picked from commit c060c00) Co-authored-by: Karen Metts <[email protected]>

karenzone added the docs label Nov 3, 2023

karenzone assigned robbavey and karenzone Nov 3, 2023

karenzone commented Nov 3, 2023

View reviewed changes

robbavey reviewed Nov 6, 2023

View reviewed changes

roaksoax added the status:work-in-progress label Nov 8, 2023

karenzone force-pushed the 2462-agent-monitoring branch from 6588dfc to c4cf77b Compare November 10, 2023 16:34

robbavey reviewed Nov 10, 2023

View reviewed changes

karenzone marked this pull request as ready for review November 13, 2023 23:34

roaksoax added status:needs-review and removed status:work-in-progress labels Nov 14, 2023

robbavey approved these changes Nov 14, 2023

View reviewed changes

robbavey added 16 commits November 14, 2023 13:24

wip

1e3e90f

WIP docs for Logstash Dashboard/Agent setup

23efa8c

Remove unnecessary page

8d137a1

Add missing asset

96daa11

Split out dashboards and tech preview sections

b515f8f

Restructure headlines

11d1dc6

Fix up headings

828a32c

Formatting and tidying

a34b92a

Add instructions for standalone agent

f916a97

add widgets

0cced9e

Fix image link for standalone agent

7b3e2cc

Split out dashboard vs stack monitoring

9422a99

Hack out dupes

51ad18c

fix up headings

cec2db1

Typos and minor fixes

a30d105

Remove some diagrams to unclutter

52cb84e

karenzone and others added 7 commits November 14, 2023 13:24

Refactor headings and smooth flow

e35ca58

Add new intro file

8e7af32

Restructure content for flow and reuse

6b03648

Use attributes and file cleanup

8cad435

Incorporate review comments

78bff9b

Add prereq for standalone

e00f065

Co-authored-by: Rob Bavey <[email protected]>

Fixup assets

179d5f3

Clean up screenshots - delete those that aren't used, and use the same font size for agent flyout

robbavey force-pushed the 2462-agent-monitoring branch from d262339 to 179d5f3 Compare November 14, 2023 18:25

karenzone merged commit c060c00 into elastic:main Nov 14, 2023

karenzone deleted the 2462-agent-monitoring branch November 14, 2023 18:55

roaksoax removed the status:needs-review label Nov 14, 2023

github-actions bot pushed a commit that referenced this pull request Nov 14, 2023

Doc: Add Elastic Agent collection (#15528)

a63bc75

Co-authored-by: Rob Bavey <[email protected]> (cherry picked from commit c060c00)

github-actions bot mentioned this pull request Nov 14, 2023

Backport PR #15528 to 8.11: Doc: Add Elastic Agent collection #15589

Merged

github-actions bot added the v8.11.2 label Nov 14, 2023

karenzone added a commit that referenced this pull request Nov 15, 2023

Doc: Add Elastic Agent collection (#15528) (#15589)

91e0d8a

Co-authored-by: Rob Bavey <[email protected]> (cherry picked from commit c060c00) Co-authored-by: Karen Metts <[email protected]>

This was referenced Nov 27, 2023

Doc: Improvements to Logstash Monitoring with Agent docs #15618

Closed

Doc: Add LS monitoring for serverless #15622

Closed

karenzone mentioned this pull request Jan 30, 2024

Doc: Troubleshoot missing graphics in monitoring topics #15882

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc: Add Elastic Agent collection #15528

Doc: Add Elastic Agent collection #15528

karenzone commented Nov 3, 2023 •

edited

Loading

karenzone Nov 3, 2023

robbavey Nov 6, 2023

karenzone Nov 3, 2023

robbavey Nov 6, 2023

karenzone Nov 8, 2023

robbavey Nov 6, 2023

robbavey Nov 6, 2023

karenzone Nov 10, 2023

robbavey Nov 6, 2023

robbavey Nov 6, 2023

robbavey Nov 6, 2023

robbavey Nov 6, 2023

robbavey left a comment

robbavey Nov 10, 2023

robbavey Nov 10, 2023

karenzone Nov 13, 2023

robbavey Nov 10, 2023

robbavey Nov 10, 2023

karenzone Nov 13, 2023

robbavey commented Nov 14, 2023

robbavey left a comment

elastic-sonarqube bot commented Nov 14, 2023

elasticmachine commented Nov 14, 2023

karenzone commented Nov 14, 2023

karenzone commented Nov 14, 2023

		// Include section about confirming enrollment
		include::monitoring-confirm.asciidoc[tag=confirm-enrollment-widget]


		You can use {agent} to collect monitoring data for:

		- dashboard. <Brief description with link>

	- dashboard. <Brief description with link>
	- {ls} Dashboards. <Brief description with link>

	- stack. <Brief description with link>
	- Legacy Stack Monitoring UI. <Brief description with link>


		Install and configure {agent} to collect {ls} monitoring data for dashboards.
		We'll walk you through the process in these steps:

	.Create a monitoring user
	.Create a monitoring user (standalone agent only)

Doc: Add Elastic Agent collection #15528

Doc: Add Elastic Agent collection #15528

Conversation

karenzone commented Nov 3, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robbavey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robbavey commented Nov 14, 2023

robbavey left a comment

Choose a reason for hiding this comment

elastic-sonarqube bot commented Nov 14, 2023

elasticmachine commented Nov 14, 2023

💚 Build Succeeded

History

karenzone commented Nov 14, 2023

karenzone commented Nov 14, 2023

karenzone commented Nov 3, 2023 •

edited

Loading