dstore-dist-top-reporter
Command Arguments¶
dstore-dist-top-reporter [-config file] [-debug] [-trace]
Description¶
dstore-dist-top-reporter generates reports from the protobuf messages
that are generated by recursor and dnsdist. It is configured using a
YAML-based configuration file.
dstore-dist-top-reporter is configured with a set of streams, which consist of
all the possible message inputs for reports. Each stream can have different sampling rates
applied upstream, and so it is important to configure the stream with the correct sampling
rate so that the statistics can be correctly calculated.
It is also configured with a set of reports; each report is based on a stream and reports differ based on the key that is used to generate the report, as well as the frequency that the report is generated and the number of "top-N" entries that will be output in the report.
An important concept for summary reports (i.e. when the output of many reports will be summarized over a much longer time period) is "oversampling", i.e. specifying a much higher number for "N" than would be needed in the final report; this ensures that the summarized report is much more accurate than it would be without oversampling.
Finally, the storage backends for reports can be configured - reports can be sent to HTTP and/or Elasticsearch backends. By default reports are sent to all configured backends, but storage backends can be configured to only accept specific reports.
Flags¶
| Flag | Argument | Description |
|---|---|---|
| -config | <file> |
Load configuration from <file> |
| -debug | Generate debug logging | |
| -trace | Generate trace logging | |
| -help | Display a helpful message and exit |
Files¶
/etc/pdns-dstore-dist/dstore-dist-top-reporter.yml: Default location of the config file
Configuration¶
See Configuration of dstore-dist-top-reporter for details of the configuration file format.