Merge commit 'e84f4f22f8a11089d5f04ff9bfdc5fc042605773' of ssh://github.com/prometheus/mysqld_exporter into PMM-12153-upgrade-mysql-exporter (v17.2)

Author: ademidoff

.github/workflows/container_description.yml

@@ -0,0 +1,57 @@
+---
+name: Push README to Docker Hub
+on:
+  push:
+    paths:
+      - "README.md"
+      - "README-containers.md"
+      - ".github/workflows/container_description.yml"
+    branches: [ main, master ]
+
+permissions:
+  contents: read
+
+jobs:
+  PushDockerHubReadme:
+    runs-on: ubuntu-latest
+    name: Push README to Docker Hub
+    if: github.repository_owner == 'prometheus' || github.repository_owner == 'prometheus-community' # Don't run this workflow on forks.
+    steps:
+      - name: git checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: Set docker hub repo name
+        run: echo "DOCKER_REPO_NAME=$(make docker-repo-name)" >> $GITHUB_ENV
+      - name: Push README to Dockerhub
+        uses: christian-korneck/update-container-description-action@d36005551adeaba9698d8d67a296bd16fa91f8e8 # v1
+        env:
+          DOCKER_USER: ${{ secrets.DOCKER_HUB_LOGIN }}
+          DOCKER_PASS: ${{ secrets.DOCKER_HUB_PASSWORD }}
+        with:
+          destination_container_repo: ${{ env.DOCKER_REPO_NAME }}
+          provider: dockerhub
+          short_description: ${{ env.DOCKER_REPO_NAME }}
+          # Empty string results in README-containers.md being pushed if it
+          # exists. Otherwise, README.md is pushed.
+          readme_file: ''
+
+  PushQuayIoReadme:
+    runs-on: ubuntu-latest
+    name: Push README to quay.io
+    if: github.repository_owner == 'prometheus' || github.repository_owner == 'prometheus-community' # Don't run this workflow on forks.
+    steps:
+      - name: git checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: Set quay.io org name
+        run: echo "DOCKER_REPO=$(echo quay.io/${GITHUB_REPOSITORY_OWNER} | tr -d '-')" >> $GITHUB_ENV
+      - name: Set quay.io repo name
+        run: echo "DOCKER_REPO_NAME=$(make docker-repo-name)" >> $GITHUB_ENV
+      - name: Push README to quay.io
+        uses: christian-korneck/update-container-description-action@d36005551adeaba9698d8d67a296bd16fa91f8e8 # v1
+        env:
+          DOCKER_APIKEY: ${{ secrets.QUAY_IO_API_TOKEN }}
+        with:
+          destination_container_repo: ${{ env.DOCKER_REPO_NAME }}
+          provider: quay
+          # Empty string results in README-containers.md being pushed if it
+          # exists. Otherwise, README.md is pushed.
+          readme_file: ''

CHANGELOG.md

@@ -9,6 +9,28 @@ Changes:
 * [ENHANCEMENT]
 * [BUGFIX]
 
+## 0.17.2 / 2025-02-25
+
+Changes:
+
+* [BUGFIX] Fix query on events_statements_summary_by_digest for mariadb #922
+
+## 0.17.1 / 2025-02-21
+
+Changes:
+
+* [BUGFIX] Fix query on perf_schema.events_statements_summary_by_digest #920
+
+## 0.17.0 / 2025-02-19
+
+Changes:
+* [FEATURE] Add perf_schema quantile columns to collector #897
+* [BUGFIX] Update Mixin dashboard to "editable: false" #911
+* [BUGFIX] Fix typo for "locahost" #914
+* [BUGFIX] Fix database quoting problem in collector 'info_schema.tables' #908
+* [BUGFIX] Use SUM_LOCK_TIME and SUM_CPU_TIME with mysql >= 8.0.28 #916
+* [BUGFIX] Add missing metrics_path to multi-target example #899
+
 ## 0.16.0 / 2024-11-08
 
 Changes:

Makefile

@@ -37,6 +37,11 @@ env-up:           ## Start MySQL and copy ssl certificates to /tmp
 	@docker container cp mysqld_exporter_db:/var/lib/mysql/client-key.pem $(TESTDIR)
 	@docker container cp mysqld_exporter_db:/var/lib/mysql/ca.pem $(TESTDIR)
 
+.PHONY: test-docker-single-exporter
+test-docker-single-exporter:
+	@echo ">> testing docker image for single exporter"
+	./test_image.sh "$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_TAG)" 9104
+
 env-down:         ## Stop MySQL and clean up certs
 	@docker-compose down -v
 	@rm -rf ${TESTDIR}

README.md

@@ -54,6 +54,7 @@ Sample config file for multiple configurations
 On the prometheus side you can set a scrape config as follows
 
         - job_name: mysql # To get metrics about the mysql exporter’s targets
+          metrics_path: /probe
           params:
             # Not required. Will match value to child in config file. Default value is `client`.
             auth_module: [client.servers]
@@ -138,7 +139,7 @@ collect.sys.user_summary                                     | 5.7           | C
 ### General Flags
 Name                                       | Description
 -------------------------------------------|--------------------------------------------------------------------------------------------------
-mysqld.address                             | Hostname and port used for connecting to MySQL server, format: `host:port`. (default: `locahost:3306`)
+mysqld.address                             | Hostname and port used for connecting to MySQL server, format: `host:port`. (default: `localhost:3306`)
 mysqld.username                            | Username to be used for connecting to MySQL Server
 config.my-cnf                              | Path to .my.cnf file to read MySQL credentials from. (default: `~/.my.cnf`)
 log.level                                  | Logging verbosity (default: info)

VERSION

@@ -1 +1 @@
-0.16.0
+0.17.2

collector/collector_test.go

@@ -41,6 +41,9 @@ func readMetric(m prometheus.Metric) MetricResult {
 	if pb.Counter != nil {
 		return MetricResult{labels: labels, value: pb.GetCounter().GetValue(), metricType: dto.MetricType_COUNTER}
 	}
+	if pb.Summary != nil {
+		return MetricResult{labels: labels, value: pb.GetSummary().GetSampleSum(), metricType: dto.MetricType_SUMMARY}
+	}
 	if pb.Untyped != nil {
 		return MetricResult{labels: labels, value: pb.GetUntyped().GetValue(), metricType: dto.MetricType_UNTYPED}
 	}

collector/info_schema_tables.go

@@ -17,7 +17,6 @@ package collector
 
 import (
 	"context"
-	"fmt"
 	"log/slog"
 	"strings"
 
@@ -40,7 +39,7 @@ const (
 		    ifnull(DATA_FREE, '0') as DATA_FREE,
 		    ifnull(CREATE_OPTIONS, 'NONE') as CREATE_OPTIONS
 		  FROM information_schema.tables
-		  WHERE TABLE_SCHEMA = '%s'
+		  WHERE TABLE_SCHEMA = ?
 		`
 	dbListQuery = `
 		SELECT
@@ -99,13 +98,6 @@ func (ScrapeTableSchema) Version() float64 {
 func (ScrapeTableSchema) Scrape(ctx context.Context, instance *instance, ch chan<- prometheus.Metric, logger *slog.Logger) error {
 	var dbList []string
 	db := instance.getDB()
-
-	// This query will affect only 8.0 and higher versions of MySQL, othervise it will be ignored
-	_, err := db.ExecContext(ctx, "/*!80000 set session information_schema_stats_expiry=0 */")
-	if err != nil {
-		return err
-	}
-
 	if *tableSchemaDatabases == "*" {
 		dbListRows, err := db.QueryContext(ctx, dbListQuery)
 		if err != nil {
@@ -128,7 +120,7 @@ func (ScrapeTableSchema) Scrape(ctx context.Context, instance *instance, ch chan
 	}
 
 	for _, database := range dbList {
-		tableSchemaRows, err := db.QueryContext(ctx, fmt.Sprintf(tableSchemaQuery, database))
+		tableSchemaRows, err := db.QueryContext(ctx, tableSchemaQuery, database)
 		if err != nil {
 			return err
 		}

collector/perf_schema_events_statements.go

@@ -21,10 +21,55 @@ import (
 	"log/slog"
 
 	"github.com/alecthomas/kingpin/v2"
+	"github.com/blang/semver/v4"
 	"github.com/prometheus/client_golang/prometheus"
 )
 
 const perfEventsStatementsQuery = `
+	SELECT
+	    ifnull(SCHEMA_NAME, 'NONE') as SCHEMA_NAME,
+	    DIGEST,
+	    LEFT(DIGEST_TEXT, %d) as DIGEST_TEXT,
+	    COUNT_STAR,
+	    SUM_TIMER_WAIT,
+	    SUM_ERRORS,
+	    SUM_WARNINGS,
+	    SUM_ROWS_AFFECTED,
+	    SUM_ROWS_SENT,
+	    SUM_ROWS_EXAMINED,
+	    SUM_CREATED_TMP_DISK_TABLES,
+	    SUM_CREATED_TMP_TABLES,
+	    SUM_SORT_MERGE_PASSES,
+	    SUM_SORT_ROWS,
+	    SUM_NO_INDEX_USED
+	  FROM (
+	    SELECT *
+	    FROM performance_schema.events_statements_summary_by_digest
+	    WHERE SCHEMA_NAME NOT IN ('mysql', 'performance_schema', 'information_schema')
+	      AND LAST_SEEN > DATE_SUB(NOW(), INTERVAL %d SECOND)
+	    ORDER BY LAST_SEEN DESC
+	  )Q
+	  GROUP BY
+	    Q.SCHEMA_NAME,
+	    Q.DIGEST,
+	    Q.DIGEST_TEXT,
+	    Q.COUNT_STAR,
+	    Q.SUM_TIMER_WAIT,
+	    Q.SUM_ERRORS,
+	    Q.SUM_WARNINGS,
+	    Q.SUM_ROWS_AFFECTED,
+	    Q.SUM_ROWS_SENT,
+	    Q.SUM_ROWS_EXAMINED,
+	    Q.SUM_CREATED_TMP_DISK_TABLES,
+	    Q.SUM_CREATED_TMP_TABLES,
+	    Q.SUM_SORT_MERGE_PASSES,
+	    Q.SUM_SORT_ROWS,
+	    Q.SUM_NO_INDEX_USED
+	  ORDER BY SUM_TIMER_WAIT DESC
+	  LIMIT %d
+	`
+
+const perfEventsStatementsQueryMySQL = `
 	SELECT
 	    ifnull(SCHEMA_NAME, 'NONE') as SCHEMA_NAME,
 	    DIGEST,
@@ -193,12 +238,20 @@ func (ScrapePerfEventsStatements) Version() float64 {
 
 // Scrape collects data from database connection and sends it over channel as prometheus metric.
 func (ScrapePerfEventsStatements) Scrape(ctx context.Context, instance *instance, ch chan<- prometheus.Metric, logger *slog.Logger) error {
-	perfQuery := fmt.Sprintf(
-		perfEventsStatementsQuery,
+	mysqlVersion8028 := instance.flavor == FlavorMySQL && instance.version.GTE(semver.MustParse("8.0.28"))
+
+	perfQuery := perfEventsStatementsQuery
+	if mysqlVersion8028 {
+		perfQuery = perfEventsStatementsQueryMySQL
+	}
+
+	perfQuery = fmt.Sprintf(
+		perfQuery,
 		*perfEventsStatementsDigestTextLimit,
 		*perfEventsStatementsTimeLimit,
 		*perfEventsStatementsLimit,
 	)
+
 	db := instance.getDB()
 	// Timers here are returned in picoseconds.
 	perfSchemaEventsStatementsRows, err := db.QueryContext(ctx, perfQuery)
@@ -218,9 +271,17 @@ func (ScrapePerfEventsStatements) Scrape(ctx context.Context, instance *instance
 		quantile95, quantile99, quantile999  uint64
 	)
 	for perfSchemaEventsStatementsRows.Next() {
-		if err := perfSchemaEventsStatementsRows.Scan(
-			&schemaName, &digest, &digestText, &count, &queryTime, &lockTime, &cpuTime, &errors, &warnings, &rowsAffected, &rowsSent, &rowsExamined, &tmpDiskTables, &tmpTables, &sortMergePasses, &sortRows, &noIndexUsed, &quantile95, &quantile99, &quantile999,
-		); err != nil {
+		var err error
+		if mysqlVersion8028 {
+			err = perfSchemaEventsStatementsRows.Scan(
+				&schemaName, &digest, &digestText, &count, &queryTime, &lockTime, &cpuTime, &errors, &warnings, &rowsAffected, &rowsSent, &rowsExamined, &tmpDiskTables, &tmpTables, &sortMergePasses, &sortRows, &noIndexUsed, &quantile95, &quantile99, &quantile999,
+			)
+		} else {
+			err = perfSchemaEventsStatementsRows.Scan(
+				&schemaName, &digest, &digestText, &count, &queryTime, &errors, &warnings, &rowsAffected, &rowsSent, &rowsExamined, &tmpDiskTables, &tmpTables, &sortMergePasses, &sortRows, &noIndexUsed,
+			)
+		}
+		if err != nil {
 			return err
 		}
 		ch <- prometheus.MustNewConstMetric(