Skip to content

Commit e6d1114

Browse files
committed
Mention in docs that intervals are expected to be integers
1 parent 077cfd9 commit e6d1114

2 files changed

Lines changed: 8 additions & 11 deletions

File tree

docs/reference/metric_definitions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ only floats can be stored!
115115
extra attributes, if any (see below for options). Hit the "ADD METRIC"
116116
button to store.
117117
1. Activate the newly added metric by including it in some existing
118-
    *Preset Config* in the "PRESETS" page or add it directly to the monitored DB,
119-
together with an interval, into the "METRICS" tab when editing a source on the "SOURCES" page.
118+
*Preset Config* in the "PRESETS" page or add it directly to the monitored DB,
119+
together with a fetching interval - integral number of seconds - into the "METRICS" tab when editing a source on the "SOURCES" page.
120120

121121
### For *YAML* based setups
122122

docs/tutorial/custom_installation.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -354,27 +354,24 @@ The content of a file is a array of sources definitions, like this:
354354

355355
```yaml
356356
- name: test1 # An arbitrary unique name for the monitored source
357-
kind: postgres # One of the:
357+
kind: postgres # One of:
358358
# - postgres
359359
# - postgres-continuous-discovery
360360
# - pgbouncer
361361
# - pgpool
362362
# - patroni
363-
# - patroni-continuous-discovery
364-
# - patroni-namespace-discover
365-
# Defaults to postgres if not specified
366363
conn_str: postgresql://pgwatch:xyz@somehost/mydb
367364
preset_metrics: exhaustive # from list of presets defined in "metrics.yaml" or in the config DB
368-
custom_metrics: # map of metrics and intervals, if both preset_metrics and custom_metrics are specified, custom wins
369-
backends: 300
365+
custom_metrics: # map of metrics and intervals, if both preset_metrics and custom_metrics are specified, preset wins
366+
backends: 300 # integral number of seconds
370367
archiver: 120
371368
preset_metrics_standby: # optional preset configuration for standby state, same as preset_metrics
372369
custom_metrics_standby: # optional custom metrics for standby state, same as custom_metrics
373370
include_pattern: # regex to filter databases to actually monitor for the "continuous" modes
374371
exclude_pattern:
375372
is_enabled: true
376-
group: default # just for logical grouping of DB hosts or for "sharding", i.e. splitting the workload between many gatherer daemons
377-
custom_tags: # option to add arbitrary tags for every stored data row,
378-
aws_instance_id: i-0af01c0123456789a # for example to fetch data from some other source onto a same Grafana graph
373+
group: default # just for logical grouping of DB hosts or for "sharding", i.e. splitting the workload between many gatherer daemons (via --group option)
374+
custom_tags: # option to add arbitrary tags for every stored data row,
375+
aws_instance_id: i-0af01c0123456789a # for example to fetch data from some other source onto a same Grafana graph
379376
...
380377
```

0 commit comments

Comments
 (0)