droxporter/config.yml at main · a14e/droxporter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
endpoint: # default {}
  port: 8888 # default 8888
  host: "0.0.0.0" # default "0.0.0.0"
  auth: # default {}
    enabled: false # default false
    login: "${AUTH_LOGIN:login}" # default login
    password: "${AUTH_PASSWORD:password}" # default password
  ssl: # default {}
    enabled: false # default false
    root-cert-path: "${SSL_ROOT_CERT_PATH:./cert.pem}"  # default ./cert.pem
    key-path: "${SSL_KEY_PATH:./key.pem}" # default ./key.pem


# Custom labels and prefix that can be added to all metrics
custom: # default {}
  prefix: "" # default ""
  labels: # default {}
  # app: droxporter
  # system-type: agent

# Exporter metrics. The interval is used only for reading CPU and memory.
# The metrics list is used to enable only the metrics we need.
exporter-metrics: # default {}
  enabled: true # default false
  interval: 5s  # default 5s
  metrics: # default []
    - cpu
    - memory
    - limits
    - requests
    - jobs

# Default keys to be used
default-keys: [ "${EXPORTER_KEY}" ] # default []

# Droplet polling is always enabled, otherwise there is no point in enabling the exporter.
# Specific keys can be used for polling.
# URL is specified in case Digital Ocean makes changes, but metrics collection should continue.
# Metrics from the metrics section are always included in the response and do not require additional requests,
# so they will not affect the limits. However, if you want to disable them, you have the option.
# 1-hour interval seems reasonable, as droplets rarely change.
droplets: # default {}
  keys: [ ] # default []
  url: "https://api.digitalocean.com/v2/droplets"
  interval: 1h # default 1h
  metrics: # default []
    - memory
    - vcpu
    - disk
    - status

# App Platform polling.
apps:
  keys: [ ]
  url: "https://api.digitalocean.com/v2/apps"
  interval: 1h # default 1h
  metrics: # default []
    - active_deployment_phase

# List of metrics to be loaded
# A separate request will be executed for each type within 'types' for each droplet, so be careful
# not to add too many to avoid hitting request limits
# The intervals are wide because:
##  1. To avoid hitting limits
##  2. Data on Digital Ocean updates infrequently
droplet-metrics: # default {}
  base-url: "https://api.digitalocean.com/v2/monitoring/metrics/droplet"
  bandwidth: # default {}
    types: [ private_inbound, private_outbound, public_inbound, public_outbound ] # default []
    keys: [ ] # default []
    interval: 60s # default 60s
    enabled: true # default false
  cpu: # default {}
    keys: [ ] # default []
    interval: 45s # default 45s
    enabled: true # default false
  filesystem: # default {}
    types: [ free ] # default [], full list: [ free, size ]
    keys: [ ] # default []
    interval: 120s # default 120s
    enabled: true # default false
  memory: # default {}
    types: [ total, available ] # default [], full list: [ cached, free, total, available ]
    keys: [ ] # default []
    interval: 120s # default 120s
    enabled: true # default false
  load: # default {}
    types: [ ] # default [], full list: [ load_1, load_5, load_15 ]
    keys: [ ] # default []
    interval: 120s # default 120s
    enabled: false # default false

app-metrics: # default {}
  base-url: "https://api.digitalocean.com/v2/monitoring/metrics/apps"
  cpu-percentage: # default {}
    keys: [ ] # default []
    interval: 60s
    enabled: true
  memory-percentage: # default {}
    keys: [ ] # default []
    interval: 60s
    enabled: true
  restart-count: # default {}
    keys: [ ] # default []
    interval: 60s
    enabled: true