Skip to content
Percona Software for MySQL Documentation
Rate this page
☆ ☆ ☆ ☆ ☆
Thanks for your feedback
Thank you! The feedback has been submitted.

For help, click the link below to get free database assistance or contact our experts for personalized support.

Get help from Percona

Install and manage the OpenTelemetry component

Note

The OpenTelemetry component (component_telemetry) is a community MySQL 9.7 feature. Percona Server for MySQL includes this component. The component works the same as in upstream MySQL.

The OpenTelemetry component is a dynamically loadable module. Percona Server for MySQL does not load this component by default. To stream metrics, traces, and logs to your configured endpoints, install the component first.

The mysql client uses a separate telemetry_client plugin. See OpenTelemetry client plugin.

Install the component

To install the component, connect to the server with a user account that has the INSERT privilege on the mysql.component system table. Run the following statement:

INSTALL COMPONENT 'file://component_telemetry';

This statement registers the component in the mysql.component system table. Percona Server loads the component automatically on every server restart. You do not need to add loading directives to your my.cnf file.

Verify the installation

To confirm that the component is loaded, query the mysql.component system table:

SELECT component_urn
FROM mysql.component
WHERE component_urn = 'file://component_telemetry';

A returned row with file://component_telemetry confirms the installation. You can then configure your metrics, traces, and logging endpoints.

Uninstall the component

You can remove the component without restarting the database server.

Warning

Uninstalling the component unloads it without a restart. Collection stops during the UNINSTALL COMPONENT statement. The component flushes traces and logs with a 10 ms timeout, then shuts the exporters down. Queued data may be lost if the collector is slow or unavailable. This action creates gaps in your monitoring dashboards. Before you remove the component, confirm that your observability platforms, such as Percona Monitoring and Management or an external OpenTelemetry collector, do not depend on this data.

To uninstall the component, run the following statement:

UNINSTALL COMPONENT 'file://component_telemetry';

This statement unloads the component from memory and also removes the component entry from the mysql.component table. After uninstallation, the component does not load during future server restarts. The statement does not clear persisted telemetry variables.