Install & configure NRDOT for MySQL monitoring with AWS RDS

Prerequisites

Before you install, make sure you have:

• A New Relic license key.
• Network connectivity between the host where you install the NRDOT Collector and your RDS MySQL instance.
• Network connectivity to New Relic OTLP endpoints documentation
• RDS master user credentials.

For supported MySQL versions, required grants, and performance_schema requirements, see Compatibility and prerequisites.

Set up NRDOT Collector

Install the NRDOT Collector on a system that can connect to your RDS instance:

Configure database user

Create a monitoring user with the necessary privileges for your RDS MySQL instance.

• To create a monitoring user, connect to your RDS instance as the master user and run:

  CREATE USER '<YOUR_DB_USERNAME>'@'%' IDENTIFIED BY '<YOUR_DB_PASSWORD>';

  카피

• To collect query samples and top queries, grant the following privileges to the monitoring user:

  GRANT SELECT ON performance_schema.* TO '<YOUR_DB_USERNAME>'@'%';
  GRANT SELECT ON *.* TO '<YOUR_DB_USERNAME>'@'%';
  GRANT REPLICATION CLIENT ON *.* TO '<YOUR_DB_USERNAME>'@'%';
  GRANT PROCESS ON *.* TO '<YOUR_DB_USERNAME>'@'%';

  카피

• (Optional) To view the wait-time data in New Relic platform, grant the following privileges to the monitoring user:

  GRANT UPDATE ON performance_schema.setup_consumers TO '<YOUR_DB_USERNAME>'@'%';

  카피

  팁

  This setting doesn't persist on RDS; the events_waits_current consumer resets on every restart or failover. Granting this privilege lets the collector automatically re-enable it on reconnect; otherwise you'll need to re-run the enable statement after every restart.

• (Optional) To verify the connection and grants, run:

  bash

  카피

  $
  mysql -h <YOUR_DB_HOST> -P <YOUR_DB_PORT> -u <YOUR_DB_USERNAME> -p -e "SELECT 1;"

  If the command completes without an error, the monitoring user, host, and port are all correct.

Configure NRDOT Collector

Configure the NRDOT Collector with your MySQL-specific settings.

This configuration focuses on essential MySQL monitoring with the nrmysql receiver only.

1. Create a configuration file named mysql-config.yaml:

   bash

   카피

   $
   sudo nano /etc/nrdot-collector/mysql-config.yaml

2. Add the following configuration to the mysql-config.yaml file you created in the previous step.

receivers:
  nrmysql:
    endpoint: "<YOUR_DB_HOST>:<YOUR_DB_PORT>"
    transport: tcp
    username: "<YOUR_DB_USERNAME>"
    password: "<YOUR_DB_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: "<YOUR_NEWRELIC_OTLP_ENDPOINT>"
    headers:
      api-key: "<YOUR_NEWRELIC_LICENSE_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]

Configuration parameters

The following table describes the key configuration parameters for the nrmysql receiver:

Validate NRDOT Collector configuration

1. Update the config path to point to your new mysql-config.yaml file:

   bash

   카피

   $
   sudo sed -i 's|OTELCOL_OPTIONS="--config=/etc/nrdot-collector/config.yaml"|OTELCOL_OPTIONS="--config=/etc/nrdot-collector/mysql-config.yaml"|' /etc/nrdot-collector/nrdot-collector.conf

2. Validate the NRDOT Collector configuration to ensure it's correctly formatted and will work properly:

   bash

   카피

   $
   sudo /usr/bin/nrdot-collector validate --config=/etc/nrdot-collector/mysql-config.yaml

Restart NRDOT Collector

• After updating your configuration, restart the NRDOT Collector service:

  bash

  카피

  $
  sudo systemctl restart nrdot-collector

  팁

  Always restart the NRDOT Collector service after making configuration changes to ensure the new settings take effect.

• To verify that the collector is running properly, check the service status:

  bash

  카피

  $
  sudo systemctl status nrdot-collector

Find and use your data

Once your data is being collected, you can access comprehensive RDS MySQL database monitoring through the New Relic UI.

To find your RDS MySQL database entity in New Relic:

1. Go to https://one.newrelic.com > All Capabilities > Databases.
2. From the Entity type dropdown, select MySQL instance, then click Apply.
3. Select your RDS MySQL database from the list of entities.