monitoring-rest-api.md

Monitoring by REST API

This article describes how to get the internal Fluentd metrics via the REST API.

Monitoring Agent

Fluentd has a monitoring agent to retrieve internal metrics in JSON format via HTTP.

Add these lines to your configuration file:

<source>
  @type monitor_agent
  bind 0.0.0.0
  port 24220
</source>

Restart the agent and get the metrics via HTTP:

$ curl http://host:24220/api/plugins.json
{
  "plugins":[
    {
      "plugin_id":"object:3fec669d6ac4",
      "type":"forward",
      "output_plugin":false,
      "config":{
        "type":"forward"
      }
    },
    {
      "plugin_id":"object:3fec669dfa48",
      "type":"monitor_agent",
      "output_plugin":false,
      "config":{
        "type":"monitor_agent",
        "port":"24220"
      }
    },
    {
      "plugin_id":"object:3fec66aead48",
      "type":"forward",
      "output_plugin":true,
      "buffer_queue_length":0,
      "buffer_total_queued_size":0,
      "retry_count":0,
      "config":{
        "type":"forward",
        "host":"192.168.0.11"
      }
    }
  ]
}

See in_monitor_agent article for more detail.

Monitoring the Event Flow

Use flowcounter or flowcounter_simple plugin.

Datadog (dd-agent) Integration

Datadog is a cloud monitoring service, and its monitoring agent dd-agent has native integration with Fluentd.

For more details:

• Datadog-Fluentd Integration

If this article is incorrect or outdated, or omits critical information, please let us know. Fluentd is an open-source project under Cloud Native Computing Foundation (CNCF). All components are available under the Apache 2 License.