Monitor Metrics

JMX Configuration

Agent provides the ability of monitoring indicators in JMX and Prometheus mode, and JMX mode is used by default. The monitoring indicators have been registered to MBeanServer Users can add similar JMX (port and authentication are adjusted according to the situation) to the startup parameters of the Agent to realize the collection of monitoring indicators from the remote end.

  1. -Dcom.sun.management.jmxremote
  2. -Djava.rmi.server.hostname=127.0.0.1
  3. -Dcom.sun.management.jmxremote.port=9999
  4. -Dcom.sun.management.jmxremote.authenticate=false
  5. -Dcom.sun.management.jmxremote.ssl=false

Prometheus Configuration

You can declare whether to enable Prometheus and HTTPServer port in agent.properties.

  1. # the default is false
  2. agent.prometheus.enable=true
  3. # the default is 8080
  4. agent.prometheus.exporter.port=8080

Appendix: Metrics Items

AgentTaskMetric

propertydescription
runningTaskstasks currently being executed
retryingTasksTasks that are currently being retried
fatalTasksThe total number of currently failed tasks

JobMetrics

propertydescription
runningJobsthe total number of currently running jobs
fatalJobsthe total number of currently failed jobs

PluginMetric

propertydescription
readNumthe number of reads
sendNumthe number of sent items
sendFailedNumthe number of failed sending
readFailedNumthe number of failed reads
readSuccessNumthe number of successful reads
sendSuccessNumthe number of successfully sent

SourceMetric

propertytypedescription
agent_source_count_successCounterthe success message count in agent source since agent started
agent_source_count_failCounterthe sink success message count in agent source since agent started

SinkMetric

propertytypedescription
agent_sink_count_successCounterthe sink success message count in agent source since agent started
agent_sink_count_failCounterthe sink failed message count in agent source since agent started