-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[APM] Documentation updates #160951
[APM] Documentation updates #160951
Conversation
Documentation preview: |
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
Pinging @elastic/apm-ui (Team:APM) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@yngrdyn — you were listed as the contact for Agent explorer. Do you have anything to add here?
|
||
[float] | ||
[[trace-explorer]] | ||
==== Trace explorer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dgieselaar there's not really any substance in the docs I've added here. Can you help me understand what trace explorer adds—why would someone want to use this feature and how can they benefit from it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @bmorelli25 !
### Summary This PR makes a handful of updates to the APM app documentation: - [x] **Agent explorer** - New page [here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/agent-explorer.html). - _Closes https://github.com/elastic/observability-docs/issues/2886_ - [x] **Trace explorer** - New section [here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/traces.html#trace-explorer). - _Closes https://github.com/elastic/observability-docs/issues/2885_ - [x] **Dependency operations** - New section [here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/dependencies.html#dependencies-operations). - _Closes https://github.com/elastic/observability-docs/issues/2889_ - [x] **Adds missing settings and APM Labs info** - We didn't have documentation on how to enable APM Labs. We [do now](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/apm-settings-in-kibana.html#apm-labs). - I noticed Labs settings were missing from the documentation. Those have now been added to the [Kibana advanced settings](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/advanced-options.html#observability-advanced-settings). (cherry picked from commit 9efbd22)
### Summary This PR makes a handful of updates to the APM app documentation: - [x] **Agent explorer** - New page [here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/agent-explorer.html). - _Closes https://github.com/elastic/observability-docs/issues/2886_ - [x] **Trace explorer** - New section [here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/traces.html#trace-explorer). - _Closes https://github.com/elastic/observability-docs/issues/2885_ - [x] **Dependency operations** - New section [here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/dependencies.html#dependencies-operations). - _Closes https://github.com/elastic/observability-docs/issues/2889_ - [x] **Adds missing settings and APM Labs info** - We didn't have documentation on how to enable APM Labs. We [do now](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/apm-settings-in-kibana.html#apm-labs). - I noticed Labs settings were missing from the documentation. Those have now been added to the [Kibana advanced settings](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/advanced-options.html#observability-advanced-settings). (cherry picked from commit 9efbd22)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
# Backport This will backport the following commits from `main` to `8.9`: - [[APM] Documentation updates (#160951)](#160951) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Brandon Morelli","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-06-30T18:49:43Z","message":"[APM] Documentation updates (#160951)\n\n### Summary\r\n\r\nThis PR makes a handful of updates to the APM app documentation:\r\n\r\n- [x] **Agent explorer**\r\n- New page\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/agent-explorer.html).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2886_\r\n- [x] **Trace explorer**\r\n- New section\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/traces.html#trace-explorer).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2885_\r\n- [x] **Dependency operations**\r\n- New section\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/dependencies.html#dependencies-operations).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2889_\r\n- [x] **Adds missing settings and APM Labs info**\r\n- We didn't have documentation on how to enable APM Labs. We [do\r\nnow](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/apm-settings-in-kibana.html#apm-labs).\r\n- I noticed Labs settings were missing from the documentation. Those\r\nhave now been added to the [Kibana advanced\r\nsettings](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/advanced-options.html#observability-advanced-settings).","sha":"9efbd2243cfd4fe9db98cb610f997ae46113cff3","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:APM","release_note:skip","v8.9.0","v8.8.2","v8.10.0"],"number":160951,"url":"https://github.com/elastic/kibana/pull/160951","mergeCommit":{"message":"[APM] Documentation updates (#160951)\n\n### Summary\r\n\r\nThis PR makes a handful of updates to the APM app documentation:\r\n\r\n- [x] **Agent explorer**\r\n- New page\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/agent-explorer.html).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2886_\r\n- [x] **Trace explorer**\r\n- New section\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/traces.html#trace-explorer).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2885_\r\n- [x] **Dependency operations**\r\n- New section\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/dependencies.html#dependencies-operations).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2889_\r\n- [x] **Adds missing settings and APM Labs info**\r\n- We didn't have documentation on how to enable APM Labs. We [do\r\nnow](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/apm-settings-in-kibana.html#apm-labs).\r\n- I noticed Labs settings were missing from the documentation. Those\r\nhave now been added to the [Kibana advanced\r\nsettings](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/advanced-options.html#observability-advanced-settings).","sha":"9efbd2243cfd4fe9db98cb610f997ae46113cff3"}},"sourceBranch":"main","suggestedTargetBranches":["8.9","8.8"],"targetPullRequestStates":[{"branch":"8.9","label":"v8.9.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.8","label":"v8.8.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/160951","number":160951,"mergeCommit":{"message":"[APM] Documentation updates (#160951)\n\n### Summary\r\n\r\nThis PR makes a handful of updates to the APM app documentation:\r\n\r\n- [x] **Agent explorer**\r\n- New page\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/agent-explorer.html).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2886_\r\n- [x] **Trace explorer**\r\n- New section\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/traces.html#trace-explorer).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2885_\r\n- [x] **Dependency operations**\r\n- New section\r\n[here](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/dependencies.html#dependencies-operations).\r\n - _Closes https://github.com/elastic/observability-docs/issues/2889_\r\n- [x] **Adds missing settings and APM Labs info**\r\n- We didn't have documentation on how to enable APM Labs. We [do\r\nnow](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/apm-settings-in-kibana.html#apm-labs).\r\n- I noticed Labs settings were missing from the documentation. Those\r\nhave now been added to the [Kibana advanced\r\nsettings](https://kibana_160951.docs-preview.app.elstc.co/guide/en/kibana/master/advanced-options.html#observability-advanced-settings).","sha":"9efbd2243cfd4fe9db98cb610f997ae46113cff3"}}]}] BACKPORT--> Co-authored-by: Brandon Morelli <[email protected]>
Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync. |
1 similar comment
Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync. |
Summary
This PR makes a handful of updates to the APM app documentation: