IBM Cloud Docs
Fluent Bit plug-ins

Fluent Bit plug-ins

The Logging agent includes and supports selected Fluent Bit plug-ins. Some plug-ins are not supported.

The Logging agent is built using Fluent Bit, which is an open source log processor and forwarder. Although Fluent Bit can be built and configured to use a number of different plug-ins, the Logging agent does not include every plug-in available for Fluent Bit. Each plug-in falls into one of three categories:

See About the Logging agent for further information about the agent.

Supported plug-ins

This section lists the Fluent Bit plug-ins which are fully supported by IBM in the Logging agent. IBM owns and maintains these plugins.

Supported output plug-ins

Plug-in Type Description Documentation
logs-router-icl-output-plugin output Send log events directly to IBM Cloud Logs documentation

Plug-ins available but not directly supported

This section lists the Fluent Bit plug-ins which can be used with the Logging agent, but for which IBM does not provide direct support. For questions regarding these plug-ins, clients will need to refer to the appropriate section in the official Fluent Bit documentation.

Available input plug-ins

The Logging agent includes the following Fluent Bit input plug-ins.

Plug-in Type Description Documentation
collectd input Receive datagrams from collectd service documentation
docker-events input Capture docker server events documentation
dummy input Generate dummy events for testing documentation
elasticsearch input Handle Elasticsearch API requests documentation
fluentbit_metrics input Collect Fluent Bit metrics documentation
forward input Listen for Forward messages from Fluentd/Fluent Bit documentation
head input Read events from the head of a file documentation
http input Receive events via HTTP endpoint documentation
kafka input Collect messages from Apache Kafka documentation
kmsg input Read events from Linux kernel log buffer documentation
kubernetes_events input Retrieve Kubernetes API events documentation
mqtt input Receive messages in MQTT control packets over TCP documentation
splunk input Receive Splunk HTTP HEC requests documentation
stdin input Read messages from standard input documentation
syslog input Receive syslog messages documentation
systemd input Collect log messages from journald on Linux documentation
tail input Monitor and read events from text files documentation
tcp input Receive messages over TCP interface documentation
udp input Receive messages over UDP interface documentation
opentelemetry input Receive data in OTLP documentation

Available filter plug-ins

The Logging agent includes the following Fluent Bit filter plug-ins.

Plug-in Type Description Documentation
aws filter Enrich events with AWS metadata for EC2 workloads documentation
checklist filter Check if value from list exists in record documentation
ecs filter Enrich events with AWS ECS metadata documentation
expect filter Ensure that records contain expected keys and values documentation
geoip2 filter Enrich events with GeoIP2 location data documentation
grep filter Select/exclude records based on pattern-matching documentation
kubernetes filter Enrich events with Kubernetes metadata documentation
lua filter Process records using Lua scripts documentation
parser filter Parse individual fields in event records documentation
record_modifier filter Add/remove specific fields documentation
modify filter Modify records based on rules and conditions documentation
multiline filter Concatenate multiple lines into a single event documentation
nest filter Nest/elevate fields within a record documentation
nightfall filter Redact sensitive data within records documentation
rewrite_tag filter Modify record tags for routing documentation
stdout filter Print records to standard output in filter stage documentation
sysinfo filter Add system information to records documentation
throttle filter Flow-control message rate documentation
type_converter filter Convert field types documentation

Available output plug-ins

The Logging agent includes the following Fluent Bit output plug-ins.

Plug-in Type Description Documentation
counter output Count records processed documentation
file output Write records to a file documentation
flowcounter output Count records and sizes documentation
forward output Forward records to another Fluent Bit (or Fluentd) instance documentation
http output Send logs to an HTTP endpoint documentation
logdna output Send logs to IBM Log Analysis documentation
null output Discard events entirely documentation
slack output Send messages to a Slack channel documentation
prometheus_exporter output Expose metrics for Prometheus documentation
prometheus_remote_write output Submit metrics using Prometheus remote write protocol documentation

Plug-ins unavailable in IBM Cloud Logs Routing

This section lists plug-ins which, while part of the open source Fluent Bit project, are not available for use with the Logging agent.

Input plug-ins

The following input plugins are not included with the Logging agent and therefore cannot be used with it.

Plug-in Type Description Documentation
cpu input Collect CPU usage metrics documentation
disk input Collect disk I/O metrics documentation
exec input Execute an external program to generate logs documentation
exec_wasi input Execute external WASM program to generate logs documentation
health input Check health of a TCP server documentation
mem input Collect memory and swap usage metrics documentation
netif input Collect network metrics as log events documentation
nginx_metrics input Scrape NGINX metrics documentation
node_exporter_metrics input Collect system-level metrics documentation
podman_metrics input Collect metrics from podman containers documentation
proc input Collect log-based process metrics documentation
process_exporter_metrics input Collect process metrics documentation
prometheus_scrape input Scrape metrics from Prometheus endpoint documentation
prometheus_remote_write input Ingest Prometheus remote-write payloads documentation
random input Generate random values documentation
serial input Collect messages/data via serial interface documentation
statsd input Receive metrics via StatsD protocol documentation
thermal input Report system temperature documentation
winlog input Read Windows Event Log documentation
winevtlog input Read Windows Event Log using winevt API documentation
windows_exporter_metrics input Collect system/host metrics on Windows systems documentation

Filter plug-ins

The following filter plug-ins are not included in the Logging agent and therefore cannot be used with it.

Plug-in Type Description Documentation
log_to_metrics filter Generate log-based metrics documentation
tensorflow filter Run Tensorflow machine learning tasks on log records documentation
wasm filter Use Wasm programs as filters documentation

Output plugins

The followng output plug-ins are not included in the Logging agent and therefore cannot be used with it.

Plug-in Type Description Documentation
cloudwatch_logs output Send logs and metrics to Amazon CloudWatch documentation
kinesis_firehose output Send logs to Amazon Kinesis Firehose documentation
kinesis_streams output Send logs to Amazon Kinesis Streams documentation
s3 output Send data to Amazon S3 documentation
azure_blob output Send records to Azure Blob Storage documentation
azure_kusto output Send logs to Azure Data Explorer (Kusto) documentation
azure output Send logs to Azure Log Analytics documentation
azure_logs_ingestion output Send logs using Azure Logs Ingestion API documentation
datadog output Send logs to Datadog documentation
es output Send logs to Elasticsearch documentation
gelf output Send logs in Graylog Extended Log Format documentation
chronicle output Send logs to Google Chronicle documentation
bigquery output Send logs to Google Cloud BigQuery documentation
influxdb output Send logs to an InfluxDB database documentation
kafka output Send logs to Apache Kafka documentation
kafka-rest output Send logs to an Apache Kafka REST Proxy server documentation
loki output Send logs to Grafana Loki documentation
nats output Send logs to a NATS server documentation
nrlogs output Send logs to New Relic documentation
oracle_log_analytics output Send logs to Oracle Cloud Infrastructure Logging Analytics documentation
opensearch output Send logs to Amazon OpenSearch documentation
opentelemetry output Send logs and data to an OpenTelemetry endpoint documentation
pgsql output Send logs to a PostgreSQL database as JSONB documentation
skywalking output Send logs to Apache SkyWalking documentation
splunk output Send logs to a Splunk HTTP Event Collector documentation
stackdriver output Send logs to Google Cloud Stackdriver Logging documentation
syslog output Deliver messages to Syslog servers documentation
tcp output Send logs to a TCP server documentation
td output Send logs to Treasure Data documentation
vivo_exporter output Send logs and data to Calyptia Vivo documentation
websocket output Send logs to a WebSocket endpoint documentation

Plugins not listed above are unsupported, and their functionality is not guaranteed.