diff --git a/collectors/customCmdMetric.md b/collectors/customCmdMetric.md index e69de29..d38e914 100644 --- a/collectors/customCmdMetric.md +++ b/collectors/customCmdMetric.md @@ -0,0 +1,20 @@ + +## `customcmd` collector + +```json + "customcmd": { + "exclude_metrics": [ + "mymetric" + ], + "files" : [ + "/var/run/myapp.metrics" + ], + "commands" : [ + "/usr/local/bin/getmetrics.pl" + ], + } +``` + +The `customcmd` collector reads data from files and the output of executed commands. The files and commands can output multiple metrics (separated by newline) but the have to be in the [InfluxDB line protocol](https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol/). If a metric is not parsable, it is skipped. If a metric is not required, it can be excluded from forwarding it to the sink. + +