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

[APM] Documentation updates #160951

Merged
merged 5 commits into from
Jun 30, 2023
Merged

[APM] Documentation updates #160951

merged 5 commits into from
Jun 30, 2023

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Jun 29, 2023

Summary

This PR makes a handful of updates to the APM app documentation:

@bmorelli25 bmorelli25 self-assigned this Jun 29, 2023
@github-actions
Copy link
Contributor

Documentation preview:

@bmorelli25 bmorelli25 added the release_note:skip Skip the PR/issue when compiling release notes label Jun 29, 2023
@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@bmorelli25 bmorelli25 marked this pull request as ready for review June 30, 2023 04:16
@bmorelli25 bmorelli25 added the Team:APM All issues that need APM UI Team support label Jun 30, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/apm-ui (Team:APM)

Copy link
Member Author

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
Copy link
Member Author

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?

@bmorelli25 bmorelli25 requested a review from a team June 30, 2023 04:20
Copy link
Member

@sorenlouv sorenlouv left a comment

Choose a reason for hiding this comment

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

Thanks @bmorelli25 !

@bmorelli25 bmorelli25 merged commit 9efbd22 into elastic:main Jun 30, 2023
@bmorelli25 bmorelli25 deleted the more-apm-docs branch June 30, 2023 18:49
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jun 30, 2023
### 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)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jun 30, 2023
### 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)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.8
8.9

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Jun 30, 2023
# 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]>
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Feb 20, 2024
@kibanamachine
Copy link
Contributor

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
@kibanamachine
Copy link
Contributor

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.

@bmorelli25 bmorelli25 removed backport missing Added to PRs automatically when the are determined to be missing a backport. v8.8.2 labels Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:APM All issues that need APM UI Team support v8.9.0 v8.10.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[REQUEST]: Dependencies Operations [REQUEST]: Agent Explorer [REQUEST]: Trace Explorer
5 participants