Type to search.

MySQL (OpenTelemetry)

Serverless Observability Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Serverless Security Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Stack Preview 9.4+

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview since 9.4

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Version 0.2.3 Availability Preview This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply. (View all)
Subscription level
What's this?		 Basic
Developed by
What's this?		 Elastic
Minimum Kibana version(s) 9.4.0
The MySQL (OpenTelemetry) integration v0.2.3 is in technical preview

To use pre-release integrations, go to the Integrations page in Kibana, scroll down, and toggle on the Display beta integrations option.

This input package enables collection of metrics and logs from MySQL database servers through OpenTelemetry protocols using the mysqlreceiver.

This package receives telemetry data from MySQL servers by configuring the MySQL endpoint and credentials in the Input Package, which then gets applied to the mysqlreceiver present in the EDOT collector, which then forwards the data to Elastic Agent. The Elastic Agent processes and enriches the data before sending it to Elasticsearch for indexing and analysis. Once the data arrives into Elasticsearch, its corresponding MySQL OpenTelemetry Assets Package gets auto installed and the dashboards light up.

The package collects both metrics (from SHOW GLOBAL STATUS and InnoDB tables) and logs (query samples and top queries). Log events are controlled by the Enable Query Sample Events and Enable Top Query Events settings:

  • db.server.query_sample: Current running database statements (enabled by default)
  • db.server.top_query: Queries that consumed the most CPU (disabled by default)
  • MySQL 8.0+ or MariaDB 10.11+
  • A MySQL user with permissions to run SHOW GLOBAL STATUS
  • For query sample collection, the performance_schema must be enabled

To collect log events (query samples and top queries), configure MySQL as follows. For additional details, see the upstream mysqlreceiver logs documentation.

Parameter Value Description
performance_schema Enabled Required for log collection
max_digest_length 4096 Recommended maximum length of digest text
performance_schema_max_digest_length 4096 Recommended maximum length of digest text on performance schema
performance_schema_max_sql_text_length 4096 Recommended maximum length of SQL text

Also grant the MySQL user access to the performance schema:

SQL 
GRANT SELECT ON performance_schema.* TO <your-user>@'%';

For the full list of settings exposed for the receiver and examples, refer to the configuration section.

For a complete list of all available metrics, log events, and their detailed descriptions, refer to the MySQL Receiver documentation in the upstream OpenTelemetry Collector repository.

Changelog
Version Details Minimum Kibana version
0.2.3 Enhancement (View pull request)
Add group field to package manifest.		 9.4.0
0.2.2 Enhancement (View pull request)
Update package title and description to improve clarity of use.		 9.4.0
0.2.1 Bug fix (View pull request)
Remove type for dynamic signal type manifest field		 9.4.0
0.2.0 Enhancement (View pull request)
Add logs support via multisignal (query samples, top queries)		 9.4.0
0.1.1 Enhancement (View pull request)
Add metrics configuration		 9.2.2
0.1.0 Enhancement (View pull request)
Initial release of MySQL OpenTelemetry input package		 9.2.2