From cedd8e0e1f07d7ac4c299889d9a40cf45ad0b626 Mon Sep 17 00:00:00 2001 From: 383c57 <383c57@gmail.com> Date: Mon, 6 Mar 2017 21:34:12 +0900 Subject: [PATCH] nsd plugin new file: conf.d/python.d/nsd.conf new file: python.d/nsd.chart.py --- conf.d/Makefile.am | 1 + conf.d/python.d/nsd.conf | 86 +++++++++++++++++++++++++++++++++++++ python.d/Makefile.am | 1 + python.d/nsd.chart.py | 92 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 180 insertions(+) create mode 100644 conf.d/python.d/nsd.conf create mode 100644 python.d/nsd.chart.py diff --git a/conf.d/Makefile.am b/conf.d/Makefile.am index 655d27a7..34374c42 100644 --- a/conf.d/Makefile.am +++ b/conf.d/Makefile.am @@ -43,6 +43,7 @@ dist_pythonconfig_DATA = \ python.d/mongodb.conf \ python.d/mysql.conf \ python.d/nginx.conf \ + python.d/nsd.conf \ python.d/ovpn_status_log.conf \ python.d/phpfpm.conf \ python.d/postfix.conf \ diff --git a/conf.d/python.d/nsd.conf b/conf.d/python.d/nsd.conf new file mode 100644 index 00000000..7566fe85 --- /dev/null +++ b/conf.d/python.d/nsd.conf @@ -0,0 +1,86 @@ +# netdata python.d.plugin configuration for nsd +# +# This file is in YaML format. Generally the format is: +# +# name: value +# +# There are 2 sections: +# - global variables +# - one or more JOBS +# +# JOBS allow you to collect values from multiple sources. +# Each source will have its own set of charts. +# +# JOB parameters have to be indented (using spaces only, example below). + +# ---------------------------------------------------------------------- +# Global Variables +# These variables set the defaults for all JOBs, however each JOB +# may define its own, overriding the defaults. + +# update_every sets the default data collection frequency. +# If unset, the python.d.plugin default is used. +# nsd-control is slow, so once every 30 seconds +# update_every: 30 + +# priority controls the order of charts at the netdata dashboard. +# Lower numbers move the charts towards the top of the page. +# If unset, the default for python.d.plugin is used. +# priority: 60000 + +# retries sets the number of retries to be made in case of failures. +# If unset, the default for python.d.plugin is used. +# Attempts to restore the service are made once every update_every +# and only if the module has collected values in the past. +# retries: 5 + +# ---------------------------------------------------------------------- +# JOBS (data collection sources) +# +# The default JOBS share the same *name*. JOBS with the same name +# are mutually exclusive. Only one of them will be allowed running at +# any time. This allows autodetection to try several alternatives and +# pick the one that works. +# +# Any number of jobs is supported. +# +# All python.d.plugin JOBS (for all its modules) support a set of +# predefined parameters. These are: +# +# job_name: +# name: myname # the JOB's name as it will appear at the +# # dashboard (by default is the job_name) +# # JOBs sharing a name are mutually exclusive +# update_every: 1 # the JOB's data collection frequency +# priority: 60000 # the JOB's order on the dashboard +# retries: 5 # the JOB's number of restoration attempts +# +# Additionally to the above, nsd also supports the following: +# +# command: 'nsd-control stats_noreset' # the command to run +# + +# ---------------------------------------------------------------------- +# IMPORTANT Information +# +# Netdata must have permissions to run `nsd-control stats_noreset` command +# +# - Example-1 (use "sudo") +# 1. sudoers (e.g. visudo -f /etc/sudoers.d/netdata) +# Defaults:netdata !requiretty +# netdata ALL=(ALL) NOPASSWD: /usr/sbin/nsd-control stats_noreset +# 2. etc/netdata/python.d/nsd.conf +# local: +# update_every: 30 +# command: 'sudo /usr/sbin/nsd-control stats_noreset' +# +# - Example-2 (add "netdata" user to "nsd" group) +# usermod -aG nsd netdata +# + +# ---------------------------------------------------------------------- +# AUTO-DETECTION JOBS + +local: + update_every: 30 + command: 'nsd-control stats_noreset' diff --git a/python.d/Makefile.am b/python.d/Makefile.am index 588b924a..bfe28ff2 100644 --- a/python.d/Makefile.am +++ b/python.d/Makefile.am @@ -33,6 +33,7 @@ dist_python_DATA = \ mongodb.chart.py \ mysql.chart.py \ nginx.chart.py \ + nsd.chart.py \ ovpn_status_log.chart.py \ phpfpm.chart.py \ postfix.chart.py \ diff --git a/python.d/nsd.chart.py b/python.d/nsd.chart.py new file mode 100644 index 00000000..7285e039 --- /dev/null +++ b/python.d/nsd.chart.py @@ -0,0 +1,92 @@ +# -*- coding: utf-8 -*- +# Description: NSD `nsd-control stats_noreset` netdata python.d module +# Author: <383c57 at gmail.com> + + +from base import ExecutableService +import re + +# default module values (can be overridden per job in `config`) +priority = 60000 +retries = 5 +update_every = 30 + +# charts order (can be overridden if you want less charts, or different order) +ORDER = ['queries', 'zones', 'protocol', 'type', 'transfer', 'rcode'] + +CHARTS = { + 'queries': { + 'options': [ + None, "queries", 'queries/s', 'queries', 'nsd.queries', 'line'], + 'lines': [ + ['num.queries', 'queries', 'incremental'],]}, + 'zones': { + 'options': [ + None, "zones", 'zones', 'zones', 'nsd.zones', 'stacked'], + 'lines': [ + ['zone.master', 'master', 'absolute'], + ['zone.slave', 'slave', 'absolute'],]}, + 'protocol': { + 'options': [ + None, "protocol", 'queries/s', 'protocol', 'nsd.protocols', 'stacked'], + 'lines': [ + ['num.udp', 'udp', 'incremental'], + ['num.udp6', 'udp6', 'incremental'], + ['num.tcp', 'tcp', 'incremental'], + ['num.tcp6', 'tcp6', 'incremental'],]}, + 'type': { + 'options': [ + None, "query type", 'queries/s', 'query type', 'nsd.type', 'stacked'], + 'lines': [ + ['num.type.A', 'A', 'incremental'], + ['num.type.NS', 'NS', 'incremental'], + ['num.type.CNAME', 'CNAME', 'incremental'], + ['num.type.SOA', 'SOA', 'incremental'], + ['num.type.PTR', 'PTR', 'incremental'], + ['num.type,HINFO', 'HINFO', 'incremental'], + ['num.type.MX', 'MX', 'incremental'], + ['num.type.NAPTR', 'NAPTR', 'incremental'], + ['num.type.TXT', 'TXT', 'incremental'], + ['num.type.AAAA', 'AAAA', 'incremental'], + ['num.type.SRV', 'SRV', 'incremental'], + ['num.type.TYPE255', 'ANY', 'incremental'],]}, + 'transfer': { + 'options': [ + None, "transfer", 'queries/s', 'transfer', 'nsd.transfer', 'stacked'], + 'lines': [ + ['num.opcode.NOTIFY', 'NOTIFY', 'incremental'], + ['num.type.TYPE252', 'AXFR', 'incremental'],]}, + 'rcode': { + 'options': [ + None, "return code", 'queries/s', 'return code', 'nsd.rcode', 'stacked'], + 'lines': [ + ['num.rcode.NOERROR', 'NOERROR', 'incremental'], + ['num.rcode.FORMERR', 'FORMERR', 'incremental'], + ['num.rcode.SERVFAIL', 'SERVFAIL', 'incremental'], + ['num.rcode.NXDOMAIN', 'NXDOMAIN', 'incremental'], + ['num.rcode.NOTIMP', 'NOTIMP', 'incremental'], + ['num.rcode.REFUSED', 'REFUSED', 'incremental'], + ['num.rcode.YXDOMAIN', 'YXDOMAIN', 'incremental'],]} +} + + +class Service(ExecutableService): + def __init__(self, configuration=None, name=None): + ExecutableService.__init__( + self, configuration=configuration, name=name) + self.command = "nsd-control stats_noreset" + self.order = ORDER + self.definitions = CHARTS + self.regex = re.compile(r'([A-Za-z0-9.]+)=(\d+)') + + def _get_data(self): + try: + lines = self._get_raw_data() + r = self.regex + stats = {k: int(v) for k, v in r.findall(''.join(lines))} + stats.setdefault('num.opcode.NOTIFY', 0) + stats.setdefault('num.type.TYPE252', 0) + stats.setdefault('num.type.TYPE255', 0) + return stats + except Exception: + return None -- 2.39.2