input: add new histogram metric for size of records #10651
+19
−4
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently it's not easy to reason about the size of records passing through Fluentbit over time - e.g. catching if a lot of large records start coming through. You can get a loose proxy by dividing
fluentbit_input_bytes_total
byfluentbit_intput_records_total
, but this is a complete average. Histograms can provide more granular detail in cases like this. This PR adds a new histogram metricfluentbit_input_record_sizes
that observes the size of each input record, alongside the existing total input bytes metric.The default bucket sizes are just a stab in the dark. It would probably be ideal for them to be configurable, but this will involve more work and e.g. limit checks.
Testing
Fluentbit command for testing some input data, with the metrics server enabled
fluent-bit -i tail -p path=./logslurp -p buffer_max_size=4m -o file -m '*' -H
Pump some random data into the input
for size in '100B' '1K' '2K' '4K' '1M';do echo $size; cat /dev/random | base64 -w 0 | dd of=./logslurp bs=$size count=1 oflag=append conv=notrunc;printf "\n" >> logslurp; done
Hit the metrics endpoint to see the metrics:
curl -v localhost:2020/api/v2/metrics/prometheus | grep sizes
:If this is a change to packaging of containers or native binaries then please confirm it works for all targets.
ok-package-test
label to test for all targets (requires maintainer to do).Documentation
Backporting
Fluent Bit is licensed under Apache 2.0, by submitting this pull request I understand that this code will be released under the terms of that license.