mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
4ed60697e9
### Summary This PR makes a handful of updates to the APM app documentation: - [x] **Alerts tab, workflow, and grouping** - Rewrote most of our [alerting documentation](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/apm-alerts.html#apm-alert-view-active) to explain the new granularity level of alerts, address new alert names, and explain the different ways to view active alerts. - Updated the [Services](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/services.html) documentation to describe the alert badge and link to alerting docs. - _Closes https://github.com/elastic/observability-docs/issues/2887_ - _Closes https://github.com/elastic/observability-docs/issues/2888_ - _Closes https://github.com/elastic/observability-docs/issues/2878_ - [x] **Infrastructure tab** - Added a new [top-level page](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/infrastructure.html) explaining what this page is useful for. - _Closes https://github.com/elastic/observability-docs/issues/2892_ - [x] **Log views and correlation** - Added a new [top-level page ](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/logs.html)that links to our log correlation docs. - Updated our [transaction documentation](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/transactions.html#transaction-trace-sample) with new information and a link to our log correlation docs. - _Closes https://github.com/elastic/observability-docs/issues/2891_ - [x] **New AWS Lambda metrics** - Most of the new charts have tooltips explaining what the charts do. I updated the screenshot and added some additional information to the [overview](https://kibana_160568.docs-preview.app.elstc.co/guide/en/kibana/master/apm-lambda.html) to highlight some of the new features of this page. - _Closes https://github.com/elastic/observability-docs/issues/2890_ - [x] **New screenshots** - I updated any screenshots I noticed were outdated while working on the above content. Screenshot updates are not necessarily related to the changes described above.
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`
|