mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
63faa6723e
# Backport This will backport the following commits from `main` to `8.9`: - [[APM] Documentation updates (#160568)](https://github.com/elastic/kibana/pull/160568) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Brandon Morelli","email":"brandon.morelli@elastic.co"},"sourceCommit":{"committedDate":"2023-06-30T18:02:58Z","message":"[APM] Documentation updates (#160568)\n\n### Summary\r\n\r\nThis PR makes a handful of updates to the APM app documentation:\r\n\r\n- [x] **Alerts tab, workflow, and grouping**\r\n- Rewrote most of our [alerting\r\ndocumentation](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/apm-alerts.html#apm-alert-view-active)\r\nto explain the new granularity level of alerts, address new alert names,\r\nand explain the different ways to view active alerts.\r\n- Updated the\r\n[Services](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/services.html)\r\ndocumentation to describe the alert badge and link to alerting docs.\r\n - _Closes https://github.com/elastic/observability-docs/issues/2887_\r\n - _Closes https://github.com/elastic/observability-docs/issues/2888_\r\n - _Closes https://github.com/elastic/observability-docs/issues/2878_\r\n- [x] **Infrastructure tab**\r\n- Added a new [top-level\r\npage](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/infrastructure.html)\r\nexplaining what this page is useful for.\r\n - _Closes https://github.com/elastic/observability-docs/issues/2892_\r\n- [x] **Log views and correlation**\r\n- Added a new [top-level page\r\n](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/logs.html)that\r\nlinks to our log correlation docs.\r\n- Updated our [transaction\r\ndocumentation](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/transactions.html#transaction-trace-sample)\r\nwith new information and a link to our log correlation docs.\r\n - _Closes https://github.com/elastic/observability-docs/issues/2891_\r\n- [x] **New AWS Lambda metrics**\r\n- Most of the new charts have tooltips explaining what the charts do. I\r\nupdated the screenshot and added some additional information to the\r\n[overview](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/apm-lambda.html)\r\nto highlight some of the new features of this page.\r\n - _Closes https://github.com/elastic/observability-docs/issues/2890_\r\n- [x] **New screenshots**\r\n- I updated any screenshots I noticed were outdated while working on the\r\nabove content. Screenshot updates are not necessarily related to the\r\nchanges described above.","sha":"4ed60697e97b7120eec7d0130da28ca900ca90e9","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v8.8.0","v8.9.0","v8.10.0"],"number":160568,"url":"https://github.com/elastic/kibana/pull/160568","mergeCommit":{"message":"[APM] Documentation updates (#160568)\n\n### Summary\r\n\r\nThis PR makes a handful of updates to the APM app documentation:\r\n\r\n- [x] **Alerts tab, workflow, and grouping**\r\n- Rewrote most of our [alerting\r\ndocumentation](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/apm-alerts.html#apm-alert-view-active)\r\nto explain the new granularity level of alerts, address new alert names,\r\nand explain the different ways to view active alerts.\r\n- Updated the\r\n[Services](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/services.html)\r\ndocumentation to describe the alert badge and link to alerting docs.\r\n - _Closes https://github.com/elastic/observability-docs/issues/2887_\r\n - _Closes https://github.com/elastic/observability-docs/issues/2888_\r\n - _Closes https://github.com/elastic/observability-docs/issues/2878_\r\n- [x] **Infrastructure tab**\r\n- Added a new [top-level\r\npage](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/infrastructure.html)\r\nexplaining what this page is useful for.\r\n - _Closes https://github.com/elastic/observability-docs/issues/2892_\r\n- [x] **Log views and correlation**\r\n- Added a new [top-level page\r\n](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/logs.html)that\r\nlinks to our log correlation docs.\r\n- Updated our [transaction\r\ndocumentation](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/transactions.html#transaction-trace-sample)\r\nwith new information and a link to our log correlation docs.\r\n - _Closes https://github.com/elastic/observability-docs/issues/2891_\r\n- [x] **New AWS Lambda metrics**\r\n- Most of the new charts have tooltips explaining what the charts do. I\r\nupdated the screenshot and added some additional information to the\r\n[overview](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/apm-lambda.html)\r\nto highlight some of the new features of this page.\r\n - _Closes https://github.com/elastic/observability-docs/issues/2890_\r\n- [x] **New screenshots**\r\n- I updated any screenshots I noticed were outdated while working on the\r\nabove content. Screenshot updates are not necessarily related to the\r\nchanges described above.","sha":"4ed60697e97b7120eec7d0130da28ca900ca90e9"}},"sourceBranch":"main","suggestedTargetBranches":["8.8","8.9"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.9","label":"v8.9.0","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/160568","number":160568,"mergeCommit":{"message":"[APM] Documentation updates (#160568)\n\n### Summary\r\n\r\nThis PR makes a handful of updates to the APM app documentation:\r\n\r\n- [x] **Alerts tab, workflow, and grouping**\r\n- Rewrote most of our [alerting\r\ndocumentation](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/apm-alerts.html#apm-alert-view-active)\r\nto explain the new granularity level of alerts, address new alert names,\r\nand explain the different ways to view active alerts.\r\n- Updated the\r\n[Services](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/services.html)\r\ndocumentation to describe the alert badge and link to alerting docs.\r\n - _Closes https://github.com/elastic/observability-docs/issues/2887_\r\n - _Closes https://github.com/elastic/observability-docs/issues/2888_\r\n - _Closes https://github.com/elastic/observability-docs/issues/2878_\r\n- [x] **Infrastructure tab**\r\n- Added a new [top-level\r\npage](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/infrastructure.html)\r\nexplaining what this page is useful for.\r\n - _Closes https://github.com/elastic/observability-docs/issues/2892_\r\n- [x] **Log views and correlation**\r\n- Added a new [top-level page\r\n](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/logs.html)that\r\nlinks to our log correlation docs.\r\n- Updated our [transaction\r\ndocumentation](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/transactions.html#transaction-trace-sample)\r\nwith new information and a link to our log correlation docs.\r\n - _Closes https://github.com/elastic/observability-docs/issues/2891_\r\n- [x] **New AWS Lambda metrics**\r\n- Most of the new charts have tooltips explaining what the charts do. I\r\nupdated the screenshot and added some additional information to the\r\n[overview](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/apm-lambda.html)\r\nto highlight some of the new features of this page.\r\n - _Closes https://github.com/elastic/observability-docs/issues/2890_\r\n- [x] **New screenshots**\r\n- I updated any screenshots I noticed were outdated while working on the\r\nabove content. Screenshot updates are not necessarily related to the\r\nchanges described above.","sha":"4ed60697e97b7120eec7d0130da28ca900ca90e9"}}]}] BACKPORT--> Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
57 lines
2.7 KiB
Text
57 lines
2.7 KiB
Text
[role="xpack"]
|
|
[[services]]
|
|
=== Services
|
|
|
|
*Service* inventory provides a quick, high-level overview of the health and general
|
|
performance of all instrumented services.
|
|
|
|
To help surface potential issues, services are sorted by their health status:
|
|
**critical** > **warning** > **healthy** > **unknown**.
|
|
Health status is powered by <<machine-learning-integration,machine learning>>
|
|
and requires anomaly detection to be enabled.
|
|
|
|
In addition to health status, active alerts for each service are prominently displayed in the service inventory table. Selecting an active alert badge brings you to the <<apm-alerts,Alerts>> tab where you can learn more about the active alert and take action.
|
|
|
|
[role="screenshot"]
|
|
image::apm/images/apm-services-overview.png[Example view of services table the APM app in Kibana]
|
|
|
|
[float]
|
|
[[service-groups]]
|
|
==== Service groups
|
|
|
|
beta::[]
|
|
|
|
Group services together to build meaningful views that remove noise, simplify investigations across services,
|
|
and <<apm-alert-view-group,combine related alerts>>.
|
|
Service groups are {kib} space-specific and available for any users with appropriate access.
|
|
|
|
// This screenshot is reused in the alerts docs
|
|
// Ensure it has an active alert showing
|
|
[role="screenshot"]
|
|
image::apm/images/apm-service-group.png[Example view of service group in the APM app in Kibana]
|
|
|
|
To enable Service groups, open {kib} and navigate to **Stack Management** > **Advanced Settings** > **Observability**,
|
|
and enable the **Service groups feature**.
|
|
|
|
To create a service group, navigate to **Observability** > **APM** > **Services** and select **Create group**.
|
|
Specify a name, color, and description.
|
|
Then, using the <<kuery-query, Kibana Query Language (KQL)>>, specify a query to select services for the group.
|
|
Services that match the query within the last 24 hours will be assigned to the group.
|
|
|
|
[NOTE]
|
|
====
|
|
Once a service group has been saved, this list of services within it is static.
|
|
If a newly added service matches the KQL query, it will not be automatically added to the service group.
|
|
Similarly, if a service stops matching the KQL query, it will not be removed from the group.
|
|
|
|
To update the list of services within a group,
|
|
edit the service group, click **Refresh** next to the KQL query, and click **Save group**.
|
|
====
|
|
|
|
**Examples**
|
|
|
|
Not sure where to get started? Here are some sample queries you can build from:
|
|
|
|
* Group services by environment--in this example, "production": `service.environment : "production"`
|
|
* Group services by name--this example groups those that end in "beat": `service.name : *beat` (matches services named "Auditbeat", "Heartbeat", "Filebeat", etc.)
|
|
* Group services with a high transaction duration in the last 24 hours: `transaction.duration.us >= 50000000`
|