Cloud
Also in Self-Managed

benchmark

Logs basic throughput statistics of messages that pass through this processor.

Logs messages per second and bytes per second of messages that are processed at a regular interval. A summary of the amount of messages processed over the entire lifetime of the processor will also be printed when the processor shuts down.

Each rolling log line has the form rolling stats: <n> msg/sec, <size>/sec, for example rolling stats: 1 msg/sec, 407 B/sec. The shutdown summary uses the same form with total stats. When count_bytes is false, the lines omit the bytes figure.

This processor exposes the following metrics:

  • benchmark_messages_per_second (gauge): The current throughput in messages per second.

  • benchmark_messages_total (counter): The total number of messages processed.

  • benchmark_bytes_per_second (gauge): The current throughput in bytes per second.

  • benchmark_bytes_total (counter): The total number of bytes processed.

  • Common

  • Advanced

processor:
  label: ""
  benchmark:
    interval: 5s
    count_bytes: true
processor:
  label: ""
  benchmark:
    interval: 5s
    count_bytes: true

Fields

count_bytes

Whether to measure the number of bytes per second of throughput. If set to true, structured data must be serialized to count the number of bytes processed, which can unnecessarily degrade performance if serialization is not required elsewhere in your pipeline.

Type: bool

Default: true

interval

How often to emit rolling statistics. Set to 0 to log only summary statistics when the processor shuts down.

Type: string

Default: 5s