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.

Sign up for GitHub

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

Jump to bottom

[Stack Monitoring] Docs pages for agent-based monitoring #2602

Closed
Tracked by #120415
matschaffer opened this issue Oct 4, 2022 · 6 comments
Closed
Tracked by #120415

[Stack Monitoring] Docs pages for agent-based monitoring #2602

matschaffer opened this issue Oct 4, 2022 · 6 comments
Assignees
@crespocarlos @klacabane @dedemorton
Labels
Feature:Stack Monitoring Team:Infra Monitoring UI Label for the Infrastructure Monitoring UI team v8.7.0

Comments

@matschaffer
Copy link

matschaffer commented Oct 4, 2022 •
edited by klacabane
Loading

Summary

For each supported service we should create a dedicated page (or section) describing how to set up the corresponding integration, what it can collect and where it is stored, or what additional resources if any are available. Given there is overlap with the metricbeat setup we can reuse some of the corresponding metricbeat documentation (kibana example).

Links
@matschaffer matschaffer mentioned this issue Oct 4, 2022
Closed
33 tasks
@matschaffer matschaffer added the Team:Infra Monitoring UI Label for the Infrastructure Monitoring UI team label Oct 4, 2022
@smith smith added the v8.7.0 label Feb 7, 2023
@dedemorton dedemorton self-assigned this Feb 8, 2023
@dedemorton
Copy link
Contributor

@smith Should we close these old (related) issues? #942 and elastic/kibana#104746

@smith
Copy link
Contributor

smith commented Feb 9, 2023

@dedemorton sure go ahead. I've never heard of them. Moving this over to obs-docs right now.

@smith smith transferred this issue from elastic/kibana Feb 9, 2023
This was referenced Feb 9, 2023
Closed
Closed
@dedemorton
Copy link
Contributor

dedemorton commented Feb 23, 2023 •
edited
Loading

Doc impact [WIP]

This section provides an overview what needs to be added, changed, or validated. WIP because I need to view the demo and play around with the software to finalize this list.

We will be patching existing docs with new content rather than making extensive structural changes at this time. We might be able to leverage content from the "quick guide" I've created for #2564.

Observability Guide

  • Add a stack monitoring topic to the obs guide at the same level as the other types of monitoring. This topic will basically be a link farm to all the existing content across the docs. It's not the best user experience, but will give users a starting point. I'm not doing this because there is already a proliferation of "overview" content in various places.

Kibana Guide

Elasticsearch Guide

Logstash Reference

APM Guide

  • Monitor APM Server - link under configuring Elastic Agent should probably point to the new topic that covers Agent rather than Metricbeat. Also verify that we still want to tell users to change settings in elastic-agent.yml (not sure for APM, but in general, we want folks to use the settings in Fleet). No changes required.

Enterprise Search Guide

  • Monitoring - Maybe add a section about Agent and the Enterprise search integration to provide coverage similar to metricbeat? The enterprise search team will handle this as part of https://github.com/elastic/enterprise-search-team/issues/4153.
    • Check with the enterprise search docs team to figure out if they want me to add a section similar to what I've added for other stack monitoring integrations.

@dedemorton dedemorton mentioned this issue Feb 23, 2023
Open
2 tasks
This was referenced Mar 3, 2023
Merged
Merged
@dedemorton dedemorton mentioned this issue Mar 11, 2023
Merged
2 tasks
@dedemorton
Copy link
Contributor

dedemorton commented Mar 22, 2023 •
edited
Loading

Current status as of 14:42, March 24:

dedemorton added a commit to elastic/kibana that referenced this issue Mar 23, 2023
@dedemorton @klacabane
[DOCS] Describe how to use Elastic Agent to monitor Kibana (#152634)
9ff847d 
## 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.

### Checklist

Delete any items that are not applicable to this PR.

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)

### To Do before merging

- [x] Remove questions to reviewers.

---------

Co-authored-by: Kevin Lacabane <klacabane@gmail.com>
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Mar 23, 2023
@dedemorton
[DOCS] Describe how to use Elastic Agent to monitor Kibana (elastic#1…
b9f1251 
…52634)

## 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.

### Checklist

Delete any items that are not applicable to this PR.

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)

### To Do before merging

- [x] Remove questions to reviewers.

---------

Co-authored-by: Kevin Lacabane <klacabane@gmail.com>
(cherry picked from commit 9ff847d)
kibanamachine added a commit to elastic/kibana that referenced this issue Mar 23, 2023
@kibanamachine @dedemorton
[8.7] [DOCS] Describe how to use Elastic Agent to monitor Kibana (#15…
c50ea8c 
…2634) (#153585)

# Backport

This will backport the following commits from `main` to `8.7`:
- [[DOCS] Describe how to use Elastic Agent to monitor Kibana
(#152634)](#152634)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"DeDe
Morton","email":"dede.morton@elastic.co"},"sourceCommit":{"committedDate":"2023-03-23T18:00:13Z","message":"[DOCS]
Describe how to use Elastic Agent to monitor Kibana (#152634)\n\n##
Summary\r\n\r\nAdd Elastic Agent as another way to collect monitoring
data.\r\n\r\nThis work is tracked
by\r\nhttps://github.com/elastic/observability-docs/issues/2602.\r\n\r\nThere
will be additional PRs to address changes required to monitoring\r\ndocs
for other stack components. TBH, it pains me a bit to see how
many\r\nplaces users need to go to find info about stack monitoring, but
fixing\r\nthat problem is not in scope for these updates unfortunately.
:-/\r\n\r\nPlease respond to questions addressed to
reviewers.\r\n\r\n### Checklist\r\n\r\nDelete any items that are not
applicable to this PR.\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n\r\n###
To Do before merging\r\n\r\n- [x] Remove questions to
reviewers.\r\n\r\n---------\r\n\r\nCo-authored-by: Kevin Lacabane
<klacabane@gmail.com>","sha":"9ff847dec75a5a562cc46d121cbec57c45da177d","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","auto-backport-next","v8.7.0","v8.8.0"],"number":152634,"url":"https://github.com/elastic/kibana/pull/152634","mergeCommit":{"message":"[DOCS]
Describe how to use Elastic Agent to monitor Kibana (#152634)\n\n##
Summary\r\n\r\nAdd Elastic Agent as another way to collect monitoring
data.\r\n\r\nThis work is tracked
by\r\nhttps://github.com/elastic/observability-docs/issues/2602.\r\n\r\nThere
will be additional PRs to address changes required to monitoring\r\ndocs
for other stack components. TBH, it pains me a bit to see how
many\r\nplaces users need to go to find info about stack monitoring, but
fixing\r\nthat problem is not in scope for these updates unfortunately.
:-/\r\n\r\nPlease respond to questions addressed to
reviewers.\r\n\r\n### Checklist\r\n\r\nDelete any items that are not
applicable to this PR.\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n\r\n###
To Do before merging\r\n\r\n- [x] Remove questions to
reviewers.\r\n\r\n---------\r\n\r\nCo-authored-by: Kevin Lacabane
<klacabane@gmail.com>","sha":"9ff847dec75a5a562cc46d121cbec57c45da177d"}},"sourceBranch":"main","suggestedTargetBranches":["8.7"],"targetPullRequestStates":[{"branch":"8.7","label":"v8.7.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/152634","number":152634,"mergeCommit":{"message":"[DOCS]
Describe how to use Elastic Agent to monitor Kibana (#152634)\n\n##
Summary\r\n\r\nAdd Elastic Agent as another way to collect monitoring
data.\r\n\r\nThis work is tracked
by\r\nhttps://github.com/elastic/observability-docs/issues/2602.\r\n\r\nThere
will be additional PRs to address changes required to monitoring\r\ndocs
for other stack components. TBH, it pains me a bit to see how
many\r\nplaces users need to go to find info about stack monitoring, but
fixing\r\nthat problem is not in scope for these updates unfortunately.
:-/\r\n\r\nPlease respond to questions addressed to
reviewers.\r\n\r\n### Checklist\r\n\r\nDelete any items that are not
applicable to this PR.\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n\r\n###
To Do before merging\r\n\r\n- [x] Remove questions to
reviewers.\r\n\r\n---------\r\n\r\nCo-authored-by: Kevin Lacabane
<klacabane@gmail.com>","sha":"9ff847dec75a5a562cc46d121cbec57c45da177d"}}]}]
BACKPORT-->

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
@github-actions github-actions bot mentioned this issue Mar 23, 2023
Merged
2 tasks
@dedemorton
Copy link
Contributor

All the work here is done except the enterprise search docs, which will be updated by that team. I'll leave this issue open, but I'm done with my part here.

@dedemorton
Copy link
Contributor

Closing now because the enterprise search doc changes are tracked in https://github.com/elastic/enterprise-search-team/issues/4153

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@crespocarlos crespocarlos

@klacabane klacabane

@dedemorton dedemorton

Labels
Feature:Stack Monitoring Team:Infra Monitoring UI Label for the Infrastructure Monitoring UI team v8.7.0
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@matschaffer @smith @crespocarlos @klacabane @dedemorton