p_s/setup_instruments/setup_instruments.go

   1 // Manage the configuration of setup_instruments.
   2 package setup_instruments
   3
   4 import (
   5         "database/sql"
   6         "fmt"
   7         "log"
   8
   9         "github.com/sjmudd/pstop/lib"
  10 )
  11
  12 // constants
  13 const sql_select = "SELECT NAME, ENABLED, TIMED FROM setup_instruments WHERE NAME LIKE ? AND 'YES NOT IN (enabled,timed)"
  14
  15 // We only match on the error number
  16 // Error 1142: UPDATE command denied to user 'cacti'@'10.164.132.182' for table 'setup_instruments'
  17 // Error 1290: The MySQL server is running with the --read-only option so it cannot execute this statement
  18 var EXPECTED_UPDATE_ERRORS = []string{
  19         "Error 1142:",
  20         "Error 1290:",
  21 }
  22
  23 // one row of performance_schema.setup_instruments
  24 type table_row struct {
  25         NAME    string
  26         ENABLED string
  27         TIMED   string
  28 }
  29
  30 type table_rows []table_row
  31
  32 // SetupInstruments "object"
  33 type SetupInstruments struct {
  34         update_tried     bool
  35         update_succeeded bool
  36         rows             table_rows
  37         dbh              *sql.DB
  38 }
  39
  40 // Return a newly initialised SetupInstruments structure with a handle to the database.
  41 // Better to return a pointer ?
  42 func NewSetupInstruments(dbh *sql.DB) SetupInstruments {
  43         return SetupInstruments{dbh: dbh}
  44 }
  45
  46 // enable mutex and stage monitoring
  47 func (si *SetupInstruments) EnableMonitoring() {
  48         si.EnableMutexMonitoring()
  49         si.EnableStageMonitoring()
  50 }
  51
  52 // Change settings to monitor stage/sql/%
  53 func (si *SetupInstruments) EnableStageMonitoring() {
  54         lib.Logger.Println("EnableStageMonitoring")
  55         sql_match := "stage/sql/%"
  56         collecting := "Collecting setup_instruments stage/sql configuration settings"
  57         updating := "Updating setup_instruments configuration for: stage/sql"
  58
  59         si.Configure(sql_match, collecting, updating)
  60         lib.Logger.Println("EnableStageMonitoring finishes")
  61 }
  62
  63 // Change settings to monitor wait/synch/mutex/%
  64 func (si *SetupInstruments) EnableMutexMonitoring() {
  65         lib.Logger.Println("EnableMutexMonitoring")
  66         sql_match := "wait/synch/mutex/%"
  67         collecting := "Collecting setup_instruments wait/synch/mutex configuration settings"
  68         updating := "Updating setup_instruments configuration for: wait/synch/mutex"
  69
  70         si.Configure(sql_match, collecting, updating)
  71         lib.Logger.Println("EnableMutexMonitoring finishes")
  72 }
  73
  74 // return true if the error is not in the expected list
  75 func error_in_expected_list(actual_error string, expected_errors []string) bool {
  76         lib.Logger.Println("checking if", actual_error, "is in", expected_errors)
  77         e := actual_error[0:11]
  78         expected_error := false
  79         for i := range expected_errors {
  80                 if e == expected_errors[i] {
  81                         lib.Logger.Println("found an expected error", expected_errors[i])
  82                         expected_error = true
  83                         break
  84                 }
  85         }
  86         lib.Logger.Println("returning", expected_error)
  87         return expected_error
  88 }
  89
  90 // generic routine (now) to update some rows in setup instruments
  91 func (si *SetupInstruments) Configure(sql_match string, collecting, updating string) {
  92         lib.Logger.Println(fmt.Sprintf("Configure(%q,%q,%q)", sql_match, collecting, updating))
  93         // skip if we've tried and failed
  94         if si.update_tried && !si.update_succeeded {
  95                 lib.Logger.Println("Configure() - Skipping further configuration")
  96                 return
  97         }
  98
  99         // setup the old values in case they're not set
 100         if si.rows == nil {
 101                 si.rows = make([]table_row, 0, 500)
 102         }
 103
 104         lib.Logger.Println(collecting)
 105
 106         lib.Logger.Println("dbh.query", sql_select, sql_match)
 107         rows, err := si.dbh.Query(sql_select, sql_match)
 108         if err != nil {
 109                 log.Fatal(err)
 110         }
 111
 112         count := 0
 113         for rows.Next() {
 114                 var r table_row
 115                 if err := rows.Scan(
 116                         &r.NAME,
 117                         &r.ENABLED,
 118                         &r.TIMED); err != nil {
 119                         log.Fatal(err)
 120                 }
 121                 si.rows = append(si.rows, r)
 122                 count++
 123         }
 124         if err := rows.Err(); err != nil {
 125                 log.Fatal(err)
 126         }
 127         rows.Close()
 128         lib.Logger.Println("- found", count, "rows whose configuration need changing")
 129
 130         // update the rows which need to be set - do multiple updates but I don't care
 131         lib.Logger.Println(updating)
 132
 133         const update_sql = "UPDATE setup_instruments SET enabled = ?, TIMED = ? WHERE NAME = ?"
 134         lib.Logger.Println("Preparing statement:", update_sql)
 135         si.update_tried = true
 136         lib.Logger.Println("dbh.Prepare", update_sql)
 137         stmt, err := si.dbh.Prepare(update_sql)
 138         if err != nil {
 139                 lib.Logger.Println("- prepare gave error:", err.Error())
 140                 if !error_in_expected_list(err.Error(), EXPECTED_UPDATE_ERRORS) {
 141                         log.Fatal("Not expected error so giving up")
 142                 } else {
 143                         lib.Logger.Println("- expected error so not running statement")
 144                 }
 145         } else {
 146                 lib.Logger.Println("Prepare succeeded, trying to update", len(si.rows), "row(s)")
 147                 count = 0
 148                 for i := range si.rows {
 149                         lib.Logger.Println("- changing row:", si.rows[i].NAME)
 150                         lib.Logger.Println("stmt.Exec", "YES", "YES", si.rows[i].NAME)
 151                         if res, err := stmt.Exec("YES", "YES", si.rows[i].NAME); err == nil {
 152                                 lib.Logger.Println("update succeeded")
 153                                 si.update_succeeded = true
 154                                 c, _ := res.RowsAffected()
 155                                 count += int(c)
 156                         } else {
 157                                 si.update_succeeded = false
 158                                 if error_in_expected_list(err.Error(), EXPECTED_UPDATE_ERRORS) {
 159                                         lib.Logger.Println("Insufficient privileges to UPDATE setup_instruments: " + err.Error())
 160                                         lib.Logger.Println("Not attempting further updates")
 161                                         return
 162                                 } else {
 163                                         log.Fatal(err)
 164                                 }
 165                         }
 166                 }
 167                 if si.update_succeeded {
 168                         lib.Logger.Println(count, "rows changed in p_s.setup_instruments")
 169                 }
 170                 stmt.Close()
 171         }
 172         lib.Logger.Println("Configure() returns update_tried", si.update_tried, ", update_succeeded", si.update_succeeded)
 173 }
 174
 175 // restore setup_instruments rows to their previous settings
 176 func (si *SetupInstruments) RestoreConfiguration() {
 177         lib.Logger.Println("RestoreConfiguration()")
 178         // If the previous update didn't work then don't try to restore
 179         if !si.update_succeeded {
 180                 lib.Logger.Println("Not restoring p_s.setup_instruments to original settings as initial configuration attempt failed")
 181                 return
 182         } else {
 183                 lib.Logger.Println("Restoring p_s.setup_instruments to its original settings")
 184         }
 185
 186         // update the rows which need to be set - do multiple updates but I don't care
 187         update_sql := "UPDATE setup_instruments SET enabled = ?, TIMED = ? WHERE NAME = ?"
 188         lib.Logger.Println("dbh.Prepare(", update_sql, ")")
 189         stmt, err := si.dbh.Prepare(update_sql)
 190         if err != nil {
 191                 log.Fatal(err)
 192         }
 193         count := 0
 194         for i := range si.rows {
 195                 lib.Logger.Println("stmt.Exec(", si.rows[i].ENABLED, si.rows[i].TIMED, si.rows[i].NAME, ")")
 196                 if _, err := stmt.Exec(si.rows[i].ENABLED, si.rows[i].TIMED, si.rows[i].NAME); err != nil {
 197                         log.Fatal(err)
 198                 }
 199                 count++
 200         }
 201         lib.Logger.Println("stmt.Close()")
 202         stmt.Close()
 203         lib.Logger.Println(count, "rows changed in p_s.setup_instruments")
 204 }