Skip to content

Latest commit

 

History

History
137 lines (112 loc) · 9.59 KB

coredns.md

File metadata and controls

137 lines (112 loc) · 9.59 KB
Raw

coredns

Monitor Type: coredns (Source)

Accepts Endpoints: Yes

Multiple Instances Allowed: Yes

Overview

This monitor scrapes prometheus metrics exposed by CoreDNS. The default port for these metrics are exposed on port 9153, at the /metrics path. For more information about CoreDNS prometheus metrics, check out their documentation.

The following is an example configuration for a Kubernetes environment:

monitors:
- type: coredns
  discoveryRule: kubernetes_pod_name =~ "coredns" && port == 9153
  extraDimensions:
    metric_source: "k8s-coredns"

Configuration

To activate this monitor in the Smart Agent, add the following to your agent config:

monitors:  # All monitor config goes under this key
 - type: coredns
   ...  # Additional config

For a list of monitor options that are common to all monitors, see Common Configuration.

Config option Required Type Description
httpTimeout no int64 HTTP timeout duration for both read and writes. This should be a duration string that is accepted by https://golang.org/pkg/time/#ParseDuration (default: 10s)
username no string Basic Auth username to use on each request, if any.
password no string Basic Auth password to use on each request, if any.
useHTTPS no bool If true, the agent will connect to the server using HTTPS instead of plain HTTP. (default: false)
httpHeaders no map of strings A map of HTTP header names to values. Comma separated multiple values for the same message-header is supported.
skipVerify no bool If useHTTPS is true and this option is also true, the exporter's TLS cert will not be verified. (default: false)
caCertPath no string Path to the CA cert that has signed the TLS cert, unnecessary if skipVerify is set to false.
clientCertPath no string Path to the client TLS cert to use for TLS required connections
clientKeyPath no string Path to the client TLS key to use for TLS required connections
host yes string Host of the exporter
port yes integer Port of the exporter
useServiceAccount no bool Use pod service account to authenticate. (default: false)
metricPath no string Path to the metrics endpoint on the exporter server, usually /metrics (the default). (default: /metrics)
sendAllMetrics no bool Send all the metrics that come out of the Prometheus exporter without any filtering. This option has no effect when using the prometheus exporter monitor directly since there is no built-in filtering, only when embedding it in other monitors. (default: false)

Metrics

These are the metrics available for this monitor. Metrics that are categorized as container/host (default) are in bold and italics in the list below.

  • coredns_build_info (gauge)
    A metric with a constant '1' value labeled by version, revision, and goversion from which CoreDNS was built.
  • coredns_cache_hits_total (cumulative)
    The count of cache misses.
  • coredns_cache_misses_total (cumulative)
    The count of cache misses.
  • coredns_cache_size (cumulative)
    Size of DNS cache.
  • coredns_dns_request_count_total (cumulative)
    Counter of DNS requests made per zone, protocol and family.
  • coredns_dns_request_duration_seconds (cumulative)
    Histogram of the time (in seconds) each request took. (sum)
  • coredns_dns_request_duration_seconds_bucket (cumulative)
    Histogram of the time (in seconds) each request took. (bucket)
  • coredns_dns_request_duration_seconds_count (cumulative)
    Histogram of the time (in seconds) each request took. (count)
  • coredns_dns_request_size_bytes (cumulative)
    Size of the EDNS0 UDP buffer in bytes (64K for TCP). (sum)
  • coredns_dns_request_size_bytes_bucket (cumulative)
    Size of the EDNS0 UDP buffer in bytes (64K for TCP). (bucket)
  • coredns_dns_request_size_bytes_count (cumulative)
    Size of the EDNS0 UDP buffer in bytes (64K for TCP). (count)
  • coredns_dns_request_type_count_total (cumulative)
    Counter of DNS requests per type, per zone.
  • coredns_dns_response_rcode_count_total (cumulative)
    Counter of response status codes.
  • coredns_dns_response_size_bytes (cumulative)
    Size of the returned response in bytes. (sum)
  • coredns_dns_response_size_bytes_bucket (cumulative)
    Size of the returned response in bytes. (bucket)
  • coredns_dns_response_size_bytes_count (cumulative)
    Size of the returned response in bytes. (count)
  • coredns_health_request_duration_seconds (cumulative)
    Histogram of the time (in seconds) each request took. (sum)
  • coredns_health_request_duration_seconds_bucket (cumulative)
    Histogram of the time (in seconds) each request took. (bucket)
  • coredns_health_request_duration_seconds_count (cumulative)
    Histogram of the time (in seconds) each request took. (count)
  • coredns_panic_count_total (cumulative)
    A metrics that counts the number of panics.
  • coredns_proxy_request_count_total (cumulative)
    Counter of requests made per protocol, proxy protocol, family and upstream.
  • coredns_proxy_request_duration_seconds (cumulative)
    Histogram of the time (in seconds) each request took. (sum)
  • coredns_proxy_request_duration_seconds_bucket (cumulative)
    Histogram of the time (in seconds) each request took. (bucket)
  • coredns_proxy_request_duration_seconds_count (cumulative)
    Histogram of the time (in seconds) each request took. (count)
  • go_gc_duration_seconds (cumulative)
    A summary of the GC invocation durations. (sum)
  • go_gc_duration_seconds_count (cumulative)
    A summary of the GC invocation durations. (count)
  • go_gc_duration_seconds_quantile (gauge)
    A summary of the GC invocation durations. (quantized)
  • go_goroutines (gauge)
    Number of goroutines that currently exist.
  • go_memstats_alloc_bytes (gauge)
    Number of bytes allocated and still in use.
  • go_memstats_alloc_bytes_total (cumulative)
    Total number of bytes allocated, even if freed.
  • go_memstats_buck_hash_sys_bytes (gauge)
    Number of bytes used by the profiling bucket hash table.
  • go_memstats_frees_total (cumulative)
    Total number of frees.
  • go_memstats_gc_sys_bytes (gauge)
    Number of bytes used for garbage collection system metadata.
  • go_memstats_heap_alloc_bytes (gauge)
    Number of heap bytes allocated and still in use.
  • go_memstats_heap_idle_bytes (gauge)
    Number of heap bytes waiting to be used.
  • go_memstats_heap_inuse_bytes (gauge)
    Number of heap bytes that are in use.
  • go_memstats_heap_objects (gauge)
    Number of allocated objects.
  • go_memstats_heap_released_bytes_total (cumulative)
    Total number of heap bytes released to OS.
  • go_memstats_heap_sys_bytes (gauge)
    Number of heap bytes obtained from system.
  • go_memstats_last_gc_time_seconds (gauge)
    Number of seconds since 1970 of last garbage collection.
  • go_memstats_lookups_total (cumulative)
    Total number of pointer lookups.
  • go_memstats_mallocs_total (cumulative)
    Total number of mallocs.
  • go_memstats_mcache_inuse_bytes (gauge)
    Number of bytes in use by mcache structures.
  • go_memstats_mcache_sys_bytes (gauge)
    Number of bytes used for mcache structures obtained from system.
  • go_memstats_mspan_inuse_bytes (gauge)
    Number of bytes in use by mspan structures.
  • go_memstats_mspan_sys_bytes (gauge)
    Number of bytes used for mspan structures obtained from system.
  • go_memstats_next_gc_bytes (gauge)
    Number of heap bytes when next garbage collection will take place.
  • go_memstats_other_sys_bytes (gauge)
    Number of bytes used for other system allocations.
  • go_memstats_stack_inuse_bytes (gauge)
    Number of bytes in use by the stack allocator.
  • go_memstats_stack_sys_bytes (gauge)
    Number of bytes obtained from system for stack allocator.
  • go_memstats_sys_bytes (gauge)
    Number of bytes obtained by system. Sum of all system allocations.
  • process_cpu_seconds_total (cumulative)
    Total user and system CPU time spent in seconds.
  • process_max_fds (gauge)
    Maximum number of open file descriptors.
  • process_open_fds (gauge)
    Number of open file descriptors.
  • process_resident_memory_bytes (gauge)
    Resident memory size in bytes.
  • process_start_time_seconds (gauge)
    Start time of the process since unix epoch in seconds.
  • process_virtual_memory_bytes (gauge)
    Virtual memory size in bytes.

Non-default metrics (version 4.7.0+)

To emit metrics that are not default, you can add those metrics in the generic monitor-level extraMetrics config option. Metrics that are derived from specific configuration options that do not appear in the above list of metrics do not need to be added to extraMetrics.

To see a list of metrics that will be emitted you can run agent-status monitors after configuring this monitor in a running agent instance.