Query parameters

• pretty boolean

  If you append ?pretty=true to the request, the JSON returned will be pretty formatted. Use it for debugging only!

Responses

• 200 application/json

  A JSON object containing pipelines statistics.

  • the number of events that were input, filtered, or output by each pipeline
  • the current and lifetime [flow rates](https://www.elastic.co/guide/en/logstash/current/node-stats-api.html#flow-stats for each pipeline
  • stats for each configured filter or output stage
  • info about config reload successes and failures (when config reload is enabled)
  • info about the persistent queue (when persistent queues are enabled)
  Hide response attribute Show response attribute object

  • pipelines object

    A map where each key is a user-defined pipeline name, and the value contains the metrics for that pipeline.

    Hide pipelines attribute Show pipelines attribute object

    • * object Additional properties

      Metrics of each plugin in the pipeline, flow statistics, event statistics and queue statistics.

      Hide * attributes Show * attributes object

      • events object
        Hide events attributes Show events attributes object

        • in integer(int64)
        • filtered integer(int64)
        • out integer(int64)
        • duration_in_millis integer(int64)
        • queue_push_duration_in_millis integer(int64)

      • flow object

        One of:

        PipelineMQFlowStats object PipelinePQFlowStats object

        Hide attributes Show attributes

        • input_throughput object

          This metric is expressed in events-per-second, and is the rate of events being pushed into the pipeline(s) queue(s) relative to wall-clock time (events.in / second). It includes events that are blocked by the queue and have not yet been accepted.

          Hide input_throughput attributes Show input_throughput attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        • filter_throughput object

          This metric is expressed in events-per-second, and is the rate of events flowing through the filter phase of the pipeline(s) relative to wall-clock time (events.filtered / second).

          Hide filter_throughput attributes Show filter_throughput attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        • output_throughput object

          This metric is expressed in events-per-second, and is the rate of events flowing through the output phase of the pipeline(s) relative to wall-clock time (events.out / second).

          Hide output_throughput attributes Show output_throughput attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        • queue_backpressure object

          This is a unitless metric representing the cumulative time spent by all inputs blocked pushing events into their pipeline’s queue, relative to wall-clock time (queue_push_duration_in_millis / millisecond). It is typically most useful when looking at the stats for an individual pipeline.

          While a "zero" value indicates no back-pressure to the queue, the magnitude of this metric is highly dependent on the shape of the pipelines and their inputs. It cannot be used to compare one pipeline to another or even one process to itself if the quantity or shape of its pipelines changes. A pipeline with only one single-threaded input may contribute up to 1.00, a pipeline whose inputs have hundreds of inbound connections may contribute much higher numbers to this combined value.

          Additionally, some amount of back-pressure is both normal and expected for pipelines that are pulling data, as this back-pressure allows them to slow down and pull data at a rate its downstream pipeline can tolerate.

          Hide queue_backpressure attributes Show queue_backpressure attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        • worker_concurrency object

          This is a unitless metric representing the cumulative time spent by all workers relative to wall-clock time (duration_in_millis / millisecond).

          A pipeline is considered "saturated" when its worker_concurrency flow metric approaches its available pipeline.workers, because it indicates that all of its available workers are being kept busy. Tuning a saturated pipeline to have more workers can often work to increase that pipeline’s throughput and decrease back-pressure to its queue, unless the pipeline is experiencing back-pressure from its outputs.

          A process is also considered "saturated" when its top-level worker_concurrency flow metric approaches the cumulative pipeline.workers across all pipelines, and similarly can be addressed by tuning the individual pipelines that are saturated.

          Hide worker_concurrency attributes Show worker_concurrency attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        • worker_utilization object

          This is a unitless metric that indicates the percentage of available worker time being used by this individual plugin (duration / (uptime * pipeline.workers). It is useful for identifying which plugins in a pipeline are using the available worker resources.

          A pipeline is considered "saturated" when worker_utilization approaches 100, because it indicates that all of its workers are being kept busy. This is typically an indication of either downstream back-pressure or insufficient resources allocated to the pipeline. Tuning a saturated pipeline to have more workers can often work to increase that pipeline’s throughput and decrease back-pressure to its queue, unless the pipeline is experiencing back-pressure from its outputs.

          A pipeline is considered "starved" when worker_utilization approaches 0, because it indicates that none of its workers are being kept busy. This is typically an indication that the inputs are not receiving or retrieving enough volume to keep the pipeline workers busy. Tuning a starved pipeline to have fewer workers can help it to consume less memory and CPU, freeing up resources for other pipelines.

          Hide worker_utilization attributes Show worker_utilization attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        Hide attributes Show attributes

        • input_throughput object

          This metric is expressed in events-per-second, and is the rate of events being pushed into the pipeline(s) queue(s) relative to wall-clock time (events.in / second). It includes events that are blocked by the queue and have not yet been accepted.

          Hide input_throughput attributes Show input_throughput attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        • filter_throughput object

          This metric is expressed in events-per-second, and is the rate of events flowing through the filter phase of the pipeline(s) relative to wall-clock time (events.filtered / second).

          Hide filter_throughput attributes Show filter_throughput attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        • output_throughput object

          This metric is expressed in events-per-second, and is the rate of events flowing through the output phase of the pipeline(s) relative to wall-clock time (events.out / second).

          Hide output_throughput attributes Show output_throughput attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        • queue_backpressure object

          This is a unitless metric representing the cumulative time spent by all inputs blocked pushing events into their pipeline’s queue, relative to wall-clock time (queue_push_duration_in_millis / millisecond). It is typically most useful when looking at the stats for an individual pipeline.

          While a "zero" value indicates no back-pressure to the queue, the magnitude of this metric is highly dependent on the shape of the pipelines and their inputs. It cannot be used to compare one pipeline to another or even one process to itself if the quantity or shape of its pipelines changes. A pipeline with only one single-threaded input may contribute up to 1.00, a pipeline whose inputs have hundreds of inbound connections may contribute much higher numbers to this combined value.

          Additionally, some amount of back-pressure is both normal and expected for pipelines that are pulling data, as this back-pressure allows them to slow down and pull data at a rate its downstream pipeline can tolerate.

          Hide queue_backpressure attributes Show queue_backpressure attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        • worker_concurrency object

          This is a unitless metric representing the cumulative time spent by all workers relative to wall-clock time (duration_in_millis / millisecond).

          A pipeline is considered "saturated" when its worker_concurrency flow metric approaches its available pipeline.workers, because it indicates that all of its available workers are being kept busy. Tuning a saturated pipeline to have more workers can often work to increase that pipeline’s throughput and decrease back-pressure to its queue, unless the pipeline is experiencing back-pressure from its outputs.

          A process is also considered "saturated" when its top-level worker_concurrency flow metric approaches the cumulative pipeline.workers across all pipelines, and similarly can be addressed by tuning the individual pipelines that are saturated.

          Hide worker_concurrency attributes Show worker_concurrency attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        • worker_utilization object

          This is a unitless metric that indicates the percentage of available worker time being used by this individual plugin (duration / (uptime * pipeline.workers). It is useful for identifying which plugins in a pipeline are using the available worker resources.

          A pipeline is considered "saturated" when worker_utilization approaches 100, because it indicates that all of its workers are being kept busy. This is typically an indication of either downstream back-pressure or insufficient resources allocated to the pipeline. Tuning a saturated pipeline to have more workers can often work to increase that pipeline’s throughput and decrease back-pressure to its queue, unless the pipeline is experiencing back-pressure from its outputs.

          A pipeline is considered "starved" when worker_utilization approaches 0, because it indicates that none of its workers are being kept busy. This is typically an indication that the inputs are not receiving or retrieving enough volume to keep the pipeline workers busy. Tuning a starved pipeline to have fewer workers can help it to consume less memory and CPU, freeing up resources for other pipelines.

          Hide worker_utilization attributes Show worker_utilization attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        • queue_persisted_growth_bytes object

          This metric is expressed in bytes-per-second, and is the rate of change of the size of the persistent queue on disk, relative to wall-clock time (queue.queue_size_in_bytes / second). A positive number indicates that the queue size-on-disk is growing, and a negative number indicates that the queue is shrinking.

          NOTE: The size of a PQ on disk includes both unacknowledged events and previously-acknowledged events from pages that contain one or more unprocessed events. This means it grows gradually as individual events are added, but shrinks in large chunks each time a whole page of processed events is reclaimed (read more: PQ disk garbage collection).

          Hide queue_persisted_growth_bytes attributes Show queue_persisted_growth_bytes attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

        • queue_persisted_growth_events object

          This metric is expressed in events-per-second, and is the rate of change of the number of unacknowledged events in the queue, relative to wall-clock time (queue.events_count / second). A positive number indicates that the queue’s event-count is growing, and a negative number indicates that the queue is shrinking.

          Hide queue_persisted_growth_events attributes Show queue_persisted_growth_events attributes object

          • current number(double) | string

            The most recent ~10s.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_minute number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_5_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_15_minutes number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_1_hour number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • last_24_hours number(double) | string

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

          • lifetime number(double) | string

            The lifetime of the relevant pipeline or process.

            One of:

            number-1 number(double) string-2 string

            Value is Infinity.

      • plugins object
        Hide plugins attributes Show plugins attributes object

        • inputs array[object]
          Hide inputs attributes Show inputs attributes object

          • id string
          • name string
          • flow object
            Hide flow attribute Show flow attribute object

            • throughput object

              This metric is expressed in events-per-second, and is the rate of events this input plugin is pushing into the pipeline’s queue relative to wall-clock time (events.in / second). It includes events that are blocked by the queue and have not yet been accepted.

              Hide throughput attributes Show throughput attributes object

              • current number(double) | string

                The most recent ~10s.

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_1_minute number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_5_minutes number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_15_minutes number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_1_hour number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_24_hours number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • lifetime number(double) | string

                The lifetime of the relevant pipeline or process.

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

          • events object
            Hide events attributes Show events attributes object

            • out integer(int64)
            • queue_push_duration_in_millis integer(int64)
        • codecs array[object]
          Hide codecs attributes Show codecs attributes object

          • id string
          • name string
          • decode object
            Hide decode attributes Show decode attributes object

            • duration_in_millis integer
            • writes_in integer
            • out integer
          • encode object
            Hide encode attributes Show encode attributes object

            • duration_in_millis integer
            • writes_in integer
        • filters array[object]
          Hide filters attributes Show filters attributes object

          • id string
          • name string
          • flow object
            Hide flow attributes Show flow attributes object

            • worker_utilization object

              This is a unitless metric that indicates the percentage of available worker time being used by this individual plugin (duration / (uptime * pipeline.workers). It is useful for identifying which plugins in a pipeline are using the available worker resources.

              Hide worker_utilization attributes Show worker_utilization attributes object

              • current number(double) | string

                The most recent ~10s.

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_1_minute number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_5_minutes number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_15_minutes number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_1_hour number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_24_hours number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • lifetime number(double) | string

                The lifetime of the relevant pipeline or process.

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

            • worker_millis_per_event object

              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; this can indicate a plugin that is either stuck or handling only empty batches.

              Hide worker_millis_per_event attributes Show worker_millis_per_event attributes object

              • current number(double) | string

                The most recent ~10s.

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_1_minute number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_5_minutes number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_15_minutes number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_1_hour number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_24_hours number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • lifetime number(double) | string

                The lifetime of the relevant pipeline or process.

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

          • events object
            Hide events attributes Show events attributes object

            • in integer(int64)
            • out integer(int64)
            • duration_in_millis integer(int64)
        • outputs array[object]
          Hide outputs attributes Show outputs attributes object

          • id string
          • name string
          • flow object
            Hide flow attributes Show flow attributes object

            • worker_utilization object

              This is a unitless metric that indicates the percentage of available worker time being used by this individual plugin (duration / (uptime * pipeline.workers). It is useful for identifying which plugins in a pipeline are using the available worker resources.

              Hide worker_utilization attributes Show worker_utilization attributes object

              • current number(double) | string

                The most recent ~10s.

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_1_minute number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_5_minutes number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_15_minutes number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_1_hour number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_24_hours number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • lifetime number(double) | string

                The lifetime of the relevant pipeline or process.

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

            • worker_millis_per_event object

              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; this can indicate a plugin that is either stuck or handling only empty batches.

              Hide worker_millis_per_event attributes Show worker_millis_per_event attributes object

              • current number(double) | string

                The most recent ~10s.

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_1_minute number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_5_minutes number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_15_minutes number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_1_hour number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • last_24_hours number(double) | string

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

              • lifetime number(double) | string

                The lifetime of the relevant pipeline or process.

                One of:

                number-1 number(double) string-2 string

                Value is Infinity.

          • events object
            Hide events attributes Show events attributes object

            • in integer(int64)
            • out integer(int64)
            • duration_in_millis integer(int64)
      • reloads object
        Hide reloads attributes Show reloads attributes object

        • last_error string | null
        • successes integer(int64)
        • last_success_timestamp string(date-time) | null
        • last_failure_timestamp string(date-time) | null
        • failures integer(int64)

      • queue object

        One of:

        object-1 object object-2 object

        The metrics of persisted queue.

        Hide attributes Show attributes

        • type string Discriminator

          Value is persisted.

        • capacity object
          Hide capacity attributes Show capacity attributes object

          • max_unread_events integer(int64)
          • page_capacity_in_bytes integer(int64)
          • max_queue_size_in_bytes integer(int64)
          • queue_size_in_bytes integer(int64)
        • data object
          Hide data attributes Show data attributes object

          • path string
          • free_space_in_bytes integer(int64)
          • storage_type string
        • events integer(int64)
        • events_count integer(int64)
        • queue_size_in_bytes integer(int64)
        • max_queue_size_in_bytes integer(int64)

        The metrics of memory queue.

        Hide attributes Show attributes

        • type string Discriminator

          Value is memory.

        • events_count integer(int64)
        • queue_size_in_bytes integer(int64)
        • max_queue_size_in_bytes integer(int64)
      • pipeline object
        Hide pipeline attributes Show pipeline attributes object

        • workers integer
        • batch_size integer
        • batch_delay integer
      • hash string

        A unique hash identifier.

      • ephemeral_id string(uuid)

        A temporary unique identifier for the instance.