Monitoring de Linux RDS MSSQL avec NRDOT

Prérequis

• Compte New Relic avec une clé de licencevalide

• Point de terminaison OTLP New Relic pour votre région

• Exigences d'AWS RDS SQL Server :

  • AWS RDS SQL Server 2017 ou version ultérieure
  • Nom d'utilisateur et mot de passe maître RDS
  • Groupe de sécurité autorisant les connexions entrantes sur le port 1433 ou un port personnalisé

• Exigences système Linux :

  • sqlcmd utilitaire installé sur votre système Linux
  • Connectivité réseau vers le point de terminaison OTLP de New Relic

Inscrivez-vous à la préversion

Cette intégration est disponible dans le cadre du programme d'aperçu public de New Relic. Contactez le responsable de votre organisation pour vous inscrire à partir de la page Previews & Trials.

Installer le collecteur NRDOT

Téléchargez et installez le package NRDOT pour votre distribution Linux. Remplacez <NRDOT_VERSION> par le dernier tag de sortie de la page nrdot-collector-releases.

Créer un utilisateur de monitoring

Exécutez ce script en tant qu’utilisateur root pour créer l’utilisateur de monitoring newrelic et accorder les autorisations nécessaires pour collecter les métriques RDS SQL Server.

1. Créez un fichier nommé nr-grant-permission-rds.sql.

2. Collez le script SQL suivant pour créer l’utilisateur de monitoring newrelic et remplacez <YOUR_PASSWORD> par le mot de passe souhaité :

   USE [master];
   GO
   CREATE LOGIN [newrelic] WITH PASSWORD = '<YOUR_PASSWORD>';
   GO
   -- Instance-level permissions
   GRANT VIEW SERVER STATE TO [newrelic];
   GRANT VIEW ANY DEFINITION TO [newrelic];
   GRANT VIEW ANY DATABASE TO [newrelic];
   GO
   -- Grant read access privileges to all user databases
   DECLARE @name SYSNAME;
   DECLARE db_cursor CURSOR READ_ONLY FORWARD_ONLY FOR
   SELECT [name]
   FROM [master].[sys].[databases]
   WHERE [name] NOT IN ('master', 'msdb', 'model', 'rdsadmin', 'distribution')
   AND [state] = 0; -- Only online databases
   OPEN db_cursor;
   FETCH NEXT FROM db_cursor INTO @name;
   WHILE @@FETCH_STATUS = 0
   BEGIN
     BEGIN TRY
       EXEC('USE [' + @name + '];
         IF NOT EXISTS (SELECT 1 FROM sys.database_principals WHERE name = ''newrelic'')
         BEGIN
           CREATE USER [newrelic] FOR LOGIN [newrelic];
         END;
         GRANT VIEW DATABASE STATE TO [newrelic];');
     END TRY
     BEGIN CATCH
       PRINT 'Error on ' + @name + ': ' + ERROR_MESSAGE();
     END CATCH
     FETCH NEXT FROM db_cursor INTO @name;
   END
   CLOSE db_cursor;
   DEALLOCATE db_cursor;
   GO

   Copier

3. Exécutez le script à l'aide de sqlcmd. Remplacez <YOUR-RDS-ENDPOINT> par votre point de terminaison RDS et <YOUR_MASTER_PASSWORD> par votre mot de passe maître :

   bash

   Copier

   $
   sqlcmd -S <YOUR-RDS-ENDPOINT> -U <YOUR_MASTER_USER> -P '<YOUR_MASTER_PASSWORD>' -C -i nr-grant-permission-rds.sql

4. (Facultatif) Vérifiez que l'utilisateur a été créé avec succès avec les autorisations appropriées :

   bash

   Copier

   $
   sqlcmd -S <YOUR-RDS-ENDPOINT> -U <YOUR_MASTER_USER> -P '<YOUR_MASTER_PASSWORD>' -C -Q "SELECT sp.name AS [User], p.permission_name AS [Permission_Granted] FROM sys.server_permissions p JOIN sys.server_principals sp ON p.grantee_principal_id = sp.principal_id WHERE sp.name = 'newrelic';"

   Conseil

   Utilisez votre nom d’utilisateur et votre mot de passe principal RDS pour exécuter ces commandes. Le script exclut automatiquement la base de données rdsadmin qui est réservée par AWS. Pour gérer en toute sécurité les informations sensibles, telles que les identifiants de base de données, stockez-les dans des outils de gestion des secrets.

Configurer le collecteur NRDOT

Choisissez votre option de configuration en fonction de vos exigences de monitoring :

1. Créez un fichier de configuration nommé mssql-config.yaml:

   bash

   Copier

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

2. Ajoutez la configuration suivante au fichier mssql-config.yaml créé à l’étape précédente :

   configuration complète

   Cette configuration se concentre sur le monitoring essentiel de la base de données pour votre environnement RDS. Pour activer un monitoring complet avec toutes les métriques disponibles, consultez la référence de configuration.

   Nom d'utilisateur de base de données

   Saisissez votre nom d'utilisateur de base de données pour l'authentification (généralement newrelic)

   Mot de passe de la base de données

   Saisissez le mot de passe que vous avez défini pour l'utilisateur newrelic

   Point de terminaison RDS

   Saisissez votre point de terminaison RDS SQL Server

   Port SQL Server

   Saisissez votre numéro de port SQL Server. La valeur par défaut est 1433.

   Point de terminaison OTLP New Relic

   Saisissez votre point de terminaison OTLP New Relic. Pour plus d’informations, consultez https://docs.newrelic.com/docs/opentelemetry/best-practices/opentelemetry-otlp/

   Clé de licence New Relic

   Entrez votre clé de licence New Relic

   mssql-config.yaml

   DownloadCopier

   1
   receivers:
   2
   nrsqlserver:
   3
      collection_interval: 15s
   4
      # Connection details - Use your RDS endpoint
   5
      username: newrelic
   6
      password: YOUR_PASSWORD
   7
      server: mydb-instance.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com
   8
      port: 1433
   9
   
   10
      # Enable comprehensive database metrics
   11
      metrics:
   12
        sqlserver.database.count:
   13
          enabled: true
   14
        sqlserver.database.io:
   15
          enabled: true
   16
        sqlserver.database.latency:
   17
          enabled: true
   18
        sqlserver.database.operations:
   19
          enabled: true
   20
        sqlserver.database.tempdb.space:
   21
          enabled: true
   22
        sqlserver.database.tempdb.version_store.size:
   23
          enabled: true
   24
        sqlserver.deadlock.rate:
   25
          enabled: true
   26
        sqlserver.os.wait.duration:
   27
          enabled: true
   28
        sqlserver.processes.blocked:
   29
          enabled: true
   30
        sqlserver.memory.grants.pending.count:
   31
          enabled: true
   32
        sqlserver.database.file.size:
   33
          enabled: true
   34
        sqlserver.memory.area:
   35
          enabled: true
   36
   
   37
      # Enable top query and query sample log collection
   38
      events:
   39
        db.server.query_sample:
   40
          enabled: true
   41
        db.server.top_query:
   42
          enabled: true
   43
   
   44
      # Top query collection configuration
   45
      top_query_collection:
   46
        lookback_time: 60s
   47
        max_query_sample_count: 1000
   48
        top_query_count: 250
   49
        collection_interval: 60s
   50
   
   51
      collect_full_query_text: true
   52
      allowed_comment_keys:
   53
        - nr_service_guid
   54
   
   55
      # Query sample collection configuration
   56
      query_sample_collection:
   57
        max_rows_per_query: 100
   58
   
   59
   processors:
   60
   memory_limiter:
   61
      check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
   62
      limit_mib:       ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
   63
      spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}
   64
   
   65
   batch:
   66
   
   67
   exporters:
   68
   otlp:
   69
      endpoint: https://otlp.nr-data.net:4318
   70
      headers:
   71
        api-key: YOUR_LICENSE_KEY
   72
      tls:
   73
        insecure: false
   74
      compression: gzip
   75
   
   76
   service:
   77
   telemetry:
   78
      metrics:
   79
        level: none
   80
   
   81
   pipelines:
   82
      metrics:
   83
        receivers: [nrsqlserver]
   84
        processors: [memory_limiter, batch]
   85
        exporters: [otlp]
   86
   
   87
      logs:
   88
        receivers: [nrsqlserver]
   89
        processors: [memory_limiter, batch]
   90
        exporters: [otlp]

Mettre à jour la configuration du Collector NRDOT

Après avoir configuré votre fichier YAML avec les entrées interactives ci-dessus, terminez la configuration du Collector NRDOT :

1. Modifiez le fichier de configuration du service à l’aide de la commande suivante :

   bash

   Copier

   $
   sudo nano /etc/nrdot-collector/nrdot-collector.conf

2. Mettez à jour le chemin de configuration pour pointer vers votre nouveau fichier mssql-config.yaml :

   bash

   Copier

   $
   OTELCOL_CONFIG="/etc/nrdot-collector/mssql-config.yaml"

3. (Facultatif) Validez la configuration du Collector NRDOT :

   bash

   Copier

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

   Conseil

   Pour corréler les performances de votre application avec les opérations de base de données, vous pouvez configurer l'identification du service de bases de données. Pour plus d’informations, reportez-vous au guide de configuration de l’identification du service de bases de données.

Redémarrer NRDOT Collector

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

$
sudo systemctl 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 SQL Server via l’UI de New Relic.

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

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

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

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

   Après avoir configuré le monitoring SQL Server avec NRDOT, vous pouvez :

   • 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
   • Explorez vos données à l’aide des fonctionnalités de requête de New Relic