Installer & configurer NRDOT pour MySQL auto-hébergé

Aperçu

Nous travaillons toujours sur cette fonctionnalité, mais nous aimerions que vous l'essayiez !

Cette fonctionnalité est actuellement fournie dans le cadre d'un aperçu conformément à nos politiques de pré-sortie.

Configurez le monitoring MySQL à l'aide du Collector NRDOT sur des environnements auto-hébergés, y compris des serveurs physiques, des machines virtuelles, et des installations autonomes.

Prérequis

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

Une clé de licence New Relic.
Accès administrateur à votre instance MySQL.
Connectivité réseau entre l’hôte où vous installez le Collector NRDOT et votre base de données MySQL.
Connectivité réseau vers la documentation sur les points de terminaison OTLP de New Relic
Cette intégration est disponible dans le cadre du programme de préversion publique de New Relic. Vérifiez auprès de votre responsable d’organisation pour vous inscrire depuis la page Préversions et essais.
Pour connaître les versions de MySQL prises en charge, les autorisations requises et les exigences de performance_schema, consultez la section Compatibilité et prérequis.

Configurer le Collector NRDOT

Installez le Collector NRDOT sur votre système :

Pour les systèmes Debian/Ubuntu, exécutez :
bash
```
$NRDOT_VERSION=$(curl -s https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest | grep '"tag_name":' | awk -F'"' '{print $4}') && curl -L "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/nrdot-collector_${NRDOT_VERSION}_linux_amd64.deb" --output nrdot-collector.deb && sudo dpkg -i nrdot-collector.deb
```

Pour les systèmes RHEL/CentOS/OEL, exécutez :

bash

$NRDOT_VERSION=$(curl -s https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest | grep '"tag_name":' | awk -F'"' '{print $4}') && curl -L "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/nrdot-collector_${NRDOT_VERSION}_linux_x86_64.rpm" --output nrdot-collector.rpm && sudo rpm -ivh nrdot-collector.rpm

Pour les systèmes Debian/Ubuntu, exécutez :

bash

$NRDOT_VERSION=$(curl -s https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest | grep '"tag_name":' | awk -F'"' '{print $4}') && curl -L "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/nrdot-collector_${NRDOT_VERSION}_linux_arm64.deb" --output nrdot-collector.deb && sudo dpkg -i nrdot-collector.deb

Pour les systèmes RHEL/CentOS/OEL, exécutez :

bash

$NRDOT_VERSION=$(curl -s https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest | grep '"tag_name":' | awk -F'"' '{print $4}') && curl -L "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/nrdot-collector_${NRDOT_VERSION}_linux_arm64.rpm" --output nrdot-collector.rpm && sudo rpm -ivh nrdot-collector.rpm

Configurer l'utilisateur de la base de données

Créez un utilisateur de monitoring avec les privilèges nécessaires pour votre instance de base de données MySQL.

Pour créer un utilisateur de monitoring, exécutez la commande suivante dans votre base de données MySQL :
```
CREATE USER '<YOUR_DB_USERNAME>'@'%' IDENTIFIED BY '<YOUR_DB_PASSWORD>';
```
Pour collecter des échantillons de requêtes et les requêtes principales, accordez les privilèges suivants à l’utilisateur de monitoring :
```
GRANT SELECT ON performance_schema.* TO '<YOUR_DB_USERNAME>'@'%';
```
(Facultatif) Pour afficher les données de temps d'attente dans la plateforme New Relic, accordez les privilèges suivants à l'utilisateur de monitoring :
```
GRANT UPDATE ON performance_schema.setup_consumers TO '<YOUR_DB_USERNAME>'@'%';
```
(Facultatif) Pour vérifier la connexion et les autorisations, exécutez :
bash
```
$mysql -h <YOUR_DB_HOST> -P <YOUR_DB_PORT> -u <YOUR_DB_USERNAME> -p -e "SELECT 1;"
```
Si la commande se termine sans erreur, l'utilisateur de monitoring, l'hôte et le port sont tous corrects.

Configurer le collecteur NRDOT

Configurez le Collector NRDOT avec vos paramètres spécifiques à MySQL. Sélectionnez votre type de configuration en fonction de vos besoins de monitoring :

Cette configuration se concentre sur le monitoring essentiel de MySQL avec le Récepteur nrmysql uniquement.

Créez un fichier de configuration nommé mysql-config.yaml:
bash
```
$sudo nano /etc/nrdot-collector/mysql-config.yaml
```

Ajoutez la configuration suivante au fichier mysql-config.yaml que vous avez créé à l’étape précédente.

receivers:
  nrmysql:
    endpoint: "<YOUR_DB_HOST>:<YOUR_DB_PORT>"
    transport: tcp
    username: "<YOUR_DB_USERNAME>"
    password: "<YOUR_DB_PASSWORD>"
    database: "<YOUR_DATABASE_NAME>"
    allow_native_passwords: true
    collection_interval: 10s
    initial_delay: 1s
    tls:
      insecure: false
      insecure_skip_verify: false
      # ca_file: /path/to/global-bundle.pem
    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: 120
      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

processors:
  batch:
  resource/mysql:
    attributes:
      - key: server.address
        value: "<YOUR_DB_HOST>"
        action: upsert
      - key: server.port
        value: <YOUR_DB_PORT>
        action: upsert

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: [resource/mysql, batch]
      exporters: [otlp/newrelic]
    logs:
      receivers: [nrmysql]
      processors: [resource/mysql, batch]
      exporters: [otlp/newrelic]

Cette configuration ajoute des métriques au niveau de l'hôte (CPU, mémoire, disque, réseau) en plus du monitoring de la base de données MySQL.

Créez un fichier de configuration nommé mysql-config.yaml:
bash
```
$sudo nano /etc/nrdot-collector/mysql-config.yaml
```

Ajoutez la configuration suivante au fichier mysql-config.yaml que vous avez créé à l’étape précédente.

extensions:
  health_check:

receivers:
  otlp:
    protocols:
      grpc:
      http:

  host_metrics:
    collection_interval: 30s
    scrapers:
      cpu:
        metrics:
          system.cpu.time:
            enabled: false
          system.cpu.utilization:
            enabled: true
      load:
      memory:
        metrics:
          system.memory.utilization:
            enabled: true
      paging:
        metrics:
          system.paging.utilization:
            enabled: false
          system.paging.faults:
            enabled: false
      filesystem:
        metrics:
          system.filesystem.utilization:
            enabled: true
      disk:
        metrics:
          system.disk.merged:
            enabled: false
          system.disk.pending_operations:
            enabled: false
          system.disk.weighted_io_time:
            enabled: false
      network:
        metrics:
          system.network.connections:
            enabled: false
      # Uncomment to enable process metrics, which can be noisy but valuable.
      # processes:
      # process:
      #  metrics:
      #    process.cpu.utilization:
      #      enabled: true
      #    process.cpu.time:
      #      enabled: false

  nrmysql:
    endpoint: "<YOUR_DB_HOST>:<YOUR_DB_PORT>"
    transport: tcp
    username: "<YOUR_DB_USERNAME>"
    password: "<YOUR_DB_PASSWORD>"
    database: "<YOUR_DATABASE_NAME>"
    allow_native_passwords: true
    collection_interval: 10s
    initial_delay: 1s
    tls:
      insecure: false
      insecure_skip_verify: false
      # Required for Amazon RDS/Aurora with SSL/TLS enforcement -- see
      # Prerequisites -> Network access -> Amazon RDS / Aurora for MySQL.
      # ca_file: /path/to/global-bundle.pem
    # "procedure" collects EXPLAIN plans for write statements (UPDATE/DELETE/INSERT/REPLACE)
    # without granting DML to the monitoring user, via a SQL SECURITY DEFINER procedure.
    # Falls back to "inline" (default) automatically if the procedure is absent for a schema.
    # Requires one-time setup per schema -- see Prerequisites -> DML query plan collection.
    explain_mode: procedure
    statement_events:
      digest_text_limit: 4096
      time_limit: 24h
      limit: 500
    query_sample_collection:
      max_rows_per_query: 100
      # APM-DB correlation: surfaces the nr_service_guid SQL comment tag (e.g. injected by
      # transaction_tracer.sql_metadata_comments in the Java agent) as db.query.comment_tags /
      # db.query.comment_tags.nr_service_guid. Empty list by default -- nothing is extracted
      # unless the key is explicitly allow-listed here.
      allowed_comment_keys: [nr_service_guid]
    top_query_collection:
      lookback_time: 120
      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

processors:
  metrics_transform:
    transforms:
      - include: system.cpu.utilization
        action: update
        operations:
          - action: aggregate_labels
            label_set: [state]
            aggregation_type: mean
      - include: system.paging.operations
        action: update
        operations:
          - action: aggregate_labels
            label_set: [direction]
            aggregation_type: sum

  filter/exclude_cpu_utilization:
    metrics:
      datapoint:
        - 'metric.name == "system.cpu.utilization" and attributes["state"] == "interrupt"'
        - 'metric.name == "system.cpu.utilization" and attributes["state"] == "nice"'
        - 'metric.name == "system.cpu.utilization" and attributes["state"] == "softirq"'

  filter/exclude_memory_utilization:
    metrics:
      datapoint:
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_unreclaimable"'
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "inactive"'
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "cached"'
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "buffered"'
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_reclaimable"'

  filter/exclude_memory_usage:
    metrics:
      datapoint:
        - 'metric.name == "system.memory.usage" and attributes["state"] == "slab_unreclaimable"'
        - 'metric.name == "system.memory.usage" and attributes["state"] == "inactive"'

  filter/exclude_filesystem_utilization:
    metrics:
      datapoint:
        - 'metric.name == "system.filesystem.utilization" and attributes["type"] == "squashfs"'

  filter/exclude_filesystem_usage:
    metrics:
      datapoint:
        - 'metric.name == "system.filesystem.usage" and attributes["type"] == "squashfs"'
        - 'metric.name == "system.filesystem.usage" and attributes["state"] == "reserved"'

  filter/exclude_filesystem_inodes_usage:
    metrics:
      datapoint:
        - 'metric.name == "system.filesystem.inodes.usage" and attributes["type"] == "squashfs"'
        - 'metric.name == "system.filesystem.inodes.usage" and attributes["state"] == "reserved"'

  filter/exclude_system_disk:
    metrics:
      datapoint:
        - 'metric.name == "system.disk.operations" and IsMatch(attributes["device"], "^loop.*") == true'
        - 'metric.name == "system.disk.merged" and IsMatch(attributes["device"], "^loop.*") == true'
        - 'metric.name == "system.disk.io" and IsMatch(attributes["device"], "^loop.*") == true'
        - 'metric.name == "system.disk.io_time" and IsMatch(attributes["device"], "^loop.*") == true'
        - 'metric.name == "system.disk.operation_time" and IsMatch(attributes["device"], "^loop.*") == true'

  filter/exclude_network:
    metrics:
      datapoint:
        - 'IsMatch(metric.name, "^system.network.*") == true and attributes["device"] == "lo"'

  attributes/exclude_system_paging:
    include:
      match_type: strict
      metric_names:
        - system.paging.operations
    actions:
      - key: type
        action: delete

  cumulative_to_delta:

  transform:
    trace_statements:
      - context: span
        statements:
          - truncate_all(span.attributes, 4095)
          - truncate_all(resource.attributes, 4095)

  transform/host:
    metric_statements:
      - context: metric
        statements:
          - set(metric.description, "")
          - set(metric.unit, "")

  # Static server.address/server.port, reusing the same <YOUR_DB_HOST>/<YOUR_DB_PORT>
  # values already set on the receiver's own `endpoint` field above -- nrmysqlreceiver
  # itself emits no server.address/server.port, only its own mysql.instance.endpoint
  # (a combined "host:port" string). Applies uniformly to both metrics and logs
  # pipelines since neither depends on how that string is derived.
  resource/mysql:
    attributes:
      - key: server.address
        value: "<YOUR_DB_HOST>"
        action: upsert
      - key: server.port
        value: <YOUR_DB_PORT>
        action: upsert

  batch:

  resource_detection:
    detectors: ["system"]
    system:
      hostname_sources: ["os"]
      resource_attributes:
        host.id:
          enabled: true

  resource_detection/cloud:
    detectors: ["gcp", "ec2", "azure"]
    timeout: 2s
    override: true

  resource_detection/env:
    detectors: ["env"]
    timeout: 2s
    override: true

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:
  telemetry:
    metrics:
      level: none

  extensions: [health_check]

  pipelines:
    metrics/host:
      receivers: [host_metrics]
      processors:
        - metrics_transform
        - filter/exclude_cpu_utilization
        - filter/exclude_memory_utilization
        - filter/exclude_memory_usage
        - filter/exclude_filesystem_utilization
        - filter/exclude_filesystem_usage
        - filter/exclude_filesystem_inodes_usage
        - filter/exclude_system_disk
        - filter/exclude_network
        - attributes/exclude_system_paging
        - transform/host
        - resource_detection
        - resource_detection/cloud
        - resource_detection/env
        - cumulative_to_delta
        - batch
      exporters: [otlp/newrelic]

    metrics/mysql:
      receivers: [nrmysql]
      processors:
        - resource/mysql
        - resource_detection
        - resource_detection/cloud
        - resource_detection/env
        - batch
      exporters: [otlp/newrelic]

    logs/mysql:
      receivers: [nrmysql]
      processors:
        - resource/mysql
        - resource_detection
        - resource_detection/cloud
        - resource_detection/env
        - batch
      exporters: [otlp/newrelic]

    traces:
      receivers: [otlp]
      processors: [transform, resource_detection, resource_detection/cloud, resource_detection/env, batch]
      exporters: [otlp/newrelic]

    metrics:
      receivers: [otlp]
      processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
      exporters: [otlp/newrelic]

    logs:
      receivers: [otlp]
      processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
      exporters: [otlp/newrelic]

Important

L'intégration MySQL via le Collector NRDOT suit la tarification standard d'ingestion de données. Notez que la configuration complète des fonctionnalités ingère plus de données qu'une installation standard, ce qui peut augmenter votre facture globale.

Paramètres de configuration

Le tableau suivant décrit les principaux paramètres de configuration du récepteur nrmysql :

paramètres	Description
`<YOUR_DB_HOST>`	Saisissez le nom d'hôte ou l'adresse IP de MySQL.
`<YOUR_DB_PORT>`	Saisissez votre numéro de port MySQL. La valeur par défaut est `3306`.
`<YOUR_DB_USERNAME>`	Saisissez le nom d’utilisateur de l’utilisateur de monitoring que vous avez créé dans Configurer l’utilisateur de la base de données.
`<YOUR_DB_PASSWORD>`	Saisissez le mot de passe de l'utilisateur de monitoring que vous avez créé dans Configurer l'utilisateur de base de données.
`<YOUR_DATABASE_NAME>`	Facultatif. Saisissez un nom de base de données spécifique pour y restreindre le monitoring. Omettez ce paramètre pour monitorer chaque base de données à laquelle l’utilisateur de monitoring peut accéder.
`<YOUR_NEWRELIC_OTLP_ENDPOINT>`	Saisissez le point de terminaison OTLP New Relic. Pour plus d'informations, consultez les points de terminaison OTLP New Relic.
`<YOUR_NEWRELIC_LICENSE_KEY>`	Saisissez votre clé de licence New Relic.
`transport`	La valeur par défaut est définie sur `tcp` pour se connecter via le réseau. Si votre Collector NRDOT s'exécute sur le même hôte que MySQL, utilisez plutôt `unix` pour vous connecter via un socket de domaine Unix.
`collection_interval`	Saisissez l'intervalle entre les collectes de métriques. Valeur par défaut : `10s`.
`explain_mode`	La valeur par défaut est définie sur `inline`. Définissez la valeur sur `procedure` pour collecter les plans de requête pour les instructions d'écriture sans accorder de privilèges DML à l'utilisateur de monitoring. Consultez la section Plans de requête pour les instructions d'écriture.

Valider la configuration du Collector NRDOT

Mettez à jour le chemin de configuration pour pointer vers votre nouveau fichier mysql-config.yaml :
bash
```
$OTELCOL_OPTIONS="/etc/nrdot-collector/mysql-config.yaml"
```
Validez la configuration du Collector NRDOT pour vous assurer qu'elle est correctement formatée et qu'elle fonctionnera correctement :
bash
```
$sudo /usr/bin/nrdot-collector validate --config=/etc/nrdot-collector/mysql-config.yaml
```

Conseil

Vous pouvez également :

Configurer plusieurs récepteurs: pour monitorer plusieurs instances MySQL à partir d'un seul collecteur.
Liez votre base de données MySQL à l'APM: pour corréler les performances des applications avec les opérations de la base de données. Cela vous permet de voir exactement quelles applications génèrent des workloads de base de données spécifiques.
Configurer le Récepteur de requêtes SQL: pour collecter des métriques personnalisées à partir de votre base de données MySQL.
Configurez la gestion des secrets: pour gérer en toute sécurité des informations sensibles, telles que les identifiants de base de données. Cela permet de renforcer la sécurité de votre configuration de monitoring en évitant de coder en dur des données sensibles dans les fichiers de configuration.

Redémarrer NRDOT Collector

Après avoir mis à jour votre configuration, redémarrez le service NRDOT Collector :

bash

$sudo systemctl restart nrdot-collector

Conseil

Redémarrez toujours le service de collecte NRDOT après avoir modifié la configuration pour vous assurer que les nouveaux paramètres soient pris en compte.

Pour vérifier que le collecteur fonctionne correctement, vérifiez l'état du service :

bash

$sudo systemctl status 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’interface utilisateur de New Relic.

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

Allez à https://one.newrelic.com > All Capabilities > Databases.
Dans la liste déroulante Entity type, sélectionnez MySQL instance, puis cliquez sur Apply.
Sélectionnez votre base de données MySQL dans la liste des entités.
Après avoir configuré le monitoring de base de données MySQL avec NRDOT :
- Créez des dashboards personnalisés pour visualiser les métriques de votre base de données
- Configurer des alertes pour les seuils critiques de performances des bases de données

Guide de dépannage

Apprenez à résoudre les problèmes courants liés au monitoring MySQL.

Référence des métriques

Découvrez les métriques disponibles collectées par le collecteur NRDOT.

Instrumentation dans les environnements RDS

Découvrez comment configurer le monitoring MySQL dans les environnements RDS avec New Relic.

Cette traduction automatique est fournie pour votre commodité.

Installer & configurer NRDOT pour MySQL auto-hébergé

Aperçu

Prérequis

Configurer le Collector NRDOT

Pour l'architecture AMD64

Pour l'architecture ARM64

Configurer l'utilisateur de la base de données

Configurer le collecteur NRDOT

Configuration standard

Configuration avec toutes les fonctionnalités

Important

Paramètres de configuration

Valider la configuration du Collector NRDOT

Conseil

Redémarrer NRDOT Collector

Conseil

Trouvez et utilisez vos données

Guide de dépannage

Référence des métriques

Instrumentation dans les environnements RDS

Cette traduction automatique est fournie pour votre commodité.

Installer & configurer NRDOT pour MySQL auto-hébergé

Aperçu

Prérequis .css-21sua1{background:none;border:none;width:0;padding:0;}

Configurer le Collector NRDOT

Pour l'architecture ARM64

Configurer l'utilisateur de la base de données

Configurer le collecteur NRDOT

Configuration standard

Configuration avec toutes les fonctionnalités

Important

Paramètres de configuration

Valider la configuration du Collector NRDOT

Conseil

Redémarrer NRDOT Collector

Conseil

Trouvez et utilisez vos données

Documentation associée

Guide de dépannage

Référence des métriques

Instrumentation dans les environnements RDS

Prérequis