-
Notifications
You must be signed in to change notification settings - Fork 1
/
pg_alert.py
2629 lines (2320 loc) · 123 KB
/
pg_alert.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
#!/usr/bin/env python
###############################################################################
### COPYRIGHT NOTICE FOLLOWS. DO NOT REMOVE
###############################################################################
### Copyright (c) 2012 - 2021, SQLEXEC LLC
###
### This program is bound by the following licenses:
### GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007
### MIT licensing privileges also conveyed on top of GNU V3.
###
### Permission to use, copy, modify, and distribute this software and its
### documentation for any purpose, without fee, and without a written agreement
### is hereby granted, provided that the above copyright notice and this paragraph
### and the following two paragraphs appear in all copies.
###
### IN NO EVENT SHALL SQLEXEC LLC BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
### SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
### ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
### SQLEXEC LLC HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
###
### SQLEXEC LLC SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
### LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
### PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS,
### AND SQLEXEC LLC HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
### ENHANCEMENTS, OR MODIFICATIONS.
###
#######################################G########################################
# Original Author: Michael Vitale, [email protected]
#
# Description: pg_alert.py is a PG monitoring script that sends email alerts based on
# monitored elements in a log file, host metrics, or db queries.
#
# See pgalertnotes.txt for more info.
#
# Modifications History:
# Date Programmer Description of Change
# ========== ========== =====================
# 2012-06-22 Michael Vitale Original Coding. version 1.0
# 2016-11-20 Michael Vitale Major rewrite. version 2.0
# Parse output of tail|grep instead of parsing PG log file directly
# Use psycopg2 instead of PyGreSQL DB client driver.
# 2016-12-16 Michael Vitale Added sqlstate checking logic to bypass certain sqlstate logs
# 2016-12-19 Michael Vitale Added wait lock detection
# 2016-12-20 Michael Vitale Added linux metrics detection
# 2016-12-22 Michael Vitale Added slave support
# 2016-12-25 Michael Vitale Added application and query filtering support
# 2016-12-30 Michael Vitale Replaced hard-coded PG log filename with dynamic dateformat string replacement
# 2017-01-06 Michael Vitale Bug fixes. Allow pg_alert log directory to be different than PG log directory
# 2017-01-07 Michael Vitale Multi-version support: 9.4, 9.6
# 2017-01-11 Michael Vitale More bug fixes.
# 2017-01-21 Michael Vitale More bug fixes. Added sytem check support: windows, packages, versions.
# 2017-01-28 Michael Vitale More bug fixes. Added ssmtp, smtp support for email options.
# 2017-02-01 Michael Vitale V 2.1: Enhancements. Changed connection logic: program does not abort if it cannot
# connect to the db. db checks are just disabled for this session.
# New logic uses pids instead of sockets for avoiding duplicate instances.
# Return details of idle in transactions instead of just the counts.
# 2017-06-28 Michael Vitale V 2.2: Enhancements. Added new parmeter to dictate mailx format options, MAILX_FORMAT
# 2017-10-07 Michael Vitale V 2.3: Fix for latest version of PG, v10. Abort if we cannot connect to PG.
# pg_log --> log pg_xlog --> pg_wal waiting-->wait_state
# 2017-12-07 Michael Vitale V 2.4: enable better email failure debugging with new DEBUG flag
# fixed other email related stuff
# 2018-08-29 Michael Vitale V 2.5: fix mail again. This time use different syntax for CentOS 7
# 2021-05-31 Michael Vitale V 3.0: added AWS RDS support
# added grep exclusion logic
# upgraded from Python v2.7 to v3.6. Python v2.x is not supported anymore
# bunch of stricter indentation fixes
# #except socket.error, msg: --> except socket.error as msg:
# except psycopg2.Error, e: --> except psycopg2.Error as e:
# except Exception, exc: --> except Exception as exc:
# print msg --> print(msg)
# remove deprecated import, exceptions, and replace commands with subprocess, ConhfigParser renamed to configparser
# config.get("required", "clusterid",1) --> config.get("required", "clusterid")
# Major change to log file processing:
# Before RDS support, this program assumed one log file per day. Hence, one static grep for the main entry loop.
# Now we support getting the latest log file every refreshrate period of time.
# This requires to restart the GREP daemon after gettting/refreshing the lastest pg log file.
# To make sure we don't re-issue alerts for the same lines after refreshing, especially in the RDS case,
# we now capture the date of the last alert and make sure we only issue alerts for those that have occurred since the last recorded alert.
# This only works for the current session. It does not carry-over into ensuing sessions.
# For local log files, we only care if we are working with a new log file, since we have a direct link to the log file in the data directory.
# 2021-06-06 Michael Vitale V 3.1 Fixed logic for getting current community postgresql log file name on local directory
# 2021-06-08 Michael Vitale V 3.1 Changed grep to not do case-sensitive greps.
# Changed alert logic to buffer alerts before sending them out instead of alerting individually.
################################################################################################################
# v3: exceptions module deprecated, also replace commands with subprocess
#import string, sys, os, time, datetime, exceptions, socket, commands, argparse, ConfigParser
import string, sys, os, time, datetime, socket, argparse, configparser
import random, math, signal, platform, glob, stat, imp
import smtplib, subprocess
from subprocess import *
from decimal import *
from optparse import OptionParser
# fix for v3:
#from email.MIMEMultipart import MIMEMultipart
from email.mime.multipart import MIMEMultipart
# fix for v3:
#from email.MIMEText import MIMEText
from email.mime.multipart import MIMEMultipart
# psycopg2 and psutil imported directly in function where needed since we test for it using imp to avoid exception
OK = 0
ERR = 1
NOTFOUND = -1
INTERRUPT = -2
NOPROGLOCK = -3
########################
def get_lock(processname):
get_lock._lock_socket = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
# get_lock._lock_socket = socket.socket(socket.AF_INET,socket.SOCK_STREAM)
get_lock._lock_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
try:
get_lock._lock_socket.bind('\0' + processname)
sock.bind(server_address)
p.printit("socket: %s" % sock.getsockname())
# fix for v3
#except socket.error, msg:
#except Exception as msg:
except socket.error as msg:
# p.printit('Lock exists (%s) %s. Program is already running. Exiting...' % (p.processname, sock.getsockname()))
p.printit('Lock exists (%s) Error=%s. Program is already running. Exiting...' % (p.processname, msg))
return NOPROGLOCK
return OK
########################
def which(program):
def is_exe(fpath):
return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
fpath, fname = os.path.split(program)
if fpath:
if is_exe(program):
return program
else:
for path in os.environ["PATH"].split(os.pathsep):
path = path.strip('"')
exe_file = os.path.join(path, program)
if is_exe(exe_file):
return exe_file
return ''
class pgmon:
def __init__(self):
self.version = "pg_alert (V 2.5 Aug. 29, 2018)"
self.system = platform.system()
self.python_version = platform.python_version()
self.description = "%s is a PostgreSQL alerting tool" % self.version
self.options = None
self.args = 0
self.filedatefmt = datetime.datetime.now().strftime("%Y-%m%d")
self.mail_method = ""
self.mailx_format = "default"
self.mailbin = 'mail'
# SMTP STUFF
self.smtp_server = ""
self.smtp_account = ""
self.smtp_port = -1
self.smtp_password = ""
self.sms = ""
self.configfile = ""
self.logalert = ""
self.loghistory = ""
self.pidfile = ""
self.sendemail = False
self.ignore_autovacdaemon = True
self.ignore_uservac = True
self.minutes = 0
self.refreshrate = 15
self.keeplogdays = -1
self.seconds = 0
self.startd = datetime.datetime.now()
self.start = self.startd.strftime("%Y-%m-%d %H:%M:%S")
self.start_date = self.startd.strftime("%Y-%m-%d")
self.endd = self.startd + datetime.timedelta(0,1)
self.end_date = self.endd.strftime("%Y-%m-%d")
self.end = self.endd.strftime("%Y-%m-%d %H:%M:%S")
self.time_start = time.time()
self.refreshed = time.time()
self.alert = None
self.processname = "pg_alert"
self.to = ""
self.subject = 'pg_alert'
self.from_ = ""
self.conn = None
self.rds = False
self.dbid = ""
self.dbname = ""
self.dbuser = ""
self.dbhost = ""
self.pgport = ""
self.clusterid = ""
self.grepfilter = "FATAL:"
self.grepexclude = ""
self.sqlstate = ""
self.sqlclass = ""
self.sqlstates = []
self.sqlclasses = []
self.sqlstateprefix = ""
self.sqlstatepostfix = ""
self.check_sqlstate = False
self.data_directory = ""
self.pglog_directory = ""
self.alert_directory = ""
self.pg_tmp = ""
self.log_line_prefix = ""
self.max_alerts = 100
self.verbose = False
self.debug = False
self.monitorlag = False
self.alert_stmt_timeout = False
self.lockwait = 1
self.tempbytesthreshold = 999999999999
self.pgversion = Decimal('0.0')
# logfile=/home/centos/tools/postgresql.log.2021-05-28-1900
self.logfile = ""
self.oldlogfile = ""
# log_filename=postgresql.log.%Y-%m-%d-%H%M
self.log_filename = ''
self.slaves = ''
self.ignoreusers = ''
self.ignoreapps = ''
self.ignorequeries = ''
self.lockfilter = ''
# stat variables
self.alertcnt = 0
self.cpus = 0
self.loadmax = 0
self.load1 = 0
self.load5 = 0
self.load15 = 0
self.maxconn = 0
self.totalconn = 0
self.activeconn = 0
self.pgsql_tmp_threshold = -1
self.loadthreshold = 100
self.dirthreshold = 99
self.idletransthreshold = 9999
self.querytransthreshold = 9999
self.checkinterval = 300
self.lastconntotalert = None
self.lastconnactivealert = None
self.lastconnidlealert = None
self.lastconnqueryalert = None
self.lastloadalert = None
self.lastslavealert = None
self.suspended = False
self.bypass = False
self.connected = False
self.stdout = open('/tmp/stdout', "w+")
self.stderr = open('/tmp/stderr', "w+")
self.lastalert = ""
# db stats ordered array: datname,numbackends,conflicts,temp_bytes,deadlocks
self.dbstats = []
########################
def get_rdslogcomplete(self, logfilename, logfilename2):
# cmd = "aws rds download-db-log-file-portion --db-instance-identifier %s --log-file-name %s --starting-token 0 --output text > %s/%s.log" % (self.dbid, logfilename, self.alert_directory, logfilename2)
cmd = "%s/get_awslogs_cli_partsX.sh 100 NA %s %s %s" % (self.alert_directory, self.dbid, self.alert_directory, logfilename2)
rc,out,errs = self.executecmd(cmd,True)
if rc != 0:
self.printit('Unable to get complete rds log file. rc=%d errs=$s' % (rc,errs))
return ERR
return OK
########################
def get_rdslog(self):
# sometimes we get multiple logs at time of moving to another log so try a couple times with changing epoch
i = 0
lasterr = ''
while True:
i = i + 1
if i == 4:
break
# call aws rds cli API to get the latest log file:
if i == 1:
cmd = 'date +%s%3N --date="1 seconds ago"'
elif i == 2:
cmd = 'date +%s%3N --date="10 seconds ago"'
elif i == 3:
cmd = 'date +%s%3N --date="1 minutes ago"'
rc,out,errs = self.executecmd(cmd,True)
if rc != 0:
lasterr = 'Unable to get epoch for use with RDS CLI interface. rc=%d errors=%s' % (rc, errs)
self.printit(lasterr)
continue
epoch = out.rstrip("\n")
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
self.printit ("%s: Using epoch=%s to get the latest RDS log." % (now,epoch))
# get the name of the most recent log file
#cmd = "aws rds describe-db-log-files --db-instance-identifier %s --file-size 1 --file-last-written %s" % (self.dbid, out)
cmd = "aws rds describe-db-log-files --db-instance-identifier %s --file-size 1 --file-last-written %s | grep -i logfilename | cut -f2 -d: | tr -d ',' | tr -d '\\\"'" % (self.dbid, epoch)
if self.debug:
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
print ("%s: DEBUG: cmd=%s" % (now,cmd))
rc,out,errs = self.executecmd(cmd,True)
if rc != 0:
lasterr = 'Unable to get name of most recent rds log file. rc=%d errors=%s' % (rc, errs)
self.printit(lasterr)
continue
logfilename = out.strip()
if logfilename == '':
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
lasterr = "%s: Unable to get log file name for --file-last-written using epoch, %s. cmd=%s" % (now,epoch, cmd)
if i < 3:
lasterr = lasterr + ' Retrying...'
self.printit(lasterr)
continue
# if we get here we must have succeeded
lasterr = ''
break
if lasterr != '':
self.sendalert(lasterr)
return ''
logfilename2 = logfilename.replace('error/','')
# get the log. This is complicated since at the current time, AWS RDS CLI only returns 2MB per call. So we have to loop
self.printit ("%s: Downloading log file parts for log, %s" % (now,logfilename2))
rc = self.get_rdslogcomplete(logfilename, logfilename2)
if rc != 0:
return rc
# validate size
cmd = "aws rds describe-db-log-files --db-instance-identifier %s --file-size 1 --filename-contains %s | grep -i size | cut -f2 -d: | tr -d ',' | tr -d '\\\"'" % (self.dbid, logfilename2)
if self.debug:
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
print ("%s: DEBUG: cmd=%s" % (now,cmd))
rc,expectedsize,errs = self.executecmd(cmd,True)
if rc != 0:
self.printit('Unable to get described size of PG log file, %s. rc=%d errors=%s' % (logfilename2, rc, errs))
return ''
expectedsize = expectedsize.strip()
self.oldlogfile = self.logfile
self.logfile = self.alert_directory + '/' + logfilename2
actualsize = os.path.getsize(self.logfile)
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
if self.oldlogfile == self.logfile:
self.printit ("%s: Using same log file. logfile=%s expected size=%s actual size=%d" % (now, self.logfile, expectedsize, actualsize))
else:
self.printit ("%s: Using new log file. logfile=%s expected size=%s actual size=%d" % (now, self.logfile, expectedsize, actualsize))
return logfilename2
########################
def get_pidlock(self):
pid = str(os.getpid())
self.pidfile = "/tmp/%s.pid" % self.processname
if os.path.isfile(self.pidfile):
self.printit('Pid file exists (%s). Program is already running. Exiting...' % (self.pidfile))
return NOPROGLOCK
try:
afile = open(self.pidfile, 'w')
afile.write(pid)
except Exception as e:
self.printit('Unable to obtain pid lock (%s)' % (e))
return NOPROGLOCK
return OK
##########################
def setupOptionParser(self):
parser = OptionParser(self.description)
parser.add_option("-c","--configfile",dest="configfile", help="pg_alert config file", default="",metavar="CONFIGFILE")
parser.add_option("-m","--minutes",dest="minutes", help="duration of tailing in minutes", default=0,metavar="MINUTES")
parser.add_option("-d","--dbname",dest="dbname", help="database name", default="",metavar="DBNAME")
parser.add_option("-u","--dbuser",dest="dbuser", help="database user", default="",metavar="DBUSER")
parser.add_option("-s","--dbhost",dest="dbhost", help="database host", default="",metavar="DBHOST")
parser.add_option("-v","--verbose",dest="verbose",help="optional parameter indicating whether verbose messaging is turned on. Default is false",metavar="verbose", default=False, action="store_true")
parser.add_option("-b","--debug",dest="debug",help="optional parameter indicating whether debug messaging is turned on. Default is false",metavar="debug", default=False, action="store_true")
return parser
##########################
def getlogfilename(self):
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
# parse log_filename to get the right PG log file to open.
# old way is based on log_filename
dayname=datetime.datetime.now().strftime("%a")
year = datetime.datetime.now().strftime("%Y")
month = datetime.datetime.now().strftime("%m")
day = datetime.datetime.now().strftime("%d")
filename1 = self.log_filename
filename1 = filename1.replace("%a", dayname)
filename1 = filename1.replace("%Y", year)
filename1 = filename1.replace("%m", month)
filename1 = filename1.replace("%d", day)
# new way is based on SQL, which is more stable
# 9.6 : SELECT file, (pg_stat_file(current_setting('log_directory')||'/'||file)).modification FROM pg_ls_dir(current_setting('log_directory')||'/') as list(file) ORDER BY 2 DESC LIMIT 1;
# 10.x+: select pg_current_logfile(); --> log/postgresql-Sun.log, so it's the relative offset from the data_directory.
if self.pgversion == 9.6:
sql = "SELECT file, (pg_stat_file(current_setting('log_directory')||'/'||file)).modification FROM pg_ls_dir(current_setting('log_directory')||'/') as list(file) ORDER BY 2 DESC LIMIT 1"
else:
# assume newer version
sql = "select pg_current_logfile()"
cur = self.conn.cursor()
try:
cur.execute(sql)
except psycopg2.Error as e:
cur.close()
self.printit("SQL Error: unable to retrieve PG log file name: %s" % (e))
self.cleanup(1)
results = cur.fetchall()
if not results:
cur.close()
self.printit("SQL Error: PL log file not found.")
self.cleanup(1)
for avalue in results:
filename2 = avalue[0]
break
if filename1 != filename2:
self.printit("%s: NOTICE: filename1=%s filename2=%s. Using filename2." % (now, filename1, filename2))
elif self.debug:
self.printit("%s: DEBUG: filename1=%s filename2=%s. Using filename2." % (now, filename1, filename2))
return OK, filename2
##########################
def testcmd (self, cmd, context):
command = "which %s" % cmd
try:
if self.python_version[0:3] == '2.7':
subprocess.check_output(command,shell=True)
else:
pass
# proc = Popen(['ls', '-l'], stdout=PIPE)
# print(proc.communicate()[0].split())
return OK
# except:
except Exception as e:
self.printit("ERROR: execution error= %s %s %s" % (cmd, context, e))
return ERR
##########################
def prunelogs(self):
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
if self.keeplogdays > -1:
# delete all old logs
if self.verbose:
self.printit("%s: Pruning old pg_alert log files...\n" % (now))
for filename in os.listdir(self.alert_directory):
curr_file = os.path.join(self.alert_directory, filename)
file_modified = datetime.datetime.fromtimestamp(os.path.getmtime(curr_file))
dayage = (time.time() - os.stat(curr_file)[stat.ST_MTIME]) / 60 / 60 /24
dayage = int(round(dayage))
if filename.startswith("alerts-") and (filename.endswith(".log") or filename.endswith(".gz")):
if curr_file == self.logalert or curr_file == self.loghistory:
# self.printit("bypassing current log file=%s" % filename)
pass
else:
# found candidates to purge
if dayage > self.keeplogdays:
self.printit("deleting file older than %d days: %s" % (dayage, curr_file))
os.remove(curr_file)
else:
pass
# self.printit("%d days old. Bypassing purge candidate=%s" % (dayage, curr_file))
else:
# self.printit("bypassing non purge candidate=%s" % curr_file)
pass
else:
# do nothing for now, add logic later for specifying exactness of logs to prune
self.printit("%s: No log file pruning specified.\n" % (now))
return OK
##########################
def checksystem(self):
if self.system == 'Windows':
self.printit("Unsupported platform, Windows.")
return ERR
try:
imp.find_module('psycopg2')
found = True
global psycopg2
import psycopg2
except ImportError:
found = False
if not found:
self.printit("psycopg2 package is required.")
return ERR
try:
imp.find_module('psutil')
found = True
global psutil
import psutil
except ImportError:
found = False
if not found:
self.printit("python-psutil package is required.")
return ERR
# we only support python 2.7 flavors
# fix for v3: replace <> with != and require python 3.6
#if self.python_version[0:3] <> '2.7':
if self.python_version[0:3] != '3.6':
self.printit("Unsupported python version, %s. Only 3.6.x and above are supported at the present time. Some important functionality may not work correctly." % (self.python_version))
# return ERR
return OK
return OK
##########################
def getdbinfo(self):
# get some PG stuff
cur = self.conn.cursor()
sql = "select name, setting from pg_settings where name in ('data_directory','log_directory','log_filename','log_line_prefix','server_version','server_version_num' ) order by name"
try:
cur.execute(sql)
# fix for v3
#except psycopg2.Error, e:
except psycopg2.Error as e:
cur.close()
self.printit("SQL Error: unable to retrieve PG Glucs: %s" % (e))
self.cleanup(1)
glucs = cur.fetchall()
if not glucs:
cur.close()
self.printit("SQL Error: no glucs found.")
self.cleanup(1)
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
if self.rds:
# data_directory, pg log directory are not in play
for agluc in glucs:
if agluc[0] == 'log_line_prefix':
self.log_line_prefix = agluc[1]
elif agluc[0] == 'server_version':
self.pgversion = Decimal(agluc[1])
elif agluc[0] == 'server_version_num':
pass
# self.server_version_num = int(agluc[1])
elif agluc[0] == 'log_filename':
self.log_filename = agluc[1]
else:
for agluc in glucs:
if self.debug:
self.printit("%s: DEBUG: aglucs=%s %s" % (now, agluc[0], agluc[1]))
if agluc[0] == 'data_directory':
self.data_directory = agluc[1]
elif agluc[0] == 'log_directory':
if self.pglog_directory == '':
self.pglog_directory = agluc[1]
if self.pglog_directory == 'pg_log' or self.pglog_directory == 'log':
# need to preappend data dir
self.pglog_directory = self.data_directory + '/' + self.pglog_directory
elif agluc[0] == 'log_line_prefix':
self.log_line_prefix = agluc[1]
elif agluc[0] == 'server_version':
# check for old version format, x.x.x
if '9.6' in agluc[1]:
self.pgversion = 9.6
else:
self.pgversion = Decimal(agluc[1])
elif agluc[0] == 'server_version_num':
pass
# self.server_version_num = int(agluc[1])
# print 'DEBUG: server version number: %d' % self.server_version_num
elif agluc[0] == 'log_filename':
self.log_filename = agluc[1]
else:
cur.close
self.printit("Program Error: Unexpected gluc: %s" % agluc[0])
self.cleanup(1)
self.pg_tmp = self.data_directory + '/base/pgsql_tmp'
return OK
##########################
def initandvalidate(self):
rc = self.checksystem()
# fix for v3: replace <> with !=
if rc != OK:
sys.exit(rc)
# register signal handler to catch interrupts so we can end gracefully.
# signal.signal(signal.SIGUSR1, self.catch)
# signal.siginterrupt(signal.SIGUSR1, False)
signal.signal(signal.SIGINT, self.catch)
signal.siginterrupt(signal.SIGINT, False)
optionParser = self.setupOptionParser()
(self.options,self.args) = optionParser.parse_args()
self.configfile = self.options.configfile
if self.configfile == "":
self.printit("config file not specified.")
sys.exit(ERR)
# validate and get stuff from config file not specified on command line
if not os.path.exists(self.configfile):
self.printit("pg_alert config file does not exist: %s" % self.configfile)
sys.exit(ERR)
if self.options.dbname != "":
self.dbname = self.options.dbname
if self.options.dbuser != "":
self.dbuser = self.options.dbuser
if self.options.dbhost != "":
self.dbhost = self.options.dbhost
config = configparser.SafeConfigParser({'sqlstate':'', 'sqlclass':'', 'lockwait':'', 'checkinterval':'', \
'loadthreshold':'', 'dirthreshold':'', 'idletransthreshold':'', 'querytransthreshold':'', 'pgsql_tmp_threshold':'', 'lockfilter':'', \
'pglog_directory':'', 'alert_directory':'', 'ignore_autovacdaemon':'True', 'ignore_uservac':'True', 'tempbytesthreshold':'', 'slaves':'', \
'monitorlag':'False', 'alert_stmt_timeout':'False', 'ignoreapps':'', 'ignoreusers':'','ignorequeries':'', 'suspended':'False', \
'mail_method':'', 'smtp_server':'', 'smtp_account':'', 'smtp_port':'', 'smtp_password':'', 'sms':'', 'grepfilter':'', 'grepexclude':''})
config.read(self.configfile)
self.ignore_autovacdaemon = config.getboolean('optional', 'ignore_autovacdaemon')
self.ignore_uservac = config.getboolean('optional', 'ignore_uservac')
self.monitorlag = config.getboolean('optional', 'monitorlag')
self.verbose = config.getboolean('required', 'verbose')
self.debug = config.getboolean('required', 'debug')
self.alert_stmt_timeout = config.getboolean('optional', 'alert_stmt_timeout')
self.suspended = config.getboolean('optional', 'suspended')
self.slaves = config.get('optional', 'slaves')
self.slaves = self.slaves.strip()
self.ignoreusers = config.get('optional', 'ignoreusers')
self.ignoreusers = self.ignoreusers.strip()
self.ignoreapps = config.get('optional', 'ignoreapps')
self.ingoreapps = self.ignoreapps.strip()
self.ignorequeries = config.get('optional', 'ignorequeries')
self.ignorequeries = self.ignorequeries.strip()
# fix for v3:
#self.clusterid = config.get("required", "clusterid",1)
self.clusterid = config.get("required", "clusterid")
if self.clusterid == "":
self.printit("Invalid config input (CLUSTERID). Expected a short descriptor field like PROD.")
sys.exit(ERR)
self.to = config.get("required", "to")
if self.to == "":
self.printit("Invalid config input (TO). Expected at least one email address.")
sys.exit(ERR)
self.sendemail = config.getboolean('required', 'emailalerts')
self.alert_directory = config.get("required", "alertlog_directory")
if not os.path.isdir(self.alert_directory):
self.printit("Alert log directory is invalid directory: %s" % self.alert_directory)
sys.exit(ERR)
self.pglog_directory = config.get("optional", "pglog_directory")
if self.pglog_directory != '':
if not os.path.isdir(self.pglog_directory):
self.printit("PG log directory specified is invalid. Please remove to use postgresql.conf setting: %s" % self.pglog_directory)
sys.exit(ERR)
self.mail_method = config.get('optional', 'mail_method').lower()
# new parameter for v2.2
self.mailx_format = config.get('optional', 'mailx_format').lower()
if self.mailx_format != 'default' and self.mailx_format != 'custom1' and self.mailx_format != 'custom2':
self.printit("Invalid MAILX_FORMAT=%s. Must be one of: default, custom1, custom2" % self.mailx_format)
sys.exit(ERR)
self.smtp_server = config.get('optional', 'smtp_server')
self.smtp_account = config.get('optional', 'smtp_account')
self.smtp_port = config.get('optional', 'smtp_port')
if self.smtp_port.isdigit():
self.smtp_port = int(self.smtp_port)
else:
if self.mail_method == 'smtp':
self.printit("SMTP_PORT must be a number: %s" % self.smtp_port)
sys.exit(ERR)
self.smtp_password = config.get('optional', 'smtp_password')
self.sms = config.get('optional', 'sms')
if self.sendemail and self.mail_method == "":
self.printit("Email alerts turned on, but no mail method selected.")
sys.exit(ERR)
elif self.mail_method != 'mail' and self.mail_method != 'smtp' and self.mail_method != 'ssmtp':
self.printit("Email method not valid. Choices are MAIL, SMTP, or SSMPT: %s" % self.mail_method)
sys.exit(ERR)
if self.mail_method == 'ssmtp':
rc = self.testcmd('ssmtp', 'ssmtp test')
if rc != OK:
sys.exit(ERR)
elif self.mail_method == 'mail':
# see if we can use bsd version of mailx to avoid syntax problems with heirloom version
if os.path.isfile('/usr/bin/bsd-mailx'):
self.mailbin = '/usr/bin/bsd-mailx'
else:
result = which('mailx')
if result == '':
self.printit("mailx program not found. Please install mailx or use another mail method.")
sys.exit(ERR)
rc = self.testcmd(result, 'mailx test')
if rc == OK:
self.mailbin = result
# rc = self.testcmd('/usr/bin/bsd-mailx')
#if rc == OK:
# self.mailbin ='/usr/bin/bsd-mailx'
if self.debug:
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
self.printit("%s: DEBUG: Using this location for mailx: %s" % (now, self.mailbin))
# we only override verbose and debug if true is passed via command line
if not self.verbose:
self.verbose = self.options.verbose
if not self.debug:
self.debug = self.options.debug
self.rds = config.getboolean("required", "rds")
if self.rds:
self.dbid = config.get("required", "dbid")
if self.dbid == '':
self.printit("No RDS DBID provided.")
sys.exit(ERR)
temp = config.get("optional", "cpus")
if temp is None:
self.cpus = -1;
else:
self.cpus = int(temp)
if self.dbname == '':
self.dbname = config.get("required", "dbname")
if self.dbuser == '':
self.dbuser = config.get("required", "dbuser")
if self.dbhost == '':
self.dbhost = config.get("required", "dbhost")
if self.pgport == '':
self.pgport = config.get("required", "dbport")
if self.pgport == "":
self.pgport = "5432"
# open db connection: assumes password in .pgpass
connstr = "dbname=%s user=%s host=%s port=%s" % (self.dbname, self.dbuser, self.dbhost, self.pgport)
try:
self.conn = psycopg2.connect(connstr)
self.connected = True
self.conn.autocommit = True
except psycopg2.Error as e:
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
self.printit("Database Connection Error: %s" % (e))
self.printit("using connection string: %s" % connstr)
# v2.1 enhancement: do not abort if we cannot connect, just disable db checking stuff
# v2.3 on second thought, abort if we cannot connect.
#self.printit("%s: NOTICE. DB session checks are disabled for this instance of pg_alert." % now)
self.printit("%s: NOTICE. Unable to connect to database. Exiting...." % now)
self.connected = False
self.cleanup(1)
if self.connected:
rc = self.getdbinfo()
if rc != OK:
self.cleanup(1)
interim = config.get("required", "minutes")
if interim == "":
self.minutes = 0
elif interim.isdigit():
self.minutes = int(interim)
else:
self.printit("Invalid minutes config input(%s). Expected a positive number indicating duration minutes." % interim)
self.cleanup(1)
temp = config.get("required", "refresh")
self.refreshrate = int(temp)
keeplogdays = config.get("optional", "keeplogdays")
if keeplogdays == "":
self.keeplogdays = -1
elif keeplogdays.isdigit():
self.keeplogdays = int(keeplogdays)
else:
self.printit("Invalid keeplogdays config input(%s). Expected a non-negative number indicating the number of days to keep pg_alert log files." % keeplogdays)
self.cleanup(1)
self.lockfilter = config.get("optional", "lockfilter")
value = config.get("optional", "max_alerts")
if len(value) > 0 and value.isdigit():
self.max_alerts = int(value)
value = config.get("optional", "lockwait")
# must be > 0 seconds
if len(value) > 0 and value.isdigit():
if int(value) > 0:
self.lockwait = int(value)
value = config.get("optional", "tempbytesthreshold")
# must be > 100K bytes
if len(value) > 0 and value.isdigit():
if int(value) > 100000:
self.tempbytesthreshold = int(value)
value = config.get("optional", "checkinterval")
# must be at least 30 seconds
if len(value) > 0 and value.isdigit():
if int(value) > 29:
self.checkinterval = int(value)
value = config.get("optional", "loadthreshold")
# must be at least 10%
if len(value) > 0 and value.isdigit():
if int(value) > 9:
self.loadthreshold = int(value)
value = config.get("optional", "dirthreshold")
# must be < 100%
if len(value) > 0 and value.isdigit():
if int(value) < 100:
self.dirthreshold = int(value)
value = config.get("optional", "idletransthreshold")
# must be > 2 seconds
if len(value) > 0 and value.isdigit():
if int(value) >1:
self.idletransthreshold = int(value)
value = config.get("optional", "querytransthreshold")
# must be > 1 seconds
if len(value) > 0 and value.isdigit():
if int(value) > 1:
self.querytransthreshold = int(value)
value = config.get("optional", "pgsql_tmp_threshold")
if len(value) > 0 and value.isdigit():
if int(value) > 0:
self.pgsql_tmp_threshold = int(value)
self.from_ = config.get("required", "from")
self.grepfilter = config.get("optional", "grepfilter")
if self.grepfilter == '':
pass
self.grepexclude = config.get("optional", "grepexclude")
# put states and classes in arrays
self.sqlstate = config.get("optional", "sqlstate")
if self.sqlstate.strip() == '':
self.check_sqlstate = False
else:
self.sqlstates = self.sqlstate.split(",")
for index, item in enumerate(self.sqlstates):
self.sqlstates[index] = item.strip()
self.sqlclass = config.get("optional", "sqlclass")
if self.sqlstate == "" and self.sqlclass == "":
self.check_sqlstate = False
if self.sqlclass.strip() != '':
self.sqlclasses = self.sqlclass.split(",")
for index, item in enumerate(self.sqlclasses):
self.sqlclasses[index] = item.strip()
if len(self.sqlclasses[index].split(' ')) > 1:
# user may have accidentally put the keyword class there or something else, so regard as error
self.printit("sqlclass values must be numbers separated by commas. Current value: %s" % item)
self.cleanup(1)
elif len(self.sqlclasses[index]) != 2:
# assume sqlstates not valid for this session
#self.printit("sqlclass values must be 2 digit numbers separated by commas. Current value: %s" % item)
#self.cleanup(1)
pass
# get command line options that override configuration file values
if self.options.minutes != 0:
if self.options.minutes.isdigit():
self.minutes = int(self.options.minutes)
if self.minutes == 0:
self.printit("Minutes must be greater than 0.")
self.cleanup(1)
else:
self.printit("Invalid minutes input(%s). Expected a positive number indicating duration minutes." % self.options.minutes)
self.cleanup(1)
if self.minutes < 1:
self.printit("Invalid minutes input(%s). Expected a positive number indicating duration minutes." % self.minutes)
self.cleanup(1)
if not self.rds:
if not os.path.isdir(self.pglog_directory):
self.printit("PG log directory is invalid directory: %s" % self.pglog_directory)
self.cleanup(1)
if self.dbname == "":
self.printit("Database Name must be specified (-d <dbname>)")
self.cleanup(1)
elif self.dbhost == "":
self.printit("Database Host must be specified (-h <database host>)")
self.cleanup(1)
elif self.dbuser == "":
self.printit("Database User must be specified (-u <database user>)")
self.cleanup(1)
if self.from_ == "":
self.from_ = "PostgreSQL Administrator <%s@%s>" % (self.dbuser, self.dbhost)
rc = self.get_pidlock()
if rc != OK:
self.cleanup(rc)
# get pg log file
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
if self.rds:
# need to use aws cli interface to download the latest log file. Make sure aws cli is available.
cmd = "aws --version"
rc,out,errs = self.executecmd(cmd,True)
if rc != 0:
self.cleanup(rc)
self.printit ("%s: aws rds cli interface is available: %s" % (now,out))
logfilename = self.get_rdslog()
if logfilename == '':
self.cleanup(rc)
else:
# parse log_filename to get the right PG log file to open.
rc, log_filename = self.getlogfilename()
if rc != OK:
self.cleanup(1)
self.logfile = "%s/%s" % (self.pglog_directory, log_filename)
if not os.path.exists(self.logfile):
self.printit("PG log file does not exist: %s" % self.logfile)
self.cleanup(1)
if self.debug:
print ("%s: DEBUG logfile=%s log_filename=%s" % (now, self.logfile, self.log_filename))
self.logalert = "%s/alerts-%s.log" % (self.alert_directory,self.filedatefmt)
self.loghistory = "%s/alerts-history-%s.log" % (self.alert_directory,self.filedatefmt)
# remove alert file if exists and clear out history file as well
cmd = "echo '' > %s" % (self.logalert)
rc,out,errs = self.executecmd(cmd,False)
if rc != 0:
self.cleanup(1)
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
msg = "%s: %s" % (now,self.version)
# fix for v3
#print msg
self.printit (msg)
cmd = "echo '%s' > %s" % (msg, self.loghistory)
rc,out,errs = self.executecmd(cmd,False)
if rc != 0:
self.cleanup(1)
try:
self.alert = open(self.logalert, 'r')
except IOError as e:
self.printit("Unable to open alert file(%s). I/O error({0}): {1}".format(e.errno, e.strerror) % self.logalert)
self.cleanup(1)
except:
self.printit("Unable to open alert file(%s). Unexpected error:", (self.logalert, sys.exc_info()[0]))
self.cleanup(1)
# convert minutes to seconds
self.seconds = self.minutes * 60
# reject minutes if it would overlap into next day
self.endd = self.startd + datetime.timedelta(0,self.seconds)
self.end_date = self.endd.strftime("%Y-%m-%d")
self.end = self.endd.strftime("%Y-%m-%d %H:%M:%S")
if self.end_date != self.start_date:
self.printit("Minutes cannot overlap days. Enter a lower minutes value or start at an earlier time of day.")
self.printit("minutes=%d start=%s end=%s" % (self.minutes, self.start, self.end))
self.cleanup(1)
# test with this string that doesnt work because previous %<code> has no other characters associated with it. Consider invalid in these cases.
# self.log_line_prefix = '%m %u@%d[%p:%i] [%l-1] %r %a tx=%x,ss=%e: '
# self.log_line_prefix = '%m %u@%d[%p: %i ] %r [%a] %e tx:%x : '
# '%t [%p]: [%l-1] %u %d %a %r %x %e:'
sep = "***"
seplen = len(sep)
key = sep + 'e'