exemples + readme

Author: unknown

.gitignore

@@ -9,4 +9,3 @@ test.py
 __pycache__
 .gitignore
 output*
-monitor_usage_examples.py

README.md

@@ -50,7 +50,8 @@ The ids are displayed using any of the other instructions
 
 **Note** : the previously shown arguments arguments can be used simultaneously. Therefor the following instruction is valid :<br/>
 `[authentification string] mostUsed longestTimeOnAverage mostRowsReturnedAccumulated 10`<br/>
-It will display just the queries for `mostUsed`, `longestTimeOnAverage` and `mostRowsReturnedAccumulated` one after an other
+It will display just the queries for `mostUsed`, `longestTimeOnAverage` and `mostRowsReturnedAccumulated` one after an other<br/>
+Using the same argument twice will not display it twice
 
 **Note** : the queries that are used by this program are not displayed by default. See the configurations variables to display them
 

monitor.py

@@ -233,10 +233,10 @@ def print_query_from_id(self, argv):
             return False
         buff = "\n"
         buff += " =========\n"
-        buff += "displaying query of queryid " + argv[1] + "\n"
+        buff += "displaying query of queryid " + str(argv[1]) + "\n"
         buff += " =========\n"
         buff += "\n"
-        self.cursor.execute("SELECT query FROM pg_stat_statements WHERE queryid = %s", (int(argv[1]),))
+        self.cursor.execute("SELECT query FROM pg_stat_statements WHERE queryid = %s", (str(argv[1]),))
         res = self.cursor.fetchall()
         if len(res) == 0:
             buff += "Error : there is no queries matching that id"

monitor_usage_examples.py

@@ -0,0 +1,30 @@
+from monitor import Monitor
+
+# these arguments send the arguments directly
+
+# you need to put in the right values to be able to correctly connect to your database
+authentication_string = "dbname=tests user=postgres password=pswd host=127.0.0.1 port=5432"
+
+# example to get the 10 queries that have the longest average time and the 10 queries that have longest accumulated time
+# + display the queries used by the Monitor class
+# + display ALL queries
+monitor = Monitor()
+monitor.displayUsedQueries = True  # display the queries used by the program to get it's information
+monitor.useIgnore = False  # display ALL queries
+monitor.run(authentication_string, 'longestTimeOnAverage', 'longestTimeAccumulated', 10)
+
+# example to display the 10 most used queries
+# + ignore only BEGIN, COMMIT and pg_stat_statements
+# + do not write to file
+monitor = Monitor()
+monitor.ignore = [  # ignore only BEGIN and COMMIT
+    "BEGIN",
+    "COMMIT",
+    "pg_stat_statements"
+]
+monitor.writeToFile = False  # do not write to a file
+monitor.run(authentication_string, 'mostUsed', 10)
+
+# example to display a query
+monitor = Monitor()
+monitor.run(authentication_string, 19846765274300731)  # this id will need to be replaced with an id as display by the Monitor class from your database in order to work