Installer & configurer NRDOT pour le monitoring MySQL avec Docker

Prérequis

Avant d’installer, assurez-vous d’avoir :

• Docker installé sur l’hôte.

• Un conteneur MySQL déjà en cours d’exécution (MySQL 5.7 ou version ultérieure).

• Une clé de licence New Relic.

• Connectivité réseau depuis le conteneur du collecteur vers les points de terminaison OTLP de New Relic.

  Pour les versions de MySQL prises en charge, les droits requis et les exigences performance_schema, consultez Compatibilité et prérequis.

Configurer l'utilisateur de la base de données

Créez un utilisateur de monitoring avec les privilèges nécessaires en exécutant du SQL sur votre conteneur MySQL avec docker exec. Remplacez <YOUR_MYSQL_CONTAINER_NAME>, <YOUR_MYSQL_ROOT_PASSWORD>, <YOUR_DB_USERNAME> et <YOUR_DB_PASSWORD> par vos propres valeurs.

• Pour créer un utilisateur de monitoring avec les privilèges minimaux nécessaires pour la collecte de métriques, exécutez :

  bash

  Copier

  $
  docker exec -i <YOUR_MYSQL_CONTAINER_NAME> mysql -u root -p'<YOUR_MYSQL_ROOT_PASSWORD>' -e "CREATE USER '<YOUR_DB_USERNAME>'@'%' IDENTIFIED BY '<YOUR_DB_PASSWORD>'; GRANT SELECT ON performance_schema.* TO '<YOUR_DB_USERNAME>'@'%'; FLUSH PRIVILEGES;"

• Pour collecter également des échantillons de requêtes et les principales requêtes, accordez plutôt l’ensemble complet des privilèges :

  bash

  Copier

  $
  docker exec -i <YOUR_MYSQL_CONTAINER_NAME> mysql -u root -p'<YOUR_MYSQL_ROOT_PASSWORD>' -e "CREATE USER '<YOUR_DB_USERNAME>'@'%' IDENTIFIED BY '<YOUR_DB_PASSWORD>'; GRANT SELECT, PROCESS, REPLICATION CLIENT ON *.* TO '<YOUR_DB_USERNAME>'@'%'; GRANT SELECT ON performance_schema.* TO '<YOUR_DB_USERNAME>'@'%'; FLUSH PRIVILEGES;"

• (Facultatif) Pour afficher les données de temps d’attente dans la plateforme New Relic, accordez le privilège suivant à l’utilisateur de monitoring :

  bash

  Copier

  $
  docker exec -i <YOUR_MYSQL_CONTAINER_NAME> mysql -u root -p'<YOUR_MYSQL_ROOT_PASSWORD>' -e "GRANT UPDATE ON performance_schema.setup_consumers TO '<YOUR_DB_USERNAME>'@'%'; FLUSH PRIVILEGES;"

• (Facultatif) Pour vérifier la connexion et les autorisations, exécutez :

  bash

  Copier

  $
  docker exec -i <YOUR_MYSQL_CONTAINER_NAME> mysql -u '<YOUR_DB_USERNAME>' -p'<YOUR_DB_PASSWORD>' -e "SELECT 1;"

  Si la commande se termine sans erreur, l’utilisateur de monitoring et le mot de passe sont corrects.

Créez la configuration du Collector NRDOT

Cette configuration se concentre sur le monitoring essentiel de MySQL avec le Récepteur nrmysql. Exécutez ce qui suit sur l'hôte Docker pour générer mysql-config.yaml dans votre répertoire courant :

$
cat << 'EOF' > mysql-config.yaml
$
receivers:
$
  nrmysql:
$
    endpoint: "<YOUR_MYSQL_CONTAINER_NAME>:3306"
$
    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]
$
EOF

Paramètres de configuration

Démarrer le conteneur NRDOT Collector

Exécutez le collecteur sur le même réseau Docker que votre conteneur MySQL pour qu'il puisse résoudre <YOUR_MYSQL_CONTAINER_NAME> par son nom de conteneur :

$
docker run -d \
>
  --name nrdot-collector \
>
  --network <YOUR_DOCKER_NETWORK> \
>
  -v "$PWD/mysql-config.yaml:/etc/nrdot-collector/mysql-config.yaml" \
>
  newrelic/nrdot-collector:latest \
>
  --config /etc/nrdot-collector/mysql-config.yaml

$
docker network create <YOUR_DOCKER_NETWORK>
$
docker network connect <YOUR_DOCKER_NETWORK> <YOUR_MYSQL_CONTAINER_NAME>

Confirmez que le conteneur du collecteur est en cours d'exécution :

$
docker ps --filter name=nrdot-collector

S’il n’est pas en cours d’exécution, vérifiez ses logs pour détecter des erreurs. Les causes les plus courantes sont des problèmes d'indentation YAML dans mysql-config.yaml ou un conteneur MySQL inaccessible :

$
docker logs nrdot-collector

$
docker restart nrdot-collector

Trouvez et utilisez vos données

Une fois vos données collectées, vous pouvez accéder à un monitoring complet de la base de données MySQL via l'UI de New Relic.

Pour trouver votre entité de base de données MySQL dans New Relic :

1. Allez à one.newrelic.com > All capabilities > Databases.

2. Dans la liste déroulante Entity type, sélectionnez MySQL instance, puis cliquez sur Apply.

3. Sélectionnez votre base de données MySQL dans la liste des entités.

   Pour confirmer que les données arrivent, exécutez cette requête dans le générateur de requêtes:

   SELECT count(*) FROM Metric
   WHERE metricName LIKE 'mysql.%'
   AND instrumentation.provider = 'opentelemetry'
   SINCE 10 minutes ago

   Copier