Metrics
Different metrics are available. Metrics are organized into different categories.
Categories :
- Global
- Per-Providers
How to enable and configure metrics server
You have some options to enable metrics server.
Config File
| Options | Default | Required | Actions |
|---|---|---|---|
| metrics.enable | false |  |
Define if start metrics web server |
| metrics.host | 0.0.0.0 | |
Set IP address for metrics web server |
| metrics.port | 8080 | |
Set port for metrics web server |
| metrics.path | /metrics | |
Path for acceding to metrics web server |
| metrics.logging | false | |
Logging request http endpoint |
metrics.logging
If you enable metrics.logging, you will see a lot of logs.
config.yaml
metrics:
enable: true # Default: false
port: 8080 # Default : 8080
host: 0.0.0.0 # Default: 0.0.0.0
path: /metrics # Default: /metrics
Env Variables
| Options | Actions |
|---|---|
| METRICS_ENABLE | Define if start metrics web server |
| METRICS_HOST | Set IP address for metrics web server |
| METRICS_PORT | Set port for metrics web server |
| METRICS_PATH | Path for acceding to metrics web server |
| METRICS_LOGGING | Logging request http on endpoint |
Metrics details
Global
| Metrics Name | Description |
|---|---|
| go_build_info | Build information about the main Go module |
| go_gc_duration_seconds | Go garbage collection duration |
| go_goroutines | Number of goroutines |
| go_info | Go runtime information |
| go_memstats_* | Go runtime memory statistics |
| go_threads | Number of threads |
AWS Provider
| Metrics Name | Description |
|---|---|
| updateip_aws_func_time | Execution time of each function |
| updateip_aws_status | Return Status of AWS Provider |
| updateip_aws_update | Number of DNS record validity checks |
| updateip_aws_event_receive | Count of events received |
Cloudflare Provider
| Metrics Name | Description |
|---|---|
| updateip_cloudflare_func_time | Execution time of each function |
| updateip_cloudflare_status | Return Status of Cloudflare Provider |
| updateip_cloudflare_update | Number of DNS record validity checks |
| updateip_cloudflare_event_receive | Count of events received |
OVH Provider
| Metrics Name | Description |
|---|---|
| updateip_ovh_func_time | Execution time of each function |
| updateip_ovh_status | Return Status of OVH Provider |
| updateip_ovh_update | Number of DNS record validity checks |
| updateip_ovh_event_receive | Count of events received |