Skip to content

Commit

Permalink
document infinite flow metric rates (#14975) (#14999)
Browse files Browse the repository at this point in the history
(cherry picked from commit cb9316b)

Co-authored-by: Ry Biesemeyer <[email protected]>
  • Loading branch information
github-actions[bot] and yaauie authored Apr 11, 2023
1 parent 5f8a600 commit e2e16ad
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/static/monitoring/monitoring-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -499,6 +499,9 @@ Example response:
}
--------------------------------------------------

NOTE: When the rate for a given flow metric window is infinite, it is presented as a string (either `"Infinity"` or `"-Infinity"`).
This occurs when the numerator metric has changed during the window without a change in the rate's denominator metric.

Flow rates provide visibility into how a Logstash instance or an individual pipeline is _currently_ performing relative to _itself_ over time.
This allows us to attach _meaning_ to the cumulative-value metrics that are also presented by this API, and to determine whether an instance or pipeline is behaving better or worse than it has in the past.

Expand Down Expand Up @@ -1028,7 +1031,7 @@ It is useful for identifying which plugins in a pipeline are using the available
| Filters, Outputs | `worker_millis_per_event` |
This metric is expressed in worker-millis-spent-per-event (`duration_in_millis` / `events.in`) with higher scores indicating more resources spent per event.
It is especially useful for identifying issues with plugins that operate on a small subset of events.
An `"Infinity"` value for a given flow window indicates that worker millis have been spent without any events completing processing, and can indicate a plugin that is stuck.
An `"Infinity"` value for a given flow window indicates that worker millis have been spent without any events completing processing; this can indicate a plugin that is either stuck or handling only empty batches.

|===
[discrete]
Expand Down

0 comments on commit e2e16ad

Please sign in to comment.