fix: add database name in plugin relationssize

Author: alexander popov

mamonsu/plugins/pgsql/relations_size.py

@@ -8,77 +8,78 @@
 class RelationsSize(Plugin):
     def __init__(self, config):
         super(Plugin, self).__init__(config)
-        self.query = None
+        self.relations = []
+        self.create_relations()
         self.key_rel_size_discovery = "pgsql.relation.size{0}"
+        self.query_template = """SELECT relation.schema
+         , relation.name
+         , CASE WHEN l.mode = 'AccessExclusiveLock' THEN '-1'
+               ELSE (pg_total_relation_size(cl.oid))
+           END AS pg_total_relation_size
+         , CASE WHEN l.mode = 'AccessExclusiveLock' THEN '-1'
+               ELSE (sum(pg_total_relation_size(inh.inhrelid)))
+           END AS pg_total_relation_size_part
+    FROM (VALUES {values}) as relation (schema,name)
+    LEFT JOIN pg_catalog.pg_class cl ON cl.relname =  relation.name
+    LEFT JOIN pg_catalog.pg_namespace ns ON ns.oid = cl.relnamespace AND ns.nspname=relation.schema
+    LEFT JOIN pg_catalog.pg_inherits inh ON inh.inhparent = cl.oid
+    LEFT JOIN pg_catalog.pg_locks l ON l.relation = cl.oid AND l.mode= 'AccessExclusiveLock' AND l.locktype = 'relation'
+    LEFT JOIN pg_catalog.pg_locks l_part ON l_part.relation = inh.inhrelid AND l.mode= 'AccessExclusiveLock' AND l.locktype = 'relation'
+    GROUP BY relation.schema
+           , relation.name
+           , l.mode
+           , cl.oid"""
 
-
-    def create_query(self):
-        query_template = """SELECT relation.schema
-     , relation.name
-     , CASE WHEN l.mode = 'AccessExclusiveLock' THEN '-1'
-           ELSE (pg_total_relation_size(cl.oid))
-       END AS pg_total_relation_size
-     , CASE WHEN l.mode = 'AccessExclusiveLock' THEN '-1'
-           ELSE (sum(pg_total_relation_size(inh.inhrelid)))
-       END AS pg_total_relation_size_part
-FROM (VALUES {values}) as relation (schema,name)
-LEFT JOIN pg_catalog.pg_class cl ON cl.relname =  relation.name
-LEFT JOIN pg_catalog.pg_namespace ns ON ns.oid = cl.relnamespace AND ns.nspname=relation.schema
-LEFT JOIN pg_catalog.pg_inherits inh ON inh.inhparent = cl.oid
-LEFT JOIN pg_catalog.pg_locks l ON l.relation = cl.oid AND l.mode= 'AccessExclusiveLock' AND l.locktype = 'relation'
-LEFT JOIN pg_catalog.pg_locks l_part ON l_part.relation = inh.inhrelid AND l.mode= 'AccessExclusiveLock' AND l.locktype = 'relation'
-GROUP BY relation.schema
-       , relation.name
-       , l.mode
-       , cl.oid"""
+    def create_relations(self):
 
         config_relations = self._plugin_config.get('relations', None)
         if config_relations is None or config_relations == '':
             self.disable()
-            raise PluginDisableException ("""Disable plugin and exit, because the parameter 'relations' in section [relationssize] is not set. Set this parameter like relations=pg_catalog.pg_class,pg_catalog.pg_user to count size if needed and restart.""")
+            raise PluginDisableException(
+                """Disable plugin and exit, because the parameter 'relations' in section [relationssize] is not set. Set this parameter like relations=pg_catalog.pg_class,pg_catalog.pg_user to count size if needed and restart.""")
 
-        values = []
+        self.relations = []
         for relation in config_relations.split(','):
             tmp_rel = relation.split('.')
-            if len(tmp_rel) == 0:
-                pass
-            elif len(tmp_rel) == 1:
-                values.append("(NULL, '{relation}')".format(relation=tmp_rel[0].strip()))
-            elif len(tmp_rel) == 2:
-                values.append(
-                    "('{schema}', '{relation}')".format(schema=tmp_rel[0].strip(), relation=tmp_rel[1].strip()))
+            if len(tmp_rel) == 3:
+                self.relations.append([tmp_rel[0].strip(), tmp_rel[1].strip(), tmp_rel[2].strip()])
             else:
                 self.log.error(
-                    'The relation "{relation}" is not correct. You need to specify "schema.table" in the configuration file for mamonsu. Section: [relationssize], parameter: relations '.format(
+                    'The relation "{relation}" is not correct. You need to specify "database_name.schema.table" in the configuration file for mamonsu. Section: [relationssize], parameter: relations '.format(
                         relation=relation))
 
-        self.query = query_template.format(values=',\n             '.join(values))
-
     def run(self, zbx):
-        if not self.query:
-            self.create_query()
-        result = Pooler.query(self.query)
         rels = []
-        for schema, name, pg_total_relation_size, pg_total_relation_size_part  in result:
-            if not schema:
-                full_name_relation = name
-            else:
-                full_name_relation = schema + '.' + name
-            rels.append({'{#RELATIONNAME}': full_name_relation })
-
-            if pg_total_relation_size is None and pg_total_relation_size_part is None:
-                self.log.error('The relation: "{full_name_relation}" in not correct'.format(full_name_relation = full_name_relation))
-                size = -1
-            elif  pg_total_relation_size  ==-1 or  pg_total_relation_size_part ==-1:
+        all_databases = Pooler.databases()
+        for database_name, schema, relation in self.relations:
+            rels.append({'{#RELATIONNAME}': database_name + '.' + schema + '.' + relation})
+            if not (database_name in all_databases):
                 self.log.error(
-                    "The relation: {full_name_relation} is locked. "
-                    "You can find this lock in query: "
-                    "SELECT relation::regclass AS lock_relation, mode FROM  pg_locks WHERE relation::regclass = 'pg_locks'::regclass;".format(full_name_relation=full_name_relation))
-                size = -1
+                    '''The database: "{database_name}" do not exists. '''
+                    '''Check the the parameter "relations" in section [relatonssize].'''.format(
+                        database_name=database_name))
             else:
-                size = (pg_total_relation_size or 0) + (pg_total_relation_size_part or 0)
+                result = Pooler.query(query=self.query_template.format(
+                    values="('{schema}','{relation}')".format(schema=schema, relation=relation)), db=database_name)
+                for schema, name, pg_total_relation_size, pg_total_relation_size_part in result:
+                    full_name_relation = database_name + '.' + schema + '.' + relation
+
+                    if pg_total_relation_size is None and pg_total_relation_size_part is None:
+                        self.log.error('The relation: "{full_name_relation}" in not correct'.format(
+                            full_name_relation=full_name_relation))
+                        size = -1
+                    elif pg_total_relation_size == -1 or pg_total_relation_size_part == -1:
+                        self.log.error(
+                            "The relation: {full_name_relation} is locked. "
+                            "You can find this lock in query: "
+                            "SELECT relation::regclass AS lock_relation, mode FROM  pg_locks "
+                            "WHERE relation::regclass = 'pg_locks'::regclass;".format(
+                                full_name_relation=full_name_relation))
+                        size = -1
+                    else:
+                        size = (pg_total_relation_size or 0) + (pg_total_relation_size_part or 0)
 
-            zbx.send('pgsql.relation.size[{0}]'.format(full_name_relation), int(size))
+                    zbx.send('pgsql.relation.size[{0}]'.format(full_name_relation), int(size))
 
         zbx.send('pgsql.relation.size[]', zbx.json({'data': rels}))
 

packaging/conf/example.conf

@@ -168,14 +168,14 @@ interval = 2
 interval = 60
 
 # Get size of relations defined in this section
-# Relations - comma separated list of objects - tables and endexes (schema.relation) used to calculate relations size.
+# Relations - comma separated list of objects - tables and endexes (database_name.schema.relation) used to calculate relations size.
 # Example:
-# relations=pg_catalog.pg_class,pg_catalog.pg_user
+# relations=postgres.pg_catalog.pg_class,postgres.pg_catalog.pg_user
 # If the relation is blocked by some process such as vacuum full or create index, the result will be -1
 # by default this plugin disabled. To enable this plugin - set bellow "enabled = False" and define a list of relations.
 [relationssize]
 enabled = False
-relations=pg_catalog.pg_class,pg_catalog.pg_user
+relations=postgres.pg_catalog.pg_class,postgres.pg_catalog.pg_user
 interval = 500
 
 # Get age (in seconds) of the oldest running prepared transaction and number of all prepared transactions for two-phase commit.