// Copyright 2018 The Prometheus Authors // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // Scrape `performance_schema.file_summary_by_instance`. package collector import ( "context" "log/slog" "strings" "github.com/alecthomas/kingpin/v2" "github.com/prometheus/client_golang/prometheus" ) const perfFileInstancesQuery = ` SELECT FILE_NAME, EVENT_NAME, COUNT_READ, COUNT_WRITE, SUM_NUMBER_OF_BYTES_READ, SUM_NUMBER_OF_BYTES_WRITE FROM performance_schema.file_summary_by_instance where FILE_NAME REGEXP ? ` // Tunable flags. var ( performanceSchemaFileInstancesFilter = kingpin.Flag( "collect.perf_schema.file_instances.filter", "RegEx file_name filter for performance_schema.file_summary_by_instance", ).Default(".*").String() performanceSchemaFileInstancesRemovePrefix = kingpin.Flag( "collect.perf_schema.file_instances.remove_prefix", "Remove path prefix in performance_schema.file_summary_by_instance", ).Default("/var/lib/mysql/").String() ) // Metric descriptors. var ( performanceSchemaFileInstancesBytesDesc = prometheus.NewDesc( prometheus.BuildFQName(namespace, performanceSchema, "file_instances_bytes"), "The number of bytes processed by file read/write operations.", []string{"file_name", "event_name", "mode"}, nil, ) performanceSchemaFileInstancesCountDesc = prometheus.NewDesc( prometheus.BuildFQName(namespace, performanceSchema, "file_instances_total"), "The total number of file read/write operations.", []string{"file_name", "event_name", "mode"}, nil, ) ) // ScrapePerfFileInstances collects from `performance_schema.file_summary_by_instance`. type ScrapePerfFileInstances struct{} // Name of the Scraper. Should be unique. func (ScrapePerfFileInstances) Name() string { return "perf_schema.file_instances" } // Help describes the role of the Scraper. func (ScrapePerfFileInstances) Help() string { return "Collect metrics from performance_schema.file_summary_by_instance" } // Version of MySQL from which scraper is available. func (ScrapePerfFileInstances) Version() float64 { return 5.5 } // Scrape collects data from database connection and sends it over channel as prometheus metric. func (ScrapePerfFileInstances) Scrape(ctx context.Context, instance *instance, ch chan<- prometheus.Metric, logger *slog.Logger) error { db := instance.getDB() // Timers here are returned in picoseconds. perfSchemaFileInstancesRows, err := db.QueryContext(ctx, perfFileInstancesQuery, *performanceSchemaFileInstancesFilter) if err != nil { return err } defer perfSchemaFileInstancesRows.Close() var ( fileName, eventName string countRead, countWrite uint64 sumBytesRead, sumBytesWritten uint64 ) for perfSchemaFileInstancesRows.Next() { if err := perfSchemaFileInstancesRows.Scan( &fileName, &eventName, &countRead, &countWrite, &sumBytesRead, &sumBytesWritten, ); err != nil { return err } fileName = strings.TrimPrefix(fileName, *performanceSchemaFileInstancesRemovePrefix) ch <- prometheus.MustNewConstMetric( performanceSchemaFileInstancesCountDesc, prometheus.CounterValue, float64(countRead), fileName, eventName, "read", ) ch <- prometheus.MustNewConstMetric( performanceSchemaFileInstancesCountDesc, prometheus.CounterValue, float64(countWrite), fileName, eventName, "write", ) ch <- prometheus.MustNewConstMetric( performanceSchemaFileInstancesBytesDesc, prometheus.CounterValue, float64(sumBytesRead), fileName, eventName, "read", ) ch <- prometheus.MustNewConstMetric( performanceSchemaFileInstancesBytesDesc, prometheus.CounterValue, float64(sumBytesWritten), fileName, eventName, "write", ) } return nil } // check interface var _ Scraper = ScrapePerfFileInstances{}