diff --git a/README.md b/README.md index 7f00162..2b3be31 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,53 @@ # knot_ -Knot munin stats \ No newline at end of file +Knot munin stats + +## Install + +### Knot config + +Add a "mod-stats" section, e.g. : + + mod-stats: + - id: custom-stats + request-protocol: on + server-operation: on + request-bytes: on + response-bytes: on + edns-presence: on + flag-presence: on + response-code: on + request-edns-option: on + response-edns-option: on + reply-nodata: on + query-type: on + query-size: on + reply-size: on + + +Add a "statistics" section, e.g. : + + statistics: + timer: 60 + file: /tmp/knot-stats.yaml + append: false + +In your zone template, add a "mod-stats", e.g. : + + template: + - id: signed + storage: "/var/db/knot" + semantic-checks: on + dnssec-signing: on + dnssec-policy: shared + module: mod-stats/custom-stats + +### Munin config + +Create "knot" in the plugin-conf.d directory and put : + + [knot_*] + user root + env.stats_file_path /tmp/knot-stats.yaml + +Please adapt the path of the stats file, according to knot config, statistics section.