Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Describe how to use Elastic Agent to monitor Elasticsearch #94348

Merged
merged 7 commits into from
Mar 24, 2023

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Mar 7, 2023

Summary

Add Elastic Agent as another way to collect monitoring data.

This work is tracked by elastic/observability-docs#2602.

There will be additional PRs to address changes required to monitoring docs for other stack components. TBH, it pains me a bit to see how many places users need to go to find info about stack monitoring, but fixing that problem is not in scope for these updates unfortunately. :-/

Please respond to questions addressed to reviewers.

To Do before merging

@dedemorton dedemorton self-assigned this Mar 7, 2023
@github-actions
Copy link

github-actions bot commented Mar 7, 2023

Documentation preview:

@elasticsearchmachine elasticsearchmachine added v8.8.0 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Mar 7, 2023
@dedemorton dedemorton marked this pull request as ready for review March 9, 2023 03:39
@elasticsearchmachine elasticsearchmachine added the needs:triage Requires assignment of a team area label label Mar 9, 2023
@dedemorton dedemorton added the >docs General docs changes label Mar 9, 2023
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team and removed needs:triage Requires assignment of a team area label labels Mar 9, 2023
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@dedemorton dedemorton added needs:triage Requires assignment of a team area label v8.7.0 and removed Team:Docs Meta label for docs team labels Mar 9, 2023
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team and removed needs:triage Requires assignment of a team area label labels Mar 9, 2023
@dedemorton dedemorton added the needs:triage Requires assignment of a team area label label Mar 9, 2023
@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Mar 9, 2023
@dedemorton
Copy link
Contributor Author

Build is failing because it has a dependency on elastic/kibana#152634. I will comment out references that are causing the build failure for now.

docs/reference/monitoring/how-monitoring-works.asciidoc Outdated Show resolved Hide resolved
docs/reference/monitoring/how-monitoring-works.asciidoc Outdated Show resolved Hide resolved
docs/reference/monitoring/how-monitoring-works.asciidoc Outdated Show resolved Hide resolved
docs/reference/monitoring/indices.asciidoc Outdated Show resolved Hide resolved
docs/reference/monitoring/indices.asciidoc Show resolved Hide resolved
docs/reference/monitoring/overview.asciidoc Outdated Show resolved Hide resolved
docs/reference/monitoring/production.asciidoc Outdated Show resolved Hide resolved
docs/reference/monitoring/production.asciidoc Outdated Show resolved Hide resolved
@dedemorton
Copy link
Contributor Author

dedemorton commented Mar 22, 2023

@klacabane As soon as the doc build completes, this PR will be ready for a final approval review. Thanks!

(We won't get a successful build until after the related PRs are merged)

@dedemorton
Copy link
Contributor Author

@klacabane Docs are building now and ready for final review. (On top of my link error, there was a problem with the main docs build that prevented the PR docs build from passing.)

Copy link
Contributor

@klacabane klacabane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thank you :)

@dedemorton dedemorton added the auto-backport-and-merge Automatically create backport pull requests and merge when ready label Mar 24, 2023
@dedemorton dedemorton merged commit a6c7c1f into elastic:main Mar 24, 2023
@dedemorton dedemorton deleted the obs-issue#2602 branch March 24, 2023 16:00
@dedemorton dedemorton added auto-backport Automatically create backport pull requests when merged auto-backport-and-merge Automatically create backport pull requests and merge when ready and removed auto-backport-and-merge Automatically create backport pull requests and merge when ready auto-backport Automatically create backport pull requests when merged labels Mar 24, 2023
@dedemorton
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
8.7

Questions ?

Please refer to the Backport tool documentation

dedemorton added a commit that referenced this pull request Mar 24, 2023
…4348) (#94754)

* [DOCS] Describe how to use Elastic Agent to monitor Elasticsearch

* Temporarily fix doc build

* Add question about showing Elastic Agent metrics in the monitoring UI

* Apply changes from review

* Activate link to Kibana docs

* Fix broken link

* Update docs/reference/monitoring/indices.asciidoc

(cherry picked from commit a6c7c1f)
saarikabhasi pushed a commit to saarikabhasi/elasticsearch that referenced this pull request Apr 10, 2023
…astic#94348)

* [DOCS] Describe how to use Elastic Agent to monitor Elasticsearch

* Temporarily fix doc build

* Add question about showing Elastic Agent metrics in the monitoring UI

* Apply changes from review

* Activate link to Kibana docs

* Fix broken link

* Update docs/reference/monitoring/indices.asciidoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport-and-merge Automatically create backport pull requests and merge when ready >docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Docs Meta label for docs team v8.7.0 v8.8.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants