--- title: Install & configure NRDOT for MySQL monitoring with Docker source: https://docs.newrelic.com/docs/opentelemetry/db360/mysql/docker --- Set up MySQL monitoring using the NRDOT Collector as a sibling container to a MySQL instance that's already running in Docker. > #### 💡 TIP > > Looking to automate this at scale, or run on Kubernetes instead? Refer to [Ansible install](https://docs.newrelic.com/docs/opentelemetry/db360/mysql/ansible), [Chef install](https://docs.newrelic.com/docs/opentelemetry/db360/mysql/chef), or [Helm chart install](https://docs.newrelic.com/docs/opentelemetry/db360/mysql/helm). ## Prerequisites [#prerequisites] Before you install, make sure you have: - Docker installed on the host. - A MySQL container already running (MySQL 5.7 or later). - A New Relic [license key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#ingest-license-key). - Network connectivity from the collector container to [New Relic OTLP endpoints](https://docs.newrelic.com/docs/opentelemetry/best-practices/opentelemetry-otlp/). For supported MySQL versions, required grants, and `performance_schema` requirements, see [Compatibility and prerequisites](https://docs.newrelic.com/docs/opentelemetry/db360/mysql/compatibility). ## Configure database user [#user] Create a monitoring user with the necessary privileges by running SQL against your MySQL container with `docker exec`. Replace ``, ``, ``, and `` with your own values. - To create a monitoring user with the minimum privileges needed for metrics collection, run: ```bash docker exec -i mysql -u root -p'' -e "CREATE USER ''@'%' IDENTIFIED BY ''; GRANT SELECT ON performance_schema.* TO ''@'%'; FLUSH PRIVILEGES;" ``` - To also collect query samples and top queries, grant the full set of privileges instead: ```bash docker exec -i mysql -u root -p'' -e "CREATE USER ''@'%' IDENTIFIED BY ''; GRANT SELECT, PROCESS, REPLICATION CLIENT ON *.* TO ''@'%'; GRANT SELECT ON performance_schema.* TO ''@'%'; FLUSH PRIVILEGES;" ``` - (Optional) To view wait-time data in the New Relic platform, grant the following privilege to the monitoring user: ```bash docker exec -i mysql -u root -p'' -e "GRANT UPDATE ON performance_schema.setup_consumers TO ''@'%'; FLUSH PRIVILEGES;" ``` - (Optional) To verify the connection and grants, run: ```bash docker exec -i mysql -u '' -p'' -e "SELECT 1;" ``` If the command completes without an error, the monitoring user and password are correct. ## Create the NRDOT Collector configuration [#configure] This configuration focuses on essential MySQL monitoring with the `nrmysql` receiver. Run the following on the Docker host to generate `mysql-config.yaml` in your current directory: ```bash cat << 'EOF' > mysql-config.yaml receivers: nrmysql: endpoint: ":3306" transport: tcp username: "" password: "" allow_native_passwords: true collection_interval: 15s initial_delay: 1s explain_mode: procedure statement_events: digest_text_limit: 4096 time_limit: 24h limit: 500 query_sample_collection: max_rows_per_query: 100 allowed_comment_keys: [nr_service_guid] top_query_collection: lookback_time: 60 max_query_sample_count: 5000 top_query_count: 200 collection_interval: 60s query_plan_cache_size: 1000 query_plan_cache_ttl: 1h allowed_comment_keys: [nr_service_guid] events: db.server.query_sample: enabled: true db.server.top_query: enabled: true db.server.query_plan: enabled: true resource_attributes: db.system.version: enabled: true metrics: mysql.query.count: enabled: true mysql.query.slow.count: enabled: true mysql.commands: enabled: true mysql.innodb.data_file.io: enabled: true processors: batch: exporters: otlp/newrelic: endpoint: "" headers: api-key: "" compression: gzip retry_on_failure: enabled: true initial_interval: 5s max_interval: 30s max_elapsed_time: 300s service: pipelines: metrics: receivers: [nrmysql] processors: [batch] exporters: [otlp/newrelic] logs: receivers: [nrmysql] processors: [batch] exporters: [otlp/newrelic] EOF ``` ### Configuration parameters | Parameter | Description | | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `` | The name (or Docker DNS-resolvable hostname) of your running MySQL container. | | `` | The monitoring user you created in [Configure database user](#user). | | `` | The password of the monitoring user you created in [Configure database user](#user). | | `` | Your New Relic OTLP endpoint. For more information, see [New Relic OTLP endpoints](https://docs.newrelic.com/docs/opentelemetry/best-practices/opentelemetry-otlp/). | | `` | Your New Relic [license key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#ingest-license-key). | ## Start the NRDOT Collector container [#start] Run the collector on the same Docker network as your MySQL container so it can resolve `` by its container name: ```bash docker run -d \ --name nrdot-collector \ --network \ -v "$PWD/mysql-config.yaml:/etc/nrdot-collector/mysql-config.yaml" \ newrelic/nrdot-collector:latest \ --config /etc/nrdot-collector/mysql-config.yaml ``` > #### 💡 TIP > > Find your MySQL container's network with `docker inspect --format '{{json .NetworkSettings.Networks}}'`. If it isn't on a shared user-defined network yet, create one and connect both containers to it: > > ```bash > docker network create > docker network connect > ``` Confirm the collector container is running: ```bash docker ps --filter name=nrdot-collector ``` If it's not running, check its logs for errors. The most common causes are YAML indentation issues in `mysql-config.yaml` or an unreachable MySQL container: ```bash docker logs nrdot-collector ``` > #### 💡 TIP > > After changing `mysql-config.yaml`, restart the container to apply your changes: > > ```bash > docker restart nrdot-collector > ``` ## Find and use your data [#find] Once your data is being collected, you can access comprehensive MySQL database monitoring through the New Relic UI. To find your MySQL database entity in New Relic: 1. Go to **[one.newrelic.com](https://one.newrelic.com) > All capabilities > Databases**. 2. From the **Entity type** dropdown, select **MySQL instance**, then click **Apply**. 3. Select your MySQL database from the list of entities. To confirm data is arriving, run this query in the [query builder](https://docs.newrelic.com/docs/query-your-data/explore-query-data/query-builder/introduction-query-builder/): ```sql SELECT count(*) FROM Metric WHERE metricName LIKE 'mysql.%' AND instrumentation.provider = 'opentelemetry' SINCE 10 minutes ago ``` ## Related documentation [#related] [Introduction to MySQL monitoring with NRDOT](https://docs.newrelic.com/docs/opentelemetry/db360/mysql/introduction) Learn about all the available installation methods for MySQL monitoring with New Relic. [Self-hosted install](https://docs.newrelic.com/docs/opentelemetry/db360/mysql/hosted) Learn how to set up MySQL monitoring on physical servers, virtual machines, and standalone installations. [Ansible install](https://docs.newrelic.com/docs/opentelemetry/db360/mysql/ansible) Learn how to install and configure MySQL monitoring at scale with the newrelic.newrelic_install Ansible role. [Chef install](https://docs.newrelic.com/docs/opentelemetry/db360/mysql/chef) Learn how to install and configure MySQL monitoring at scale with the newrelic-install Chef cookbook. [Helm chart install](https://docs.newrelic.com/docs/opentelemetry/db360/mysql/helm) Learn how to install and configure MySQL monitoring on Kubernetes with the mysql-otel Helm chart.