monitor-config.md

Monitor Configuration

Monitors gather metrics from the host and from running applications. They are configured in a list called monitors in the main agent config file. These are all of the monitors included in the agent, along with their possible configuration options:

• aspdotnet
• cadvisor
• collectd/activemq
• collectd/apache
• collectd/cassandra
• collectd/chrony
• collectd/consul
• collectd/couchbase
• collectd/cpu
• collectd/cpufreq
• collectd/custom
• collectd/df
• collectd/disk
• collectd/docker
• collectd/elasticsearch
• collectd/etcd
• collectd/genericjmx
• collectd/hadoop
• collectd/hadoopjmx
• collectd/haproxy
• collectd/health-checker
• collectd/interface
• collectd/jenkins
• collectd/kafka
• collectd/kafka_consumer
• collectd/kafka_producer
• collectd/kong
• collectd/load
• collectd/marathon
• collectd/memcached
• collectd/memory
• collectd/mongodb
• collectd/mysql
• collectd/nginx
• collectd/openstack
• collectd/postgresql
• collectd/processes
• collectd/protocols
• collectd/python
• collectd/rabbitmq
• collectd/redis
• collectd/signalfx-metadata
• collectd/solr
• collectd/spark
• collectd/statsd
• collectd/uptime
• collectd/vmem
• collectd/zookeeper
• conviva
• cpu
• disk-io
• docker-container-stats
• dotnet
• ecs-metadata
• elasticsearch
• expvar
• filesystems
• gitlab
• gitlab-gitaly
• gitlab-runner
• gitlab-sidekiq
• gitlab-unicorn
• gitlab-workhorse
• host-metadata
• internal-metrics
• kubelet-stats
• kubernetes-cluster
• kubernetes-events
• kubernetes-volumes
• memory
• net-io
• processlist
• prometheus-exporter
• prometheus/go
• prometheus/nginx-vts
• prometheus/node
• prometheus/postgres
• prometheus/prometheus
• prometheus/redis
• python-monitor
• telegraf/logparser
• telegraf/procstat
• telegraf/snmp
• telegraf/sqlserver
• telegraf/statsd
• telegraf/tail
• telegraf/win_perf_counters
• telegraf/win_services
• trace-forwarder
• vmem
• windows-iis
• windows-legacy

Common Configuration

The following config options are common to all monitors:

Config option	Default	Required	Type	Description
type		no	string	The type of the monitor
discoveryRule		no	string	The rule used to match up this configuration with a discovered endpoint. If blank, the configuration will be run immediately when the agent is started. If multiple endpoints match this rule, multiple instances of the monitor type will be created with the same configuration (except different host/port).
extraDimensions		no	map of string	A set of extra dimensions (key:value pairs) to include on datapoints emitted by the monitor(s) created from this configuration. To specify metrics from this monitor should be high-resolution, add the dimension sf_hires: 1
configEndpointMappings		no	map of string	A set of mappings from a configuration option on this monitor to attributes of a discovered endpoint. The keys are the config option on this monitor and the value can be any valid expression used in discovery rules.
intervalSeconds	0	no	integer	The interval (in seconds) at which to emit datapoints from the monitor(s) created by this configuration. If not set (or set to 0), the global agent intervalSeconds config option will be used instead.
solo	false	no	bool	If one or more configurations have this set to true, only those configurations will be considered. This setting can be useful for testing.
metricsToExclude		no	list of object	A list of metric filters
disableHostDimensions	false	no	bool	Some monitors pull metrics from services not running on the same host and should not get the host-specific dimensions set on them (e.g. host, AWSUniqueId, etc). Setting this to true causes those dimensions to be omitted. You can disable this globally with the disableHostDimensions option on the top level of the config.
disableEndpointDimensions	false	no	bool	This can be set to true if you don't want to include the dimensions that are specific to the endpoint that was discovered by an observer. This is useful when you have an endpoint whose identity is not particularly important since it acts largely as a proxy or adapter for other metrics.