Le gestionnaire de charges de travail pour Microsoft SQL Server utilise l'agent de Google Cloudpour les charges de travail de calcul afin de détecter et de collecter des métadonnées pour évaluer vos configurations SQL Server.
Ce document explique comment installer, configurer et vérifier l'Agent pour les charges de travail de calcul sur les instances Compute Engine exécutant SQL Server.
Prérequis pour installer l'agent
Avant d'installer Agent for Compute Workloads, 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'agent deGoogle Cloudpour les charges de travail de calcul utilise le compte de service IAM associé à la VM pour l'authentification avec Google Cloud et pour l'autorisation d'accéder aux ressources Google Cloud . Pour la collecte des métriques de validation du gestionnaire de charges de travail, utilisez un nouveau compte de service qui inclut les rôles IAM suivants:
- Lecteur Compute (
roles/compute.viewer) - Accesseur de secret Secret Manager (
roles/secretmanager.secretAccessor) - Administrateur Workload Manager (
roles/workloadmanager.admin) - Rédacteur de journaux (
roles/logging.logWriter), si vous utilisez la fonctionnalité Cloud Logging
Pour ajouter un rôle requis à votre compte de service, procédez comme suit :
Dans la console Google Cloud, accédez à la page IAM.
Sélectionnez votre projet Google Cloud.
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.
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
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 API 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 la page Créer une VM qui utilise un compte de service géré par l'utilisateur.
Si vous limitez l'accès aux API Cloud, l'agent pour les charges de travail de calcul 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 la section Bonnes pratiques concernant les champs d'application.
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 de calcul puisse accéder aux API et services Google. Pour savoir comment activer l'accès privé à Google sur un sous-réseau, consultez la section 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 de calcul à 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 d'Agent for Compute Workloads.
- Elle crée un service Windows nommé
google-cloud-workload-agentet 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:
- Connectez-vous à l'instance de VM Windows à l'aide de RDP.
- 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
- Examinez le fichier de configuration situé sous
%ProgramFiles%\Google\google-cloud-workload-agent\confet mettez-le à jour à l'aide des informations fournies dans Propriétés de configuration. - Redémarrez l'agent pour que cette modification soit prise en compte.
Linux
Sous Linux, vous installez l'Agent pour les charges de travail de calcul à l'aide des commandes standards de gestion des packages du système d'exploitation:
- Sur RHEL, utiliser la commande
yum - Sous SLES, utilisez la commande
zypper - Sous Debian, utilisez la commande
apt
La commande de gestion des packages effectue les tâches suivantes :
- Télécharge la dernière version d'Agent for Compute Workloads.
- Elle crée l'agent en tant que service
systemdLinux 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:
- Établissez une connexion SSH avec votre VM hôte.
- 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
- Examinez le fichier de configuration situé sous
\etc\google-cloud-workload-agentet mettez-le à jour à l'aide des informations fournies dans Propriétés de configuration. - 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 |
INFO. Ne modifiez pas le niveau de journalisation, sauf indication contraire de Cloud Customer Care.
|
log_to_cloud |
Pour rediriger les journaux de l'agent vers Cloud Logging, spécifiez |
common_discovery.collection_frequency |
Fréquence de collecte pour le service de découverte commun, en secondes. |
agent_properties.log_usage_metrics |
Pour activer la journalisation des métriques d'état de l'agent, définissez la valeur sur |
sqlserver_configuration.enabled |
Pour activer la collecte des métriques SQL Server dans l'agent, définissez la valeur sur |
sqlserver_configuration.collection_configuration.collect_guest_os_metrics |
Pour activer la collecte des métriques de l'OS, définissez la valeur sur |
sqlserver_configuration.collection_configuration.collect_sql_metrics |
Pour activer la collecte des métriques SQL Server, spécifiez |
sqlserver_configuration.collection_configuration.collection_frequency |
Fréquence de collecte des métriques Agent for Compute Workloads, en secondes.
La valeur par défaut est |
sqlserver_configuration.credential_configurations[].connection_parameters[].host |
Nom d'hôte de SQL Server. |
sqlserver_configuration.credential_configurations[].connection_parameters[].username |
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 stratégies internes. Remarque:Si vous utilisez l'authentification Windows, veillez à spécifier le nom d'utilisateur au format suivant : |
sqlserver_configuration.credential_configurations[].connection_parameters[].secret.project_id |
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 |
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 |
Spécifiez le port sur lequel votre instance SQL Server accepte les requêtes. |
sqlserver_configuration.credential_configurations[].remote_win.connection_parameters.host |
Adresse IP ou nom de domaine complet de la VM Windows distante |
sqlserver_configuration.credential_configurations[].remote_win.connection_parameters.username |
Spécifiez le compte utilisateur utilisé pour se connecter à distance à la VM Windows. |
sqlserver_configuration.credential_configurations[].remote_win.connection_parameters.secret.secret_name |
Pour fournir le mot de passe du compte utilisateur Windows utilisé par l'agent pour se connecter à distance à la VM, spécifiez le nom du secret dans Secret Manager qui contient les identifiants de sécurité du compte utilisateur de la 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 |
Spécifiez |
sqlserver_configuration.credential_configurations[].remote_linux.connection_parameters.host |
Adresse IP ou nom de domaine complet de la VM Linux distante. |
sqlserver_configuration.credential_configurations[].remote_linux.connection_parameters.username |
Spécifiez le compte utilisateur utilisé pour se connecter à distance à la VM Linux. |
sqlserver_configuration.credential_configurations[].remote_linux.connection_parameter.port |
Spécifiez le numéro de port SSH de la VM Linux distante. |
sqlserver_configuration.credential_configurations[].remote_linux.linux_ssh_private_key_path |
Spécifiez le chemin d'accès au fichier de clé privée SSH. |
sqlserver_configuration.credential_configurations[].vm_properties.instance_name |
Indiquez le nom de votre instance de VM Compute Engine. Remarque:Facultatif pour la collection locale. |
sqlserver_configuration.credential_configurations[].vm_properties.instance_id |
Spécifiez l'ID de votre instance de VM Compute Engine. Remarque:Facultatif pour la collection locale. |
sqlserver_configuration.collection_timeout |
Délai d'inactivité de la collecte des métriques, en secondes. La valeur par défaut est "10s". |
sqlserver_configuration.max_retries |
Nombre maximal de nouvelles tentatives en cas d'échec de la collecte. La valeur par défaut est 3. |
sqlserver_configuration.retry_frequency |
Spécifiez la fréquence à laquelle l'agent doit réessayer en cas d'échec d'une collecte. La valeur par défaut est "3600s". |
sqlserver_configuration.remote_collection |
Spécifiez |
L'exemple suivant montre un fichier de configuration pour l'Agent pour les charges de travail de calcul:
Collection 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
- Connectez-vous à l'instance de VM Windows à l'aide de RDP.
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
- Établissez une connexion SSH avec votre instance de VM hôte.
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
- Utilisez RDP pour vous connecter à la machine hôte.
- En tant qu'administrateur, exécutez la commande suivante à partir de PowerShell :
googet installed google-cloud-workload-agent
RHEL
- Utilisez SSH pour vous connecter à la machine hôte.
- Exécutez la commande suivante :
yum info google-cloud-workload-agent
SUSE
- Utilisez SSH pour vous connecter à la machine hôte.
- Exécutez la commande suivante :
zypper info google-cloud-workload-agent
Debian
- Utilisez SSH pour vous connecter à la machine hôte.
- 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
- Utilisez RDP pour vous connecter à la machine hôte.
- En tant qu'administrateur, exécutez la commande suivante à partir de PowerShell :
Restart-Service -Name 'google-cloud-workload-agent' -Force
Linux
- Utilisez SSH pour vous connecter à la machine hôte.
- 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
- Utilisez RDP pour vous connecter à la machine hôte.
- En tant qu'administrateur, exécutez la commande suivante à partir de PowerShell :
googet latest google-cloud-workload-agent
RHEL
- Utilisez SSH pour vous connecter à la machine hôte.
- Exécutez la commande suivante :
sudo yum check-update google-cloud-workload-agent
SLES
- Utilisez SSH pour vous connecter à la machine hôte.
- Exécutez la commande suivante :
sudo zypper list-updates -r google-cloud-workload-agent
Debian
- Utilisez SSH pour vous connecter à la machine hôte.
- 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
- Utilisez RDP pour vous connecter à la machine hôte.
- En tant qu'administrateur, exécutez la commande suivante à partir de PowerShell :
googet install google-cloud-workload-agent
RHEL
- Utilisez SSH pour vous connecter à la machine hôte.
- Exécutez la commande suivante :
sudo yum --nogpgcheck update google-cloud-workload-agent
SLES
- Utilisez SSH pour vous connecter à la machine hôte.
- Exécutez la commande suivante :
sudo zypper --no-gpg-checks update google-cloud-workload-agent
Debian
- Utilisez SSH pour vous connecter à la machine hôte.
- 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 :
Dans Google Cloud Console, accédez à la page Explorateur de journaux.
Accédez au volet Requête.
Dans le menu déroulant Ressources, sélectionnez Global, puis cliquez sur Appliquer.
Dans l'éditeur de requêtes, saisissez
google-cloud-workload-agent.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:
Établissez une connexion RDP ou SSH avec votre instance de VM hôte.
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
Pour la propriété
log_to_cloud, remplacez la valeur parfalse.Enregistrez le fichier de configuration.
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 de calcul, leurs causes et leur résolution.
Champs d'application d'authentification insuffisants
Problème:si vous limitez les champs d'application d'accès sur votre instance de VM hôte, les journaux de l'agent pour les charges de travail Compute peuvent 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 de calcul 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 champs d'application 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 à l'aide des informations de la section Propriétés de configuration.
Échec de l'initialisation de la collecte des données
Problème:si le fichier de configuration n'est pas mis à jour après l'installation de l'agent, 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.
Étape suivante
- En savoir plus sur les évaluations des charges de travail