Installez & configurez NRDOT pour le monitoring MSSQL avec Ansible

Vous pouvez installer, et configurer le Collector NRDOT pour le monitoring de SQL Server en utilisant le rôle Ansible newrelic.newrelic_install. Le rôle installe le collecteur, crée, ou autorise l'identité de monitoring, et configure le collecteur en une seule exécution.

Installation guidée

Pour installer ceci via l’UI de New Relic à la place, accédez à one.newrelic.com > Integrations & Agents > Microsoft SQL Server (Database 360) . Suivez les instructions à l’écran pour configurer l’intégration. Cette page couvre uniquement l’installation manuelle.

Prérequis

Un compte New Relic avec une clé de licence valide.
Un ID de compte New Relic.
Microsoft SQL Server 2017 ou version ultérieure.
Ansible Core 2.13 ou 2.14, Python 3.10, et les collections ansible.windows et ansible.utils.
SQL Server auto-hébergé :
- Authentification SQL Server : un hôte de collecteur Linux ou Windows, et un identifiant dans le rôle de serveur sysadmin (ou équivalent) avec son mot de passe.
- Authentification Windows ou gMSA : un hôte collecteur Windows, une session PowerShell administrateur, et un compte Windows ou un compte de service géré de groupe (gMSA) avec les autorisations requises.
SQL Server sur AWS RDS :
- Un hôte collecteur Linux ou Windows avec une connectivité réseau au point de terminaison de la base de données (accès entrant accordé sur le port SQL Server au sein du groupe de sécurité), ainsi que le nom d’utilisateur et le mot de passe maîtres de la base de données.
- Authentification de domaine Windows ou gMSA : un hôte de collecteur Windows et une instance jointe à un domaine AWS Managed Microsoft Active Directory.
Hôte collecteur Linux : l’utilitaire curl, systemd et l’utilitaire sqlcmd installés et disponibles sur PATH (ou situés sous /opt/mssql-tools18/bin ou /opt/mssql-tools/bin).
Hôte collecteur Windows : l’utilitaire sqlcmd.exe installé et disponible sur PATH.
Connectivité réseau vers le point de terminaison OTLP de New Relic correspondant à la région cible.

Installez le rôle

bash

$ansible-galaxy install newrelic.newrelic_install

Assurez-vous que les collections requises sont également installées :

bash

$ansible-galaxy collection install ansible.windows ansible.utils

Configurez le playbook

Ce rôle monitore une ou plusieurs instances SQL Server depuis un seul collecteur. Au lieu d’un seul ensemble hôte/port/identifiants, il lit deux fichiers qui doivent déjà exister sur l’hôte cible : un fichier d’instances (YAML) listant chaque instance à monitorer, et un fichier de secrets (KEY=VALUE) avec un identifiant et un mot de passe administrateur pour chacune, indexés pour correspondre.

Créez le fichier d'instance sur l'hôte cible. Ajoutez une entrée par instance SQL Server que vous souhaitez que ce collecteur monitore, ou juste une entrée si vous n’exécutez qu’une seule instance :
```
instances:
  - host: localhost
    port: 1433
    login_name: newrelic
```

Créez le fichier de secrets sur l’hôte cible avec un identifiant et un mot de passe administrateur pour chaque instance, indexé pour correspondre à l’ordre du fichier des instances. L’identifiant administrateur doit être membre du rôle sysadmin (ou équivalent) :

bash

$NR_CLI_MSSQL_ADMIN_USER_1=<YOUR_ADMIN_USERNAME>
$NR_CLI_MSSQL_ADMIN_PASSWORD_1=<YOUR_ADMIN_PASSWORD>

Ensuite, créez un fichier nommé playbook.yml et copiez-y le contenu suivant. Définissez targets sur mssql-otel et remplacez les valeurs des espaces réservés par les vôtres :

- name: Install New Relic NRDOT for SQL Server
  hosts: all
  roles:
    - role: newrelic.newrelic_install
  vars:
    targets:
      - mssql-otel
  environment:
    NEW_RELIC_API_KEY: <API key>
    NEW_RELIC_ACCOUNT_ID: <Account ID>
    NEW_RELIC_REGION: <Region>
    NR_CLI_MSSQL_CONFIG_PRESET: <1 Basic, 2 Advanced, default 1>
    NR_CLI_MSSQL_INSTANCES_FILE: <path to the instances YAML file on the target host>
    NR_CLI_MSSQL_SECRETS_FILE: <path to the secrets file (KEY=VALUE per instance) on the target host>

Conseil

Pour activer le logging de débogage, ajoutez verbosity: "debug" sous vars dans le playbook.

Variable

Description

Défaut

NR_CLI_MSSQL_CONFIG_PRESET

Configuration NRDOT :

1 pour Basic
2 pour Advanced

1

NR_CLI_MSSQL_INSTANCES_FILE

Requis. Chemin d'accès au fichier YAML de l'instance, déjà présent sur l'hôte cible.

Aucun

NR_CLI_MSSQL_SECRETS_FILE

Requis. Chemin vers le fichier des secrets (KEY=VALUE, une paire identifiant / mot de passe administrateur par instance), déjà présent sur l’hôte cible.

Aucun

Conseil

Pour monitorer plus d'une instance SQL Server à partir de ce collecteur, ajoutez des entrées supplémentaires au fichier d'instances, et des identifiants numérotés correspondants (_2, _3,…) au fichier de secrets. Une instance qui échoue à ses vérifications est ignorée avec une raison dans le log plutôt que d’annuler toute l’installation.

Cette cible est uniquement prise en charge sur un hôte collecteur Windows. Elle utilise l’authentification Windows (integrated security=true) au lieu des identifiants SQL, et monitore une ou plusieurs instances SQL Server à partir d’un seul collecteur à l’aide d’un fichier d’instances (YAML, host/port par instance, aucun fichier de secrets : une identité Windows monitore chaque instance).

Créez le fichier d’instance sur l’hôte cible, avec une seule entrée si vous n’exécutez qu’une seule instance. Seuls host et port sont nécessaires (pas de login_name) :

instances:
  - host: sql01.contoso.com
    port: 1433
  - host: sql02.contoso.com
    port: 1433

Pour une instance nommée, utilisez host plus son port TCP statique plutôt que host\INSTANCE.

Ensuite, créez un fichier nommé playbook.yml et copiez-y le contenu suivant. Définissez targets sur mssql-otel-winauth et remplacez les valeurs des espaces réservés par les vôtres :

- name: Install New Relic NRDOT for SQL Server (Windows Auth)
  hosts: all
  roles:
    - role: newrelic.newrelic_install
  vars:
    targets:
      - mssql-otel-winauth
  environment:
    NEW_RELIC_API_KEY: <API key>
    NEW_RELIC_ACCOUNT_ID: <Account ID>
    NEW_RELIC_REGION: <Region>
    NR_CLI_MSSQL_CONFIG_PRESET: <1 Basic, 2 Advanced, default 1>
    NR_CLI_MSSQL_AUTH_MODE: <1 for Windows Domain Auth, 2 for gMSA, default 1>
    NR_CLI_MSSQL_WINAUTH_LOCATION: <1 for same host as SQL Server, 2 for a different host, default 1; Windows Domain Auth only>
    NR_CLI_MSSQL_INSTANCES_FILE: <path to the instances YAML file on the target host>
    NR_CLI_MSSQL_WIN_ACCOUNT: <Windows domain account, DOMAIN\username; required only for Windows Domain Auth on a different host>
    NR_CLI_MSSQL_WIN_PASSWORD: <password for that account; required only for Windows Domain Auth on a different host>
    NR_CLI_MSSQL_GMSA_ACCOUNT: <gMSA account, DOMAIN\gMSAName$; gMSA only>

Conseil

Pour activer le logging de débogage, ajoutez verbosity: "debug" sous vars dans le playbook.

Variable	Description	Défaut
`NR_CLI_MSSQL_CONFIG_PRESET`	Configuration NRDOT : `1` pour Basic `2` pour Advanced	`1`
`NR_CLI_MSSQL_AUTH_MODE`	Authentification SQL Server : `1` pour l’authentification de domaine Windows `2` pour gMSA	`1`
`NR_CLI_MSSQL_WINAUTH_LOCATION`	Authentification de domaine Windows uniquement : `1` si le collecteur s’exécute sur le même hôte que SQL Server (l’identité de l’utilisateur effectuant l’installation est utilisée et le service reste `LocalSystem`, aucun compte de domaine n’est donc nécessaire) `2` s’il s’exécute sur un hôte différent	`1`
`NR_CLI_MSSQL_INSTANCES_FILE`	Requis. Chemin d'accès au fichier YAML d'instance (`host`/`port` par instance), déjà présent sur l'hôte cible.	Aucun
`NR_CLI_MSSQL_WIN_ACCOUNT` / `NR_CLI_MSSQL_WIN_PASSWORD`	Requis uniquement lorsque `NR_CLI_MSSQL_AUTH_MODE` est `1` et `NR_CLI_MSSQL_WINAUTH_LOCATION` est `2`. Compte de domaine Windows (`DOMAIN\username`) et mot de passe auxquels accorder des autorisations et sous lesquels exécuter le service collecteur. Non requis pour le flux sur le même hôte ou pour gMSA.	Aucun
`NR_CLI_MSSQL_GMSA_ACCOUNT`	Requis si `NR_CLI_MSSQL_AUTH_MODE` est `2`. Compte gMSA (`DOMAIN\gMSAName$`) auquel accorder des autorisations.	Aucun

Conseil

Pour monitorer plus d’une instance SQL Server à partir de ce collecteur, ajoutez des entrées supplémentaires au fichier d’instances. Un mode d’authentification et une identité Windows sont utilisés pour chaque instance dans le fichier. Une instance qui échoue à ses vérifications est ignorée avec une raison dans le log plutôt que d’annuler toute l’installation. Le flux sur le même hôte (NR_CLI_MSSQL_WINAUTH_LOCATION 1) ne fonctionne que pour les instances sur l’hôte cible lui-même. Utilisez le flux sur un hôte différent ou gMSA pour les instances distantes ou en cluster.

Ce rôle monitore un ou plusieurs points de terminaison RDS SQL Server à partir d’un seul collecteur, en utilisant le même modèle de fichier d’instances / fichier de secrets que l’auto-hébergé (les deux fichiers doivent déjà exister sur l’hôte cible).

Créez le fichier d’instance sur l’hôte cible, en utilisant le point de terminaison RDS comme host, avec une seule entrée si vous ne monitorez qu’une seule instance RDS :
```
instances:
  - host: mydb1.abcdefg12345.us-east-1.rds.amazonaws.com
    port: 1433
    login_name: newrelic
```

Créez le fichier de secrets sur l’hôte cible avec le nom d’utilisateur et le mot de passe maître RDS pour chaque instance, indexé pour correspondre à l’ordre du fichier d’instance :

bash

$NR_CLI_MSSQL_ADMIN_USER_1=admin
$NR_CLI_MSSQL_ADMIN_PASSWORD_1=YourMasterPassword1

Ensuite, créez un fichier nommé playbook.yml et copiez-y le contenu suivant. Définissez targets sur mssql-otel-rds et remplacez les valeurs des espaces réservés par les vôtres :

- name: Install New Relic NRDOT for SQL Server on RDS
  hosts: all
  roles:
    - role: newrelic.newrelic_install
  vars:
    targets:
      - mssql-otel-rds
  environment:
    NEW_RELIC_API_KEY: <API key>
    NEW_RELIC_ACCOUNT_ID: <Account ID>
    NEW_RELIC_REGION: <Region>
    NR_CLI_MSSQL_CONFIG_PRESET: <1 Basic, 2 Advanced, default 1>
    NR_CLI_MSSQL_INSTANCES_FILE: <path to the instances YAML file on the target host, using RDS endpoints as host>
    NR_CLI_MSSQL_SECRETS_FILE: <path to the secrets file (KEY=VALUE per instance) on the target host>

Conseil

Pour activer le logging de débogage, ajoutez verbosity: "debug" sous vars dans le playbook.

Variable

Description

Défaut

NR_CLI_MSSQL_CONFIG_PRESET

Configuration NRDOT :

1 pour Basic
2 pour Advanced

1

NR_CLI_MSSQL_INSTANCES_FILE

Requis. Chemin d’accès au fichier YAML d’instance, utilisant les points de terminaison RDS comme host, déjà présent sur l’hôte cible.

Aucun

NR_CLI_MSSQL_SECRETS_FILE

Requis. Chemin d’accès au fichier de secrets (KEY=VALUE, une paire nom d’utilisateur / mot de passe maître RDS par instance), déjà présent sur l’hôte cible.

Aucun

Conseil

Pour monitorer plus d’un point de terminaison RDS SQL Server depuis ce collecteur, ajoutez des entrées supplémentaires au fichier d’instances et les identifiants numérotés correspondants au fichier de secrets. Une instance qui échoue à ses vérifications est ignorée avec une raison dans le log plutôt que d’annuler toute l’installation.

Cette cible est uniquement prise en charge sur un hôte collecteur Windows, et nécessite que vos instances RDS soient déjà jointes à un domaine AWS Managed Microsoft AD. Elle monitore un ou plusieurs points de terminaison RDS SQL Server à partir d’un seul collecteur à l’aide d’un fichier d’instance (YAML, host/port par instance, en utilisant les points de terminaison RDS comme host). Contrairement à la cible auto-hébergée ci-dessus, il n’y a pas d’option "même hôte" ici : un compte de domaine (ou gMSA) est toujours requis.

Créez le fichier d'instance sur l'hôte cible, en utilisant chaque point de terminaison RDS comme host, avec une seule entrée si vous ne monitorez qu'une seule instance RDS :

instances:
  - host: mydb1.xxxxxxxxxx.us-east-1.rds.amazonaws.com
    port: 1433
  - host: mydb2.xxxxxxxxxx.us-east-1.rds.amazonaws.com
    port: 1433

Ensuite, créez un fichier nommé playbook.yml et copiez-y le contenu suivant. Définissez targets sur mssql-otel-rds-winauth et remplacez les valeurs des espaces réservés par les vôtres :

- name: Install New Relic NRDOT for SQL Server on RDS (Windows Auth)
  hosts: all
  roles:
    - role: newrelic.newrelic_install
  vars:
    targets:
      - mssql-otel-rds-winauth
  environment:
    NEW_RELIC_API_KEY: <API key>
    NEW_RELIC_ACCOUNT_ID: <Account ID>
    NEW_RELIC_REGION: <Region>
    NR_CLI_MSSQL_CONFIG_PRESET: <1 Basic, 2 Advanced, default 1>
    NR_CLI_MSSQL_AUTH_MODE: <1 for Windows Domain Auth, 2 for gMSA, default 1>
    NR_CLI_MSSQL_INSTANCES_FILE: <path to the instances YAML file on the target host, using RDS endpoints as host>
    NR_CLI_MSSQL_WIN_ACCOUNT: <Windows domain account, DOMAIN\username; Windows Domain Auth only>
    NR_CLI_MSSQL_WIN_PASSWORD: <password for that account; Windows Domain Auth only>
    NR_CLI_MSSQL_GMSA_ACCOUNT: <gMSA account, DOMAIN\gMSAName$; gMSA only>

Conseil

Pour activer le logging de débogage, ajoutez verbosity: "debug" sous vars dans le playbook.

Variable	Description	Défaut
`NR_CLI_MSSQL_CONFIG_PRESET`	Configuration NRDOT : `1` pour Basic `2` pour Advanced	`1`
`NR_CLI_MSSQL_AUTH_MODE`	Authentification SQL Server : `1` pour l’authentification de domaine Windows `2` pour gMSA	`1`
`NR_CLI_MSSQL_INSTANCES_FILE`	Requis. Chemin d’accès au fichier YAML d’instance, utilisant les points de terminaison RDS comme `host`, déjà présent sur l’hôte cible.	Aucun
`NR_CLI_MSSQL_WIN_ACCOUNT` / `NR_CLI_MSSQL_WIN_PASSWORD`	Requis si `NR_CLI_MSSQL_AUTH_MODE` est `1`. Compte de domaine Windows (`DOMAIN\username`), et mot de passe auxquels accorder des autorisations, et sous lesquels exécuter le service du collecteur.	Aucun
`NR_CLI_MSSQL_GMSA_ACCOUNT`	Requis si `NR_CLI_MSSQL_AUTH_MODE` est `2`. Compte gMSA (`DOMAIN\gMSAName$`) auquel accorder des autorisations.	Aucun

Conseil

Pour monitorer plus d’un point de terminaison RDS SQL Server depuis ce collecteur, ajoutez plus d’entrées au fichier des instances. Un mode d’authentification et une identité Windows sont utilisés pour chaque point de terminaison dans le fichier. Un point de terminaison qui échoue à ses vérifications est ignoré avec une raison dans le log plutôt que d’annuler toute l’installation.

Exécutez le playbook

bash

$ansible-playbook -i <inventory_file> <playbook_file>.yml

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 :

Allez à one.newrelic.com > All capabilities > Databases.
Dans la liste déroulante Entity type, sélectionnez MSSQL instance, puis cliquez sur Apply.
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

Configurer la corrélation APM-base de données

Découvrez comment corréler les performances des applications avec les opérations de base de données dans New Relic.

Dépannage

Découvrez comment dépanner votre configuration de monitoring MSSQL dans New Relic.

Référence des métriques

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

Cette traduction automatique est fournie pour votre commodité.

Installez & configurez NRDOT pour le monitoring MSSQL avec Ansible

Installation guidée

Prérequis

Installez le rôle

Configurez le playbook

Auto-hébergé - Authentification SQL Server

Conseil

Conseil

Auto-hébergé - Authentification Windows ou gMSA

Conseil

Conseil

AWS RDS - Authentification SQL Server

Conseil

Conseil

AWS RDS - Authentification de domaine Windows ou gMSA

Conseil

Conseil

Exécutez le playbook

Trouvez et utilisez vos données

Configurer la corrélation APM-base de données

Dépannage

Référence des métriques

Cette traduction automatique est fournie pour votre commodité.

Installez & configurez NRDOT pour le monitoring MSSQL avec Ansible

Installation guidée

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

Installez le rôle

Configurez le playbook

Auto-hébergé - Authentification Windows ou gMSA

AWS RDS - Authentification SQL Server

AWS RDS - Authentification de domaine Windows ou gMSA

Exécutez le playbook

Trouvez et utilisez vos données

Documentation associée

Configurer la corrélation APM-base de données

Dépannage

Référence des métriques

Prérequis