Skip to content

Latest commit

 

History

History
150 lines (111 loc) · 4.18 KB

README.md

File metadata and controls

150 lines (111 loc) · 4.18 KB
Raw

td-agent_exporter

CircleCI

td-agent exporter for Prometheus

supported td-agent versions

td-agent4

exported metrics

  • td_agent_cpu_time
  • td_agent_resident_memory_usage
  • td_agent_virtual_memory_usage
  • td_agent_up

command line options

Name Description Default note
web.listen-address Address on which to expose metrics and web interface 9256
web.telemetry-path Path under which to expose metrics /metrics
fluentd.process_file_name fluentd's process file name. ruby For example, td-agent is being executed from /opt/td-agent/embedded/bin/fluentd, specify "fluentd".
fluentd.process_name_prefix fluentd's process_name prefix see also: Fluentd official documentation
log.level Log level info

How to configure

td-agent_exporter find td-agent processes to collect metrics.
If you use process_name in td-agent.conf like the following, please use fluentd.process_name_prefix option for td-agent_exporter.

If td-agent has process_name setting

example setting of td-agent and its process name.

  • td-agent.conf

    <system>
  process_name foo_1
</system>

<match debug.**>
  @type stdout
</match>

<source>
  @type forward
  port 24224
</source>

  • td-agent processes

    $ ps -ef | egrep '(^UID|td-agen[t])'
UID        PID  PPID  C STIME TTY          TIME CMD
td-agent  1918     1  0 15:30 ?        00:00:00 supervisor:foo_1
td-agent  1921  1918 16 15:30 ?        00:00:00 worker:foo_1

  • Option for td-agent_exporter

    In this case, fluentd.process_name_prefix is required for td-agent_exporter like the following.

    /path/to/td-agent_exporter -fluentd.process_name_prefix=foo

  • Exported metrics example

    td-agent's process name is be used as id label.

    # HELP td_agent_cpu_time td-agent cpu time
# TYPE td_agent_cpu_time gauge
td_agent_cpu_time{id="foo_1"} 0.94
# HELP td_agent_resident_memory_usage td-agent resident memory usage
# TYPE td_agent_resident_memory_usage gauge
td_agent_resident_memory_usage{id="foo_1"} 4.1304064e+07
# HELP td_agent_virtual_memory_usage td-agent virtual memory usage
# TYPE td_agent_virtual_memory_usage gauge
td_agent_virtual_memory_usage{id="foo_1"} 2.82308608e+08
# HELP td_agent_up the td-agent processes
# TYPE td_agent_up gauge
td_agent_up 1

If td-agent doesn't have process_name setting

In this case, don't need to use fluentd.process_name_prefix.

example setting of td-agent without process_name

  • td-agent.conf

    <match debug.**>
  @type stdout
</match>

<source>
  @type forward
  port 24224
</source>

  • td-agent processes

    $ ps -ef | egrep '(^UID|td-agen[t])'
UID        PID  PPID  C STIME TTY          TIME CMD
td-agent   872     1  0 14:22 ?        00:00:00 /opt/td-agent/bin/ruby /opt/td-agent/bin/fluentd --log /var/log/td-agent/td-agent.log --daemon /var/run/td-agent/td-agent.pid
td-agent   875   872  0 14:22 ?        00:00:02 /opt/td-agent/bin/ruby -Eascii-8bit:ascii-8bit /opt/td-agent/bin/fluentd --log /var/log/td-agent/td-agent.log --daemon /var/run/td-agent/td-agent.pid --under-supervisor

  • Exported metrics example

    # HELP td_agent_cpu_time td-agent cpu time
# TYPE td_agent_cpu_time gauge
td_agent_cpu_time{id="default"} 0
# HELP td_agent_resident_memory_usage td-agent resident memory usage
# TYPE td_agent_resident_memory_usage gauge
td_agent_resident_memory_usage{id="default"} 1.0993664e+07
# HELP td_agent_virtual_memory_usage td-agent virtual memory usage
# TYPE td_agent_virtual_memory_usage gauge
td_agent_virtual_memory_usage{id="default"} 7.69163264e+08
# HELP td_agent_up the td-agent processes
# TYPE td_agent_up gauge
td_agent_up 1

How to build

$ make build-all

How to run unit tests

$ make unittest

How to run e2e tests

$ make e2etest-with-docker