docs: Add content for the new Service Overview page #87496
Conversation
EamonnTP
added
Team:APM
|
Pinging @elastic/apm-ui (Team:apm) |
|
@elasticmachine, run elasticsearch-ci/docs rebuild |
| === Error rate and errors | ||
|
|
||
| The *Error rate* chart displays the average error rates relating to the service, within a specific time range. |
There was a problem hiding this comment.
I think this is fine but just want to clarify that "Error rate" is (somewhat confusingly) based on transaction instead of error documents.
To be exact it is based on the event.outcome field and is the relative number of failed transactions.
We might want to let users in on this secret - or maybe not. Depends on how much detail we can give them without confusing them.
There was a problem hiding this comment.
I feel like I've seen this come up in discuss in the past. I think it makes sense to keep it high-level here, but maybe update the Error rate info on this page with the secret sauce.
There was a problem hiding this comment.
@bmorelli25 Thanks, will do. I included the other update in this PR.
docs/apm/service-overview.asciidoc
Outdated
| which spans could be slowing down transactions. The "app" label displayed under the | ||
| chart indicates that something was happening within the application. This could signal that the | ||
| agent does not have auto-instrumentation for whatever was happening during that time or the time was spent in the |
There was a problem hiding this comment.
add that?
| agent does not have auto-instrumentation for whatever was happening during that time or the time was spent in the | |
| agent does not have auto-instrumentation for whatever was happening during that time or that the time was spent in the |
docs/apm/service-overview.asciidoc
Outdated
| visibility into how a service performs across your infrastructure. To help you isolate | ||
| potential issues, select a <<services,*service*>> to bring you to the *Service overview* page. |
There was a problem hiding this comment.
The working feels a bit strange as-is. What about this?
| The *Service overview* page contains a wide variety of charts and tables that provide | |
| visibility into how a service performs across your infrastructure. To help you isolate | |
| potential issues, select a <<services,*service*>> to bring you to the *Service overview* page. | |
| Selecting a <<services,*service*>> brings you to the *Service overview*. | |
| The *Service overview* contains a wide variety of charts and tables that provide | |
| visibility into how a service performs across your infrastructure. |
* Add service overview content * Edits following reviews * Review edits
Summary
This PR adds content for the new Service Overview page for 7.11.
HTML preview
https://kibana_87496.docs-preview.app.elstc.co/guide/en/kibana/master/service-overview.html
Related issue
Closes #82055