Configurer l'agent pour Microsoft SQL Server

Workload Manager pour Microsoft SQL Server utilise l'agent Google Cloudpour les charges de travail Compute afin de détecter et de collecter des métadonnées pour évaluer vos configurations SQL Server.

Ce document explique comment installer, configurer et valider l'agent pour les charges de travail Compute sur les instances Compute Engine qui exécutent SQL Server.

Conditions préalables à l'installation de l'agent

Avant d'installer l'agent pour les charges de travail Compute, vous devez vous assurer que les conditions préalables suivantes sont remplies et créer une évaluation de la charge de travail SQL Server.

Attribuer des rôles IAM au compte de service

L'agentGoogle Cloudpour les charges de travail Compute utilise le compte de service Identity and Access Management (IAM) associé à la VM pour l'authentification avec Google Cloud et pour l'autorisation d'accès aux ressources Google Cloud . Pour la collecte des métriques de validation Workload Manager, utilisez un nouveau compte de service incluant les rôles IAM suivants :

Pour ajouter un rôle requis à votre compte de service, procédez comme suit :

  1. Dans la console Google Cloud , accédez à la page IAM.

    Accéder à IAM

  2. Sélectionnez votre projet Google Cloud .

  3. Identifiez le compte de service auquel vous souhaitez ajouter un rôle.

    • Si ce compte de service ne figure pas déjà sur la liste des comptes principaux, cela signifie qu'aucun rôle ne lui a encore été attribué. Cliquez sur Ajouter, puis saisissez l'adresse e-mail du compte de service.
    • Si le compte de service figure déjà sur la liste des comptes principaux, il possède des rôles. Cliquez sur le bouton Modifier correspondant au compte de service que vous souhaitez modifier.

  4. Sélectionnez le rôle requis dans la liste des rôles disponibles :

    • Compute Engine > Lecteur Compute
    • Secret Manager > Accesseur de secrets de Secret Manager

  5. Cliquez sur Ajouter ou sur Enregistrer pour appliquer le ou les rôles sélectionnés au compte de service.

Activer l'accès aux API Google Cloud

Compute Engine recommande de configurer vos instances de VM de façon à accorder un niveau d'accès complet à toutes les APIs Cloud et à n'utiliser que les autorisations IAM du compte de service de l'instance pour contrôler les accès aux ressources Google Cloud . Pour en savoir plus, consultez Créer une VM qui utilise un compte de service géré par l'utilisateur.

Si vous limitez l'accès aux APIs Cloud, l'agent pour les charges de travail Compute nécessite au minimum les niveaux d'accès suivants aux API Cloud sur l'instance de VM hôte :

https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Bonnes pratiques concernant les autorisations.

Si vous exécutez des applications SQL Server sur une instance de VM qui ne possède pas d'adresse IP externe, vous devez activer l'accès privé à Google sur le sous-réseau de la VM afin que l'agent pour les charges de travail Compute puisse accéder aux API et services Google. Pour savoir comment activer l'accès privé à Google sur un sous-réseau, consultez Configurer l'accès privé à Google.

Autorisations requises sur SQL Server

Utilisez le script suivant pour attribuer les autorisations requises au compte utilisateur configuré dans l'agent.

    USE [master]
    GO 

    GRANT VIEW SERVER STATE TO [user_name]
    GRANT VIEW ANY DEFINITION TO [user_name] 

    -- Adds db_datareader role to the user
    EXEC sp_MSForEachDB
    '
    USE ?
    IF NOT EXISTS(SELECT * FROM sys.database_principals WHERE name = ''user_name'')
    BEGIN
      CREATE USER [user_name] FOR LOGIN [user_name]
    END
    EXEC sp_addrolemember ''db_datareader'', ''user_name''
    '

Installer l'agent

Pour installer la dernière version de l'agent pour les charges de travail Compute, procédez comme suit :

Windows

Sous Windows, vous installez l'agent pour les charges de travail Compute à l'aide de la commande de gestion des packages GooGet googet. La commande de gestion des packages effectue les tâches suivantes :

  • Télécharge la dernière version de l'agent pour les charges de travail Compute.
  • Elle crée un service Windows nommé google-cloud-workload-agent et une tâche planifiée qui s'exécute toutes les minutes pour vérifier si le service est toujours en cours d'exécution et, si nécessaire, le redémarrer.

Pour installer l'agent sur une VM, procédez comme suit :

  1. Connectez-vous à l'instance de VM Windows à l'aide de RDP.
  2. En tant qu'administrateur, exécutez les commandes suivantes à partir de PowerShell : 
    googet addrepo google-cloud-workload-agent  https://packages.cloud.google.com/yuck/repos/google-cloud-workload-agent-windows-x86_64
googet install google-cloud-workload-agent
  3. Examinez le fichier de configuration situé sous %ProgramFiles%\Google\google-cloud-workload-agent\conf et mettez-le à jour à l'aide des informations de la section Propriétés de configuration.
  4. Redémarrez l'agent pour que cette modification soit prise en compte.

Linux

Sous Linux, vous installez l'agent pour les charges de travail Compute à l'aide des commandes standards de gestion des packages du système d'exploitation :

  • Sur RHEL, utilisez la commande yum.
  • Sur SLES, utilisez la commande zypper.
  • Sur Debian, utilisez la commande apt.

La commande de gestion des packages effectue les tâches suivantes :

  • Télécharge la dernière version de l'agent pour les charges de travail Compute.
  • Elle crée l'agent en tant que service systemd Linux nommé google-cloud-workload-agent.
  • Elle active et démarre le service google-cloud-workload-agent.

Pour installer l'agent sur une VM, procédez comme suit :

  1. Établissez une connexion SSH avec votre VM hôte.

  2. Dans votre terminal, installez l'agent en exécutant la commande spécifique à votre système d'exploitation :

    RHEL 

    sudo tee /etc/yum.repos.d/google-cloud-workload-agent.repo << EOM
[google-cloud-workload-agent]
name=Google Cloud Agent for Compute Workloads
baseurl=https://packages.cloud.google.com/yum/repos/google-cloud-workload-agent-$basearch
enabled=1
gpgcheck=0
repo_gpgcheck=1
gpgkey=https://packages.cloud.google.com/yum/doc/yum-key.gpg https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg
EOM
sudo yum install google-cloud-workload-agent

    SLES

    sudo zypper addrepo --refresh https://packages.cloud.google.com/yum/repos/google-cloud-workload-agent-$basearch
google-cloud-workload-agent
sudo zypper install google-cloud-workload-agent

    Debian 

    echo 'deb https://packages.cloud.google.com/apt google-cloud-workload-agent-x86-64-apt main' | sudo tee -a /etc/apt/sources.list.d/google-cloud-workload-agent.list
sudo apt-get update
sudo apt-get install google-cloud-workload-agent

  3. Examinez le fichier de configuration situé sous \etc\google-cloud-workload-agent et mettez-le à jour à l'aide des informations de la section Propriétés de configuration.

  4. Redémarrez l'agent pour que cette modification soit prise en compte.

Propriétés de configuration

Le tableau suivant décrit les propriétés du fichier de configuration de l'agent.

Propriétés
log_level

String

Pour définir le niveau de journalisation de l'agent, ajoutez les niveaux de journalisation. Les niveaux de journalisation disponibles sont les suivants :
  • DEBUG
  • INFO
  • WARNING
  • ERROR
La valeur par défaut est INFO. Ne modifiez pas le niveau de journalisation, sauf si vous êtes dirigé par le service client Cloud Customer Care.
log_to_cloud

Boolean

Pour rediriger les journaux de l'agent vers Cloud Logging, spécifiez true. La valeur par défaut est true.
common_discovery.collection_frequency

Duration

Fréquence de collecte pour le service de découverte commun, en secondes.
La valeur par défaut est 10800s.
agent_properties.log_usage_metrics

Boolean

Pour activer la journalisation des métriques d'état de l'agent, définissez la valeur sur true. La valeur par défaut est false.
sqlserver_configuration.enabled

Boolean

Pour activer la collecte des métriques SQL Server dans l'agent, définissez la valeur sur true. La valeur par défaut est false.
sqlserver_configuration.collection_configuration.collect_guest_os_metrics

Boolean

Pour activer la collecte des métriques de l'OS, définissez la valeur sur true. La valeur par défaut est true.
Ne définissez pas sqlserver_configuration.collection_configuration.collect_guest_os_metrics sur false, sauf si vous êtes dirigé par le service client Cloud Customer Care.
sqlserver_configuration.collection_configuration.collect_sql_metrics

Boolean

Pour activer la collecte des métriques SQL Server, spécifiez true. La valeur par défaut est true.
Ne définissez pas sqlserver_configuration.collection_configuration.collect_sql_metrics sur false, sauf si vous êtes dirigé par le service client Cloud Customer Care.
sqlserver_configuration.collection_configuration.collection_frequency

Duration

Fréquence de collecte des métriques de l'agent pour les charges de travail de calcul, en secondes. La valeur par défaut est 3600s. Vous pouvez modifier la fréquence de collecte. Toutefois, nous vous recommandons de conserver la valeur par défaut.
sqlserver_configuration.credential_configurations[].connection_parameters[].host

String

Nom d'hôte SQL Server.
sqlserver_configuration.credential_configurations[].connection_parameters[].username

String

Spécifiez le compte utilisateur utilisé pour interroger l'instance SQL Server. Pour configurer les autorisations de compte, passez en revue les autorisations requises dans le script d'autorisation et accordez-les conformément à vos règles internes.

Remarque : Si vous utilisez l'authentification Windows, assurez-vous de spécifier le nom d'utilisateur au format suivant : domain-name\\user-name

sqlserver_configuration.credential_configurations[].connection_parameters[].secret.project_id

String

ID du projet dans lequel le secret est stocké. Définissez-le sur une chaîne vide ("") si le secret et l'instance de VM hôte existent dans le même projet Google Cloud .
sqlserver_configuration.credential_configurations[].connection_parameters[].secret.secret_name

String

Pour fournir le mot de passe du compte utilisateur de base de données utilisé par l'agent pour interroger SQL Server de manière sécurisée, spécifiez le nom du secret dans Secret Manager contenant les identifiants de sécurité du compte utilisateur de base de données.

Remarque : Le secret et l'instance de VM hôte doivent se trouver dans le même projet Google Cloud .
sqlserver_configuration.credential_configurations[].connection_parameters[].port

Int

Spécifiez le port sur lequel l'instance SQL Server accepte les requêtes.
sqlserver_configuration.credential_configurations[].remote_win.connection_parameters.host

String

Adresse IP ou nom de domaine complet de la VM Windows distante
sqlserver_configuration.credential_configurations[].remote_win.connection_parameters.username

String

Spécifiez le compte utilisateur utilisé pour vous connecter à distance à la VM Windows.
sqlserver_configuration.credential_configurations[].remote_win.connection_parameters.secret.secret_name

String

Pour fournir le mot de passe du compte utilisateur Windows utilisé par l'agent pour se connecter à distance à la VM de manière sécurisée, spécifiez le nom du secret dans Secret Manager contenant les identifiants de sécurité du compte utilisateur de base de données.

Remarque : Le secret et l'instance de VM hôte doivent se trouver dans le même projet Google Cloud .
sqlserver_configuration.credential_configurations[].local_collection

Boolean

Spécifiez true pour indiquer que l'agent collecte des données locales. La valeur par défaut est true.
sqlserver_configuration.credential_configurations[].remote_linux.connection_parameters.host

String

Adresse IP ou nom de domaine complet de la VM Linux distante.
sqlserver_configuration.credential_configurations[].remote_linux.connection_parameters.username

String

Spécifiez le compte utilisateur utilisé pour se connecter à distance à la VM Linux.
sqlserver_configuration.credential_configurations[].remote_linux.connection_parameter.port

Int

Spécifiez le numéro de port SSH pour la VM Linux distante.
sqlserver_configuration.credential_configurations[].remote_linux.linux_ssh_private_key_path

String

Spécifiez le chemin d'accès au fichier de clé privée SSH.
sqlserver_configuration.credential_configurations[].vm_properties.instance_name

String

Indiquez le nom de votre instance de VM Compute Engine.

Remarque : Facultatif pour la collecte locale.
sqlserver_configuration.credential_configurations[].vm_properties.instance_id

String

Indiquez l'ID de votre instance de VM Compute Engine.

Remarque : Facultatif pour la collecte locale.
sqlserver_configuration.collection_timeout

Duration

Délai avant expiration de la collecte de métriques, en secondes. La valeur par défaut est "10s".
sqlserver_configuration.max_retries

Int

Nombre maximal de nouvelles tentatives en cas d'échec de la collecte. La valeur par défaut est "3".
sqlserver_configuration.retry_frequency

Duration

Spécifiez la fréquence à laquelle l'agent doit réessayer en cas d'échec de la collecte. La valeur par défaut est "3600s".
sqlserver_configuration.remote_collection

Boolean

Spécifiez true pour indiquer que l'agent collecte des données à distance. La valeur par défaut est false.

L'exemple suivant montre un fichier de configuration pour l'agent pour les charges de travail Compute :

Collecte locale

{
"log_level": "INFO",
"common_discovery": {
    "collection_frequency": "10800s"
},
"sqlserver_configuration": {
    "enabled": true,
    "collection_configuration": {
        "collect_guest_os_metrics": true,
        "collect_sql_metrics": true,
        "collection_frequency": "60s"
    },
    "credential_configurations": [
        {
            "connection_parameters": [
                {
                    "host": ".",
                    "username": "db_user_name",
                    "secret": {
                        "project_id": "",
                        "secret_name": "idb_pwd_secret_name"
                    },
                    "port": 1433
                }
            ],
            "local_collection": true
        }
    ],
    "collection_timeout": "60s",
    "max_retries": 5,
    "retry_frequency": "3600s"
}
}

Collecte à distance

{
"log_level": "INFO",
"common_discovery": {
    "collection_frequency": "10800s"
},
"sqlserver_configuration": {
    "enabled": true,
    "collection_configuration": {
        "collect_guest_os_metrics": true,
        "collect_sql_metrics": true,
        "collection_frequency": "60s"
    },
    "credential_configurations": [
        {
            "connection_parameters": [
                {
                    "host": "sql_server_instance",
                    "username": "db_user_name",
                    "secret": {
                        "project_id": "",
                        "secret_name": "db_pwd_secret_name"
                    },
                    "port": 1433
                }
            ],
            "remote_win": {
                "connection_parameters": {
                    "host": "sql_server_instance",
                    "username": "user_name",
                    "secret": {
                        "project_id": "",
                        "secret_name": "pwd_secret_name"
                    }
                }
            },
            "vm_properties": {
                "instance_name": "db01",
                "instance_id": "9999999999999999999"
            }
        },
        {
            "connection_parameters": [
                {
                    "host": "sql_server_instance",
                    "username": "db_user_name",
                    "secret": {
                        "project_id": "",
                        "secret_name": "db_pwd_secret_name"
                    },
                    "port": 1433
                }
            ],
            "remote_linux": {
                "connection_parameters": {
                    "host": "sql_server_instance",
                    "username": "user_name",
                    "secret": {
                        "project_id": "",
                        "secret_name": "pwd_secret_name"
                    },
                    "port": 22
                },
                "linux_ssh_private_key_path": "path of the private key"
            },
            "vm_properties": {
                "instance_name": "db02",
                "instance_id": "9999999999999999999"
            }
        }
    ],
    "collection_timeout": "10s",
    "max_retries": 3,
    "retry_frequency": "3600s",
    "remote_collection": true
}
}

Vérifier l'installation de l'agent

Windows

  1. Connectez-vous à l'instance de VM Windows à l'aide de RDP.

  2. Exécutez la commande suivante à partir de PowerShell en tant qu'administrateur :

    $(Get-Service -Name 'google-cloud-workload-agent' -ErrorAction Ignore).Status

    Si l'agent est en cours d'exécution, l'état indique Running.

Linux

  1. Établissez une connexion SSH avec votre instance de VM hôte.

  2. Exécutez la commande suivante : 

    systemctl status google-cloud-workload-agent

    Si l'agent fonctionne correctement, la sortie contient active (running). Exemple : 

    google-cloud-workload-agent.service - Google Cloud Agent for Compute Workloads
Loaded: loaded (/usr/lib/systemd/system/google-cloud-workload-agent.service; enabled; vendor preset: disabled)
Active: active (running) since Sun 2023-12-31 18:59:12 UTC; 10s ago
Main PID: 14412 (google_cloud_sq)
  Tasks: 7
Memory: 12.9M (max: 1.0G limit: 1.0G available: 1011.0M)
CGroup: /system.slice/google-cloud-workload-agent.service
        └─ 14412 /usr/bin/google_cloud_sql_server_agent --action=run

Vérifier la version de l'agent

Pour afficher la version de l'agent, procédez comme suit :

Windows

  1. Utilisez RDP pour vous connecter à la machine hôte.
  2. En tant qu'administrateur, exécutez la commande suivante à partir de PowerShell : 
    googet installed google-cloud-workload-agent

RHEL

  1. Utilisez SSH pour vous connecter à la machine hôte.
  2. Exécutez la commande suivante : 
    yum info google-cloud-workload-agent

SUSE

  1. Utilisez SSH pour vous connecter à la machine hôte.
  2. Exécutez la commande suivante : 
    zypper info google-cloud-workload-agent

Debian

  1. Utilisez SSH pour vous connecter à la machine hôte.
  2. Exécutez la commande suivante : 
    dpkg -s google-cloud-workload-agent | grep version

Redémarrer l'agent

Si l'agent pour les charges de travail Compute cesse de fonctionner ou si vous mettez à jour sa configuration, redémarrez l'agent.

Sélectionnez votre système d'exploitation, puis procédez comme suit :

Windows

  1. Utilisez RDP pour vous connecter à la machine hôte.
  2. En tant qu'administrateur, exécutez la commande suivante à partir de PowerShell : 
    Restart-Service -Name 'google-cloud-workload-agent' -Force

Linux

  1. Utilisez SSH pour vous connecter à la machine hôte.
  2. Exécutez la commande suivante : 
    sudo systemctl restart google-cloud-workload-agent

Mettre à jour l'agent

Pour vous assurer que vous disposez de la dernière version de l'agent, vous devez régulièrement vérifier si des mises à jour sont disponibles et mettre à jour l'agent.

Rechercher des mises à jour

Sélectionnez votre système d'exploitation, puis procédez comme suit :

Windows

  1. Utilisez RDP pour vous connecter à la machine hôte.
  2. En tant qu'administrateur, exécutez la commande suivante à partir de PowerShell : 
    googet latest google-cloud-workload-agent

RHEL

  1. Utilisez SSH pour vous connecter à la machine hôte.
  2. Exécutez la commande suivante : 
    sudo yum check-update google-cloud-workload-agent

SLES

  1. Utilisez SSH pour vous connecter à la machine hôte.
  2. Exécutez la commande suivante : 
    sudo zypper list-updates -r google-cloud-workload-agent

Debian

  1. Utilisez SSH pour vous connecter à la machine hôte.
  2. Exécutez la commande suivante : 
    sudo apt list google-cloud-workload-agent

Installer une mise à jour

Sélectionnez votre système d'exploitation, puis procédez comme suit :

Windows

  1. Utilisez RDP pour vous connecter à la machine hôte.
  2. En tant qu'administrateur, exécutez la commande suivante à partir de PowerShell : 
    googet install google-cloud-workload-agent

RHEL

  1. Utilisez SSH pour vous connecter à la machine hôte.
  2. Exécutez la commande suivante : 
    sudo yum --nogpgcheck update google-cloud-workload-agent

SLES

  1. Utilisez SSH pour vous connecter à la machine hôte.
  2. Exécutez la commande suivante : 
    sudo zypper --no-gpg-checks update google-cloud-workload-agent

Debian

  1. Utilisez SSH pour vous connecter à la machine hôte.
  2. Exécutez la commande suivante : 
    sudo apt-get install google-cloud-workload-agent

Afficher les journaux de l'agent dans Cloud Logging

Par défaut, les journaux de l'agent pour les charges de travail Compute sont redirigés depuis vos instances de VM vers Cloud Logging.

Pour afficher les journaux de l'agent dans Logging, procédez comme suit :

  1. Dans la console Google Cloud , accédez à la page Explorateur de journaux.

    Accéder à l'explorateur de journaux

  2. Accédez au volet Requête.

  3. Dans le menu déroulant Ressources, sélectionnez Global, puis cliquez sur Appliquer.

  4. Dans l'éditeur de requêtes, saisissez google-cloud-workload-agent.

  5. Cliquez sur Exécuter la requête.

    Vous devriez voir les journaux générés par les instances d'agent s'exécutant sur l'ensemble de vos instances de VM. Pour filtrer les journaux d'une machine spécifique, utilisez les filtres disponibles dans l'interface.

Désactiver les journaux de l'agent dans Cloud Logging

Pour désactiver la redirection par défaut des journaux de l'agent vers Cloud Logging, procédez comme suit :

  1. Établissez une connexion RDP ou SSH avec votre instance de VM hôte.

  2. Modifiez le fichier de configuration de l'agent :

    Windows 

    %ProgramFiles%\Google\google-cloud-workload-agent\conf\configuration.json

    Linux 

    /etc/google-cloud-workload-agent/configuration.json

  3. Pour la propriété log_to_cloud, remplacez la valeur par false.

  4. Enregistrez le fichier de configuration.

  5. Redémarrez l'agent pour que cette modification soit prise en compte.

Dépannage

Les sections suivantes fournissent des informations sur les problèmes courants liés à l'utilisation de l'agent pour les charges de travail Compute, leurs causes et leur résolution.

Champs d'application d'authentification insuffisants

Problème : Si vous limitez les niveaux d'accès sur votre instance de VM hôte, l'erreur de l'agent pour les charges de travail Compute peut afficher une erreur d'autorisation IAM insuffisante. 

  googleapi: Error 403: Request had insufficient authentication scopes.
  Details:
  [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "googleapis.com",
      "metadata": {
        "method": "google.cloud.workloadmanager.datawarehouse.v1.DataCollectService.WriteInsight",
        "service": "workloadmanager.googleapis.com"
      },
      "reason": "ACCESS_TOKEN_SCOPE_INSUFFICIENT"
    }
  ]



More details:
  Reason: insufficientPermissions, Message: Insufficient Permission

Cause : l'agent pour les charges de travail Compute nécessite un minimum de niveaux d'accès aux API Cloud sur l'instance de VM hôte.

Solution : pour résoudre ce problème, activez les scopes d'accès requis.

Échec du chargement du fichier de configuration

Problème : si le fichier de configuration contient des valeurs non valides, l'erreur suivante s'affiche. 

"Failed to load configuration","pid":3524,"error":"proto: (line 19:42): unknown
field "{field_name}"

Résolution : pour résoudre ce problème, mettez à jour le fichier de configuration en utilisant les informations de la section Propriétés de configuration.

Échec de l'initialisation de la collecte de données

Problème : Après l'installation de l'agent, si le fichier de configuration n'est pas mis à jour, l'erreur suivante s'affiche : 

"Failed to initialize guest collection","pid":2112,"error":"invalid value for "user_name" "secret_name"

Solution : pour résoudre ce problème, initialisez la configuration des identifiants à l'aide des propriétés de configuration.

Étapes suivantes