1 # -*- coding: utf-8 -*-
2 # Description: example netdata python.d module
3 # Authors: facetoe, dangtranhoang
6 from copy import deepcopy
9 from psycopg2 import extensions
10 from psycopg2.extras import DictCursor
12 from base import SimpleService
14 # default module values
19 # Default Config options.
24 # 'host': 'localhost',
30 CAST(COUNT(*) AS INT) AS file_count,
31 CAST(COALESCE(SUM(CAST(archive_file ~ $r$\.ready$$r$ as INT)), 0) AS INT) AS ready_count,
32 CAST(COALESCE(SUM(CAST(archive_file ~ $r$\.done$$r$ AS INT)), 0) AS INT) AS done_count
34 pg_catalog.pg_ls_dir('pg_xlog/archive_status') AS archive_files (archive_file);
39 count(*) - (SELECT count(*) FROM pg_stat_activity WHERE state = 'idle') AS backends_active,
40 (SELECT count(*) FROM pg_stat_activity WHERE state = 'idle' ) AS backends_idle
47 ((sum(relpages) * 8) * 1024) AS size_relations,
50 WHERE relkind IN ('r', 't');
55 ((sum(relpages) * 8) * 1024) AS size_indexes,
58 WHERE relkind = 'i';"""
62 datname AS database_name,
63 sum(numbackends) AS connections,
64 sum(xact_commit) AS xact_commit,
65 sum(xact_rollback) AS xact_rollback,
66 sum(blks_read) AS blks_read,
67 sum(blks_hit) AS blks_hit,
68 sum(tup_returned) AS tup_returned,
69 sum(tup_fetched) AS tup_fetched,
70 sum(tup_inserted) AS tup_inserted,
71 sum(tup_updated) AS tup_updated,
72 sum(tup_deleted) AS tup_deleted,
73 sum(conflicts) AS conflicts
75 WHERE NOT datname ~* '^template\d+'
76 GROUP BY database_name;
79 BGWRITER = 'SELECT * FROM pg_stat_bgwriter;'
82 pg_database.datname as database_name,
86 INNER JOIN pg_database ON pg_database.oid = pg_locks.database
87 GROUP BY datname, mode
88 ORDER BY datname, mode;
96 replay_offset - (sent_xlog - replay_xlog) * 255 * 16 ^ 6 ) AS byte_lag
99 client_addr, client_hostname, state,
100 ('x' || lpad(split_part(sent_location, '/', 1), 8, '0'))::bit(32)::bigint AS sent_xlog,
101 ('x' || lpad(split_part(replay_location, '/', 1), 8, '0'))::bit(32)::bigint AS replay_xlog,
102 ('x' || lpad(split_part(sent_location, '/', 2), 8, '0'))::bit(32)::bigint AS sent_offset,
103 ('x' || lpad(split_part(replay_location, '/', 2), 8, '0'))::bit(32)::bigint AS replay_offset
104 FROM pg_stat_replication
112 'ShareUpdateExclusiveLock',
113 'AccessExclusiveLock',
115 'ShareRowExclusiveLock',
120 ORDER = ['db_stat_transactions', 'db_stat_tuple_read', 'db_stat_tuple_returned', 'db_stat_tuple_write',
121 'backend_process', 'index_count', 'index_size', 'table_count', 'table_size', 'wal', 'background_writer']
124 'db_stat_transactions': {
125 'options': [None, ' Transactions', 'Count', ' database statistics', '.db_stat_transactions', 'line'],
127 ['db_stat_xact_commit', 'Committed', 'absolute'],
128 ['db_stat_xact_rollback', 'Rolled Back', 'absolute']
130 'db_stat_connections': {
131 'options': [None, ' Connections', 'Count', ' database statistics', '.db_stat_connections', 'line'],
133 ['db_stat_connections', 'Connections', 'absolute']
135 'db_stat_tuple_read': {
136 'options': [None, ' Tuple read', 'Count', ' database statistics', '.db_stat_tuple_read', 'line'],
138 ['db_stat_blks_read', 'Disk', 'absolute'],
139 ['db_stat_blks_hit', 'Cache', 'absolute']
141 'db_stat_tuple_returned': {
142 'options': [None, ' Tuple returned', 'Count', ' database statistics', '.db_stat_tuple_returned', 'line'],
144 ['db_stat_tup_returned', 'Sequential', 'absolute'],
145 ['db_stat_tup_fetched', 'Bitmap', 'absolute']
147 'db_stat_tuple_write': {
148 'options': [None, ' Tuple write', 'Count', ' database statistics', '.db_stat_tuple_write', 'line'],
150 ['db_stat_tup_inserted', 'Inserted', 'absolute'],
151 ['db_stat_tup_updated', 'Updated', 'absolute'],
152 ['db_stat_tup_deleted', 'Deleted', 'absolute'],
153 ['db_stat_conflicts', 'Conflicts', 'absolute']
156 'options': [None, 'Backend processes', 'Count', 'Backend processes', 'postgres.backend_process', 'line'],
158 ['backend_process_active', 'Active', 'absolute'],
159 ['backend_process_idle', 'Idle', 'absolute']
162 'options': [None, 'Total index', 'Count', 'Index', 'postgres.index_count', 'line'],
164 ['index_count', 'Total index', 'absolute']
167 'options': [None, 'Index size', 'MB', 'Index', 'postgres.index_size', 'line'],
169 ['index_size', 'Size', 'absolute', 1, 1024 * 1024]
172 'options': [None, 'Total table', 'Count', 'Table', 'postgres.table_count', 'line'],
174 ['table_count', 'Total table', 'absolute']
177 'options': [None, 'Table size', 'MB', 'Table', 'postgres.table_size', 'line'],
179 ['table_size', 'Size', 'absolute', 1, 1024 * 1024]
182 'options': [None, 'WAL stats', 'Files', 'WAL', 'postgres.wal', 'line'],
184 ['wal_total', 'Total', 'absolute'],
185 ['wal_ready', 'Ready', 'absolute'],
186 ['wal_done', 'Done', 'absolute']
188 'background_writer': {
189 'options': [None, 'Checkpoints', 'Count', 'Background Writer', 'postgres.background_writer', 'line'],
191 ['background_writer_scheduled', 'Scheduled', 'absolute'],
192 ['background_writer_requested', 'Requested', 'absolute']
197 class Service(SimpleService):
198 def __init__(self, configuration=None, name=None):
199 super(self.__class__, self).__init__(configuration=configuration, name=name)
201 self.definitions = CHARTS
202 self.configuration = configuration
203 self.connection = None
206 self.databases = set()
209 params = dict(user='postgres',
214 params.update(self.configuration)
215 if not self.connection:
216 self.connection = psycopg2.connect(**params)
217 self.connection.set_isolation_level(extensions.ISOLATION_LEVEL_AUTOCOMMIT)
218 self.connection.set_session(readonly=True)
223 self.discover_databases()
224 self._create_definitions()
226 except Exception as e:
230 def _create_definitions(self):
231 for database_name in self.databases:
232 self.databases.add(database_name)
233 for chart_template_name in list(CHARTS):
234 if chart_template_name.startswith('db_stat'):
235 self._add_database_stat_chart(chart_template_name, database_name)
236 self._add_database_lock_chart(database_name)
238 def discover_databases(self):
239 cursor = self.connection.cursor()
242 FROM pg_stat_database
243 WHERE NOT datname ~* '^template\d+'
245 self.databases = set(r[0] for r in cursor)
248 def _add_database_stat_chart(self, chart_template_name, database_name):
249 chart_template = CHARTS[chart_template_name]
250 chart_name = "{}_{}".format(database_name, chart_template_name)
251 if chart_name not in self.order:
252 self.order.insert(0, chart_name)
253 name, title, units, family, context, chart_type = chart_template['options']
254 self.definitions[chart_name] = {
257 database_name + title,
259 database_name + family,
260 database_name + context,
265 self.definitions[chart_name]['lines'] = []
266 for line in deepcopy(chart_template['lines']):
267 line[0] = "{}_{}".format(database_name, line[0])
268 self.definitions[chart_name]['lines'].append(line)
270 def _add_database_lock_chart(self, database_name):
271 chart_name = "{}_locks".format(database_name)
272 if chart_name not in self.order:
273 self.order.insert(0, chart_name)
274 self.definitions[chart_name] = dict(
278 database_name + ' locks',
280 database_name + ' database statistics',
281 database_name + '.locks',
287 for lock_type in LOCK_TYPES:
288 lock_id = "{}_{}".format(database_name, lock_type.lower())
289 label = re.sub("([a-z])([A-Z])", "\g<1> \g<2>", lock_type)
290 self.definitions[chart_name]['lines'].append([lock_id, label, 'absolute'])
295 cursor = self.connection.cursor(cursor_factory=DictCursor)
296 self.add_stats(cursor)
301 def add_stats(self, cursor):
302 self.add_database_stats(cursor)
303 self.add_backend_stats(cursor)
304 self.add_index_stats(cursor)
305 self.add_table_stats(cursor)
306 self.add_lock_stats(cursor)
307 self.add_bgwriter_stats(cursor)
309 # self.add_replication_stats(cursor)
311 # add_wal_metrics needs superuser to get directory listings
312 # if self.config.get('superuser', True):
313 # self.add_wal_stats(cursor)
315 def add_database_stats(self, cursor):
316 cursor.execute(DATABASE)
318 database_name = row.get('database_name')
319 self.add_derive_value('db_stat_xact_commit', prefix=database_name, value=int(row.get('xact_commit', 0)))
320 self.add_derive_value('db_stat_xact_rollback', prefix=database_name, value=int(row.get('xact_rollback', 0)))
321 self.add_derive_value('db_stat_blks_read', prefix=database_name, value=int(row.get('blks_read', 0)))
322 self.add_derive_value('db_stat_blks_hit', prefix=database_name, value=int(row.get('blks_hit', 0)))
323 self.add_derive_value('db_stat_tup_returned', prefix=database_name, value=int(row.get('tup_returned', 0)))
324 self.add_derive_value('db_stat_tup_fetched', prefix=database_name, value=int(row.get('tup_fetched', 0)))
325 self.add_derive_value('db_stat_tup_inserted', prefix=database_name, value=int(row.get('tup_inserted', 0)))
326 self.add_derive_value('db_stat_tup_updated', prefix=database_name, value=int(row.get('tup_updated', 0)))
327 self.add_derive_value('db_stat_tup_deleted', prefix=database_name, value=int(row.get('tup_deleted', 0)))
328 self.add_derive_value('db_stat_conflicts', prefix=database_name, value=int(row.get('conflicts', 0)))
329 conn_key = "{}_{}".format(database_name, 'db_stat_connections')
330 self.data[conn_key] = int(row.get('connections', 0))
332 def add_backend_stats(self, cursor):
333 cursor.execute(BACKENDS)
334 temp = cursor.fetchone()
336 self.data['backend_process_active'] = int(temp.get('backends_active', 0))
337 self.data['backend_process_idle'] = int(temp.get('backends_idle', 0))
339 def add_index_stats(self, cursor):
340 cursor.execute(INDEX_STATS)
341 temp = cursor.fetchone()
342 self.data['index_count'] = int(temp.get('indexes', 0))
343 self.data['index_size'] = int(temp.get('size_indexes', 0))
345 def add_table_stats(self, cursor):
346 cursor.execute(TABLE_STATS)
347 temp = cursor.fetchone()
348 self.data['table_count'] = int(temp.get('relations', 0))
349 self.data['table_size'] = int(temp.get('size_relations', 0))
351 def add_lock_stats(self, cursor):
352 cursor.execute(DATABASE_LOCKS)
353 # First zero out all current lock values.
354 for database_name in self.databases:
355 for lock_type in LOCK_TYPES:
356 lock_id = "{}_{}".format(database_name, lock_type.lower())
357 self.data[lock_id] = 0
359 # Now populate those that have current locks
361 database_name, lock_type, lock_count = row
362 lock_id = "{}_{}".format(database_name, lock_type.lower())
363 self.data[lock_id] = lock_count
365 def add_wal_stats(self, cursor):
366 cursor.execute(ARCHIVE)
367 temp = cursor.fetchone()
368 self.add_derive_value('wal_total', int(temp.get('file_count', 0)))
369 self.add_derive_value('wal_ready', int(temp.get('ready_count', 0)))
370 self.add_derive_value('wal_done', int(temp.get('done_count', 0)))
372 def add_bgwriter_stats(self, cursor):
373 cursor.execute(BGWRITER)
374 temp = cursor.fetchone()
376 self.add_derive_value('background_writer_scheduled', temp.get('checkpoints_timed', 0))
377 self.add_derive_value('background_writer_requested', temp.get('checkpoints_requests', 0))
379 def add_derive_value(self, key, value, prefix=None):
381 key = "{}_{}".format(prefix, key)
382 if key not in self.old_data.keys():
385 self.data[key] = value - self.old_data[key]
387 self.old_data[key] = value
391 def add_replication_stats(self, cursor):
392 cursor.execute(REPLICATION)
393 temp = cursor.fetchall()
395 self.add_gauge_value('Replication/%s' % row.get('client_addr', 'Unknown'),
397 int(row.get('byte_lag', 0)))