Skip to main content

Fluentd

Plugin: go.d.plugin Module: fluentd

Overview​

This collector monitors Fluentd servers.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior​

Auto-Detection​

This integration doesn't support auto-detection.

Limits​

The default configuration for this integration does not impose any limits on data collection.

Performance Impact​

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics​

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Fluentd instance​

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

MetricDimensionsUnit
fluentd.retry_counta dimension per plugincount
fluentd.buffer_queue_lengtha dimension per pluginqueue_length
fluentd.buffer_total_queued_sizea dimension per pluginqueued_size

Alerts​

There are no alerts configured by default for this integration.

Setup​

Prerequisites​

Enable monitor agent​

To enable monitor agent, follow the official documentation.

Configuration​

File​

The configuration file name for this integration is go.d/fluentd.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/fluentd.conf

Options​

The following options can be defined globally: update_every, autodetection_retry.

Config options
NameDescriptionDefaultRequired
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
urlServer URL.http://127.0.0.1:24220yes
timeoutHTTP request timeout.2no
usernameUsername for basic HTTP authentication.no
passwordPassword for basic HTTP authentication.no
proxy_urlProxy URL.no
proxy_usernameUsername for proxy basic HTTP authentication.no
proxy_passwordPassword for proxy basic HTTP authentication.no
methodHTTP request method.GETno
bodyHTTP request body.no
headersHTTP request headers.no
not_follow_redirectsRedirect handling policy. Controls whether the client follows redirects.nono
tls_skip_verifyServer certificate chain and hostname validation policy. Controls whether the client performs this check.nono
tls_caCertification authority that the client uses when verifying the server's certificates.no
tls_certClient TLS certificate.no
tls_keyClient TLS key.no

Examples​

Basic​

A basic example configuration.

jobs:
- name: local
url: http://127.0.0.1:24220

HTTP authentication​

Basic HTTP authentication.

Config
jobs:
- name: local
url: http://127.0.0.1:24220
username: username
password: password

HTTPS with self-signed certificate​

Fluentd with enabled HTTPS and self-signed certificate.

Config
jobs:
- name: local
url: https://127.0.0.1:24220
tls_skip_verify: yes

Multi-instance​

Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

Config
jobs:
- name: local
url: http://127.0.0.1:24220

- name: remote
url: http://192.0.2.1:24220

Troubleshooting​

Debug Mode​

To troubleshoot issues with the fluentd collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m fluentd

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.