From e15a7e4286017d1e6b6367f674ce1b8709f32062 Mon Sep 17 00:00:00 2001 From: Larissa Wandzura Date: Mon, 12 Jan 2026 14:34:27 -0600 Subject: [PATCH] updated the intro doc --- docs/sources/datasources/mysql/_index.md | 107 +++++++++++++++--- .../datasources/mysql/annotations/index.md | 2 +- .../datasources/mysql/query-editor/_index.md | 2 +- 3 files changed, 92 insertions(+), 19 deletions(-) diff --git a/docs/sources/datasources/mysql/_index.md b/docs/sources/datasources/mysql/_index.md index 61ba7d31db8..27496d42335 100644 --- a/docs/sources/datasources/mysql/_index.md +++ b/docs/sources/datasources/mysql/_index.md @@ -17,11 +17,6 @@ menuTitle: MySQL title: MySQL data source weight: 1000 refs: - annotate-visualizations: - - pattern: /docs/grafana/ - destination: /docs/grafana//dashboards/build-dashboards/annotate-visualizations/ - - pattern: /docs/grafana-cloud/ - destination: /docs/grafana-cloud/visualizations/dashboards/build-dashboards/annotate-visualizations/ configure-mysql-data-source: - pattern: /docs/grafana/ destination: /docs/grafana//datasources/mysql/configure/ @@ -42,11 +37,6 @@ refs: destination: /docs/grafana//datasources/mysql/template-variables/ - pattern: /docs/grafana-cloud/ destination: /docs/grafana//datasources/mysql/template-variables/ - alerting: - - pattern: /docs/grafana/ - destination: /docs/grafana//alerting/ - - pattern: /docs/grafana-cloud/ - destination: /docs/grafana-cloud/alerting-and-irm/alerting/ mysql-alerting: - pattern: /docs/grafana/ destination: /docs/grafana//datasources/mysql/alerting/ @@ -62,17 +52,70 @@ refs: destination: /docs/grafana//panels-visualizations/query-transform-data/transform-data/ - pattern: /docs/grafana-cloud/ destination: /docs/grafana-cloud/visualizations/panels-visualizations/query-transform-data/transform-data/ + visualizations: + - pattern: /docs/grafana/ + destination: /docs/grafana//panels-visualizations/visualizations/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/ + variables: + - pattern: /docs/grafana/ + destination: /docs/grafana//dashboards/variables/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana-cloud/visualizations/dashboards/variables/ + query-caching: + - pattern: /docs/grafana/ + destination: /docs/grafana//administration/data-source-management/#query-and-resource-caching + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana//administration/data-source-management/#query-and-resource-caching + postgres: + - pattern: /docs/grafana/ + destination: /docs/grafana//datasources/postgres/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana//datasources/postgres/ + mssql: + - pattern: /docs/grafana/ + destination: /docs/grafana//datasources/mssql/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana//datasources/mssql/ --- # MySQL data source -Grafana ships with a built-in MySQL data source plugin that allows you to query and visualize data from a MySQL-compatible database like [MariaDB](https://mariadb.org/) or [Percona Server](https://www.percona.com/). You don't need to install a plugin in order to add the MySQL data source to your Grafana instance. +Grafana ships with built-in support for MySQL. +You can query and visualize data from MySQL-compatible databases like [MariaDB](https://mariadb.org/) or [Percona Server](https://www.percona.com/). -Grafana offers several configuration options for this data source as well as a visual and code-based query editor. +Use this data source to create dashboards, explore SQL data, and monitor MySQL-based workloads in real time. -## Get started with the MySQL data source +{{< docs/play title="MySQL Overview" url="https://play.grafana.org/d/edyh1ib7db6rkb/mysql-overview" >}} -The following documents will help you get started with the MySQL data source in Grafana: +## Supported databases + +This data source supports the following MySQL-compatible databases: + +- MySQL 5.7 and newer +- MySQL 8.0 and newer +- MariaDB 10.2 and newer +- Percona Server 5.7 and newer +- Amazon Aurora MySQL +- Azure Database for MySQL +- Google Cloud SQL for MySQL + +Grafana recommends using the latest available version for your database for optimal compatibility. + +## Key capabilities + +The MySQL data source supports: + +- **Time series queries:** Visualize metrics over time using built-in time grouping macros. +- **Table queries:** Display query results in table format for any valid SQL query. +- **Template variables:** Create dynamic dashboards with variable-driven queries. +- **Annotations:** Overlay events from MySQL on your dashboard graphs. +- **Alerting:** Create alerts based on MySQL query results. +- **Macros:** Simplify queries with built-in macros for time filtering and grouping. + +## Get started + +The following documentation helps you get started with the MySQL data source: - [Configure the MySQL data source](ref:configure-mysql-data-source) - [MySQL query editor](ref:mysql-query-editor) @@ -81,8 +124,38 @@ The following documents will help you get started with the MySQL data source in - [MySQL alerting](ref:mysql-alerting) - [Troubleshoot MySQL data source issues](ref:troubleshoot-mysql) -Once you have configured the data source you can also add [transformations](ref:transformations) to your queries. +## Additional resources -View a MySQL overview on Grafana Play: +After configuring the MySQL data source, you can also: -{{< docs/play title="MySQL Overview" url="https://play.grafana.org/d/edyh1ib7db6rkb/mysql-overview" >}} +- Create a wide variety of [visualizations](ref:visualizations). +- Configure and use [templates and variables](ref:variables). +- Add [transformations](ref:transformations). +- Optimize performance with [query caching](ref:query-caching). + +## Pre-configured dashboards + +If you want to monitor your MySQL server's performance metrics (connections, queries, replication, and more), Grafana provides pre-configured dashboards through the MySQL integration: + +- **MySQL Overview** - Key performance metrics for your MySQL server. +- **MySQL Logs** - Log analysis for troubleshooting. + +The MySQL integration uses the Prometheus MySQL Exporter to collect server metrics and includes 15 pre-configured alert rules. + +To use these dashboards: + +1. In Grafana Cloud, navigate to **Connections** > **Add new connection**. +1. Search for **MySQL** and select the MySQL integration. +1. Follow the setup instructions to install the MySQL Exporter. +1. Import the pre-configured dashboards from the integration page. + +For more MySQL dashboards, browse the [Grafana dashboard catalog](https://grafana.com/grafana/dashboards/?search=mysql). + +{{< admonition type="note" >}} +The MySQL integration monitors your MySQL *server* using Prometheus metrics. The MySQL *data source* documented here queries data stored *in* MySQL tables. These are complementary features for different use cases. +{{< /admonition >}} + +## Related data sources + +- [PostgreSQL](ref:postgres) - For PostgreSQL databases. +- [Microsoft SQL Server](ref:mssql) - For Microsoft SQL Server and Azure SQL databases. diff --git a/docs/sources/datasources/mysql/annotations/index.md b/docs/sources/datasources/mysql/annotations/index.md index 69df0ec61b8..852cb344ad0 100644 --- a/docs/sources/datasources/mysql/annotations/index.md +++ b/docs/sources/datasources/mysql/annotations/index.md @@ -12,7 +12,7 @@ labels: - oss menuTitle: Annotations title: MySQL annotations -weight: 400 +weight: 340 refs: annotate-visualizations: - pattern: /docs/grafana/ diff --git a/docs/sources/datasources/mysql/query-editor/_index.md b/docs/sources/datasources/mysql/query-editor/_index.md index 59230116f8a..459e03d261d 100644 --- a/docs/sources/datasources/mysql/query-editor/_index.md +++ b/docs/sources/datasources/mysql/query-editor/_index.md @@ -9,7 +9,7 @@ labels: - cloud - enterprise - oss -menuTitle: MySQL query editor +menuTitle: Query editor title: MySQL query editor weight: 30 refs: