Skip to content

Commit 9be8d80

Browse files
author
Helen Campbell
committed
Update documentation with metrics_server_info type
1 parent 6a567ec commit 9be8d80

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,25 @@ Integer: How often to collect metrics, in minutes. Defaults to `5`.
5757

5858
Integer: How long to retain collect metrics, in days. Defaults to `90`.
5959

60+
##### metrics_server_info
61+
62+
Struct:
63+
metrics_server_type => Enum['influxdb','graphite'],
64+
hostname => String,
65+
port => Optional[Integer],
66+
db_name => Optional[String],
67+
68+
Specifies a metrics server to write data to. Currently it supports `influxdb` and `graphite` type servers. The parameters `metrics_server_type` and `hostname` are both required, and `dbname` is required for a `metrics_server_type` of `influxdb`.
69+
70+
Example:
71+
```
72+
Puppet_metrics_collector::Metrics_server{ 'collectmydataplease':
73+
metrics_server_type => 'influxdb',
74+
hostname => 'my.hostname.here',
75+
port => 1234,
76+
db_name => 'mycooldbname',
77+
}]
78+
```
6079

6180
## Usage
6281

0 commit comments

Comments
 (0)