Configurare l'agente per SQL Server

Workload Manager per Microsoft SQL Server utilizza l'agente per SQL Server di Google Cloudper rilevare e raccogliere i metadati per la valutazione delle configurazioni di SQL Server. L'agente per SQL Server è obbligatorio su tutte le VM che eseguono SQL Server.

Questo documento illustra come installare, configurare e verificare l'agente per SQL Server Google Cloud.

Prerequisiti per l'installazione dell'agente

Prima di installare l'agente per SQL Server, devi assicurarti che siano soddisfatti i seguenti prerequisiti e che sia stata creata una valutazione del carico di lavoro di SQL Server.

Concedi i ruoli IAM all'account di servizio

L'agente diGoogle Cloudper SQL Server utilizza l'account di servizio di Identity and Access Management (IAM) collegato alla VM per l'autenticazione con Google Cloud e per l'autorizzazione per accedere alle risorse Google Cloud . Per la raccolta delle metriche di convalida di Workload Manager, utilizza un nuovo account di servizio che includa i seguenti ruoli IAM:

Per aggiungere un ruolo obbligatorio all'account di servizio:

  1. Nella console Google Cloud, vai alla pagina IAM.

    Vai a IAM

  2. Selezionare il tuo progetto Google Cloud.

  3. Identifica l'account di servizio a cui vuoi aggiungere un ruolo.

    • Se l'account di servizio non è già presente nell'elenco delle entità, non sono stati assegnati ruoli. Fai clic su Aggiungi e inserisci l'indirizzo email dell'account di servizio.
    • Se l'account di servizio è già presente nell'elenco dei principali, significa che ha già dei ruoli. Fai clic sul pulsante Modifica per l'account di servizio che vuoi modificare.
  4. Seleziona il ruolo richiesto dall'elenco dei ruoli disponibili:

    • Compute Engine > Visualizzatore Compute
    • Secret Manager > Secret Manager Secret Accessor
  5. Fai clic su Aggiungi o Salva per applicare i ruoli all'account di servizio.

Attivare l'accesso alle Google Cloud API

Compute Engine consiglia di configurare le istanze VM in modo da consentire tutti gli ambiti di accesso a tutte le API Cloud e di utilizzare solo le autorizzazioni IAM dell'account di servizio dell'istanza per controllare l'accesso alle risorse. Google Cloud Per ulteriori informazioni, consulta Creare una VM che utilizza un account di servizio gestito dall'utente.

Se limiti l'accesso alle API Cloud, Agent for SQL Server richiede i seguenti ambiti di accesso alle API Cloud minimi nell'istanza VM host:

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

Per ulteriori informazioni, consulta le best practice per gli ambiti.

Se esegui applicazioni SQL Server su un'istanza VM che non ha un indirizzo IP esterno, devi attivare l'accesso privato Google sulla subnet della VM in modo che Agent for SQL Server possa accedere alle API e ai servizi Google. Per scoprire come abilitare l'accesso privato Google in una subnet, consulta Configurare l'accesso privato Google.

Autorizzazioni richieste su SQL Server

Utilizza il seguente script per assegnare le autorizzazioni richieste all'account utente configurato nell'agente.

    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'' '

Installa l'agente

Windows

Su Windows, installa Agent per SQL Server utilizzando il comando di gestione del pacchetto GooGet, googet. Il comando di gestione dei pacchetti completa le seguenti attività:

  • Scarica la versione più recente dell'agente per SQL Server.
  • Crea un servizio Windows denominato google-cloud-sql-server-agent e un'attività pianificata che viene eseguita ogni minuto per verificare se il servizio è ancora in esecuzione e, se necessario, riavviarlo.

Per installare l'agente su una VM:

  1. Connettiti all'istanza VM Windows utilizzando RDP.
  2. In qualità di amministratore, esegui i seguenti comandi da PowerShell:
    googet addrepo google-cloud-sql-server-agent-windows  https://packages.cloud.google.com/yuck/repos/google-cloud-sql-server-agent-windows
    googet install google-cloud-sql-server-agent
    
  3. Esamina il file di configurazione in %ProgramFiles%\Google\google-cloud-sql-server-agent e aggiorna la sezione credential_configuration utilizzando i dettagli in Proprietà di configurazione.
  4. Riavvia l'agente per applicare la modifica.

Linux

Su Linux, installa Agent for SQL Server utilizzando i comandi di gestione dei pacchetti del sistema operativo standard:

  • Su RHEL, utilizza il comando yum
  • Su SLES, utilizza il comando zypper

Il comando di gestione dei pacchetti completa le seguenti attività:

  • Scarica la versione più recente dell'agente per SQL Server.
  • Crea l'agente come servizio systemd Linux denominato google-cloud-sql-server-agent.
  • Attiva e avvia il servizio google-cloud-sql-server-agent.

Per installare l'agente su una VM:

  1. Stabilisci una connessione SSH alla VM host.
  2. Nel terminale, installa l'agente eseguendo il comando specifico per il tuo sistema operativo:

RHEL

sudo tee /etc/yum.repos.d/google-cloud-sql-server-agent.repo << EOM
[google-cloud-sql-server-agent]
name=Google Cloud Agent for SQL Server
baseurl=https://packages.cloud.google.com/yum/repos/google-cloud-sql-server-agent-el$(cat /etc/redhat-release | cut -d . -f 1 | tr -d -c 0-9)
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-sql-server-agent

SLES 15

sudo zypper addrepo --refresh https://packages.cloud.google.com/yum/repos/google-cloud-sql-server-agent-sles15 google-cloud-sql-server-agent
sudo zypper install google-cloud-sql-server-agent

SLES 12

sudo zypper addrepo --refresh https://packages.cloud.google.com/yum/repos/google-cloud-sql-server-agent-sles12 google-cloud-sql-server-agent
sudo zypper install google-cloud-sql-server-agent
  1. Esamina il file di configurazione in \etc\google-cloud-sql-server-agent e aggiorna la sezione credential_configuration utilizzando i dettagli in Proprietà di configurazione.
  2. Riavvia l'agente per applicare la modifica.

Proprietà di configurazione

La tabella seguente illustra le proprietà del file di configurazione dell'agente.

Proprietà
collection_configuration.collect_guest_os_metrics

Boolean

Per attivare la raccolta delle metriche del sistema operativo, imposta il valore su true. Il valore predefinito è true.
Non impostare collection_configuration.collect_guest_os_metrics su false a meno che non ti venga indicato dall'assistenza clienti Google Cloud.

collection_configuration.guest_os_metrics_collection_interval_in_seconds

Int

Frequenza di raccolta delle metriche del sistema operativo di Workload Manager in secondi. Il valore predefinito è 3600 secondi. Puoi aggiornare la frequenza di raccolta. Tuttavia, ti consigliamo di mantenere il valore predefinito.

collection_configuration.collect_sql_metrics

Boolean

Per abilitare la raccolta delle metriche di SQL Server, specifica true. Il valore predefinito è true.
Non impostare collection_configuration.collect_sql_metrics su false a meno che non ti venga indicato dall'assistenza clienti Google Cloud.

collection_configuration.collect_sql_metrics_collection_interval_in_seconds

Int

La frequenza di raccolta delle metriche di SQL Server di Workload Manager in secondi. Il valore predefinito è 3600 secondi. Puoi aggiornare la frequenza di raccolta. Tuttavia, ti consigliamo di mantenere il valore predefinito.

log_level

String

Per impostare il livello di logging dell'agente, aggiungi i livelli di log. I livelli di log disponibili sono i seguenti:
  • DEBUG
  • INFO
  • WARNING
  • ERROR
Il valore predefinito è INFO. Non modificare il livello di registrazione a meno che non ti venga indicato dall'assistenza clienti Google Cloud.
log_to_cloud

Boolean

Per reindirizzare i log dell'agente a Cloud Logging, specifica true. Il valore predefinito è true.

disable_log_usage

Boolean

Per disattivare il logging delle metriche di salute dell'agente, specifica true. Il valore predefinito è false.

remote_collection

Boolean

Specifica true per indicare che l'agente sta eseguendo la raccolta dei dati da remoto. Il valore predefinito è false.

credential_configuration[].sql_configurations[].user_name

String

Specifica l'account utente utilizzato per eseguire query sull'istanza SQL Server. Per configurare le autorizzazioni dell'account, esamina le autorizzazioni richieste nello script di autorizzazione e assegnale in base alle tue norme interne.

Nota: se utilizzi l'autenticazione Windows, assicurati di specificare il nome utente nel seguente formato: domain-name\\user-name

credential_configuration[].sql_configurations[].host

String

Il nome host di SQL Server.

credential_configuration[].sql_configurations[].secret_name

String

Per fornire in modo sicuro la password per l'account utente del database utilizzato dall'agente per eseguire query su SQL Server, specifica il nome del segreto in Secret Manager che contiene le credenziali di sicurezza per l'account utente del database.

Nota:il segreto e l'istanza VM host devono esistere nello stesso progetto Google Cloud.

credential_configuration[].sql_configurations[].port_number

Int

Specifica la porta su cui l'istanza SQL Server accetta le query.

credential_configuration[].remote_win.server_name

String

Indirizzo IP o FQDN della VM remota

credential_configuration[].remote_win.guest_user_name

String

Specifica l'account utente utilizzato per connettersi da remoto alla VM.

credential_configuration[].remote_win.guest_secret_name

String

Per fornire in modo sicuro la password dell'account utente utilizzato dall'agente per connettersi da remoto alla VM, specifica il nome del secret in Secret Manager che contiene le credenziali di sicurezza per l'account utente.

Nota:il segreto e l'istanza VM host devono esistere nello stesso progetto Google Cloud.

credential_configuration[].remote_linux.server_name

String

Indirizzo IP o FQDN della VM remota

credential_configuration[].remote_linux.guest_user_name

String

Specifica l'account utente utilizzato per connettersi da remoto alla VM.

credential_configuration[].remote_linux.guest_port_number

Int

Specifica il numero di porta SSH per la VM remota.

credential_configuration[].remote_linux.linux_ssh_private_key_path

String

Percorso del file della chiave privata SSH.

credential_configuration[].instance_name

String

Specifica il nome dell'istanza VM di Compute Engine.

Nota:facoltativo per la raccolta locale.

credential_configuration[].instance_id

String

Specifica l'ID dell'istanza VM di Compute Engine.

Nota:facoltativo per la raccolta locale.

L'esempio seguente mostra un file di configurazione per Agent for SQL Server:

Raccolta locale

{
"collection_configuration": {
  "collect_guest_os_metrics":true,
  "guest_os_metrics_collection_interval_in_seconds":3600,
  "collect_sql_metrics":true,
  "sql_metrics_collection_interval_in_seconds":3600
},
"credential_configuration": [
  {
    "sql_configurations": [
      {
        "host":".",
        "user_name":"db_user_name",
        "secret_name":"db_pwd_secret_name",
        "port_number":1433
      }
    ],
  }
],
"log_level":"INFO",
"log_to_cloud":true,
"collection_timeout_seconds":10,
"max_retries":5,
"retry_interval_in_seconds":3600
}

Raccolta remota

{
"collection_configuration": {
  "collect_guest_os_metrics":true,
  "guest_os_metrics_collection_interval_in_seconds":3600,
  "collect_sql_metrics":true,
  "sql_metrics_collection_interval_in_seconds":3600
},
"credential_configuration": [
  {
    "sql_configurations": [
      {
        "host":"sql_server_instance",
        "user_name":"db_user_name",
        "secret_name":"db_pwd_secret_name",
        "port_number":1433
      }
    ],
    "remote_win":{
      "server_name":"sql_server_instance",
      "guest_user_name":"user_name",
      "guest_secret_name":"pwd_secret_name"
    },
    "instance_name":"db01",
    "instance_id":"9999999999999999999"
  }
],
"remote_collection":true,
"log_level":"INFO",
"log_to_cloud":true,
"collection_timeout_seconds":10,
"max_retries":5,
"retry_interval_in_seconds":3600
}

Verificare l'installazione dell'agente

Windows

  1. Connettiti all'istanza VM Windows utilizzando RDP.
  2. Esegui il seguente comando da PowerShell come amministratore:

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

    Se l'agente è in esecuzione, lo stato visualizzato è Running.

Linux

  1. Stabilisci una connessione SSH con l'istanza VM host.
  2. Esegui questo comando:

    systemctl status google-cloud-sql-server-agent

    Se l'agente funziona correttamente, l'output contiene active (running). Ad esempio:

    google-cloud-sql-server-agent.service - Google Cloud Agent for SQL Server
    Loaded: loaded (/usr/lib/systemd/system/google-cloud-sql-server-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-sql-server-agent.service
            └─ 14412 /usr/bin/google_cloud_sql_server_agent --action=run
    

Controllare la versione dell'agente

Per controllare la versione dell'agente:

Windows

  1. Utilizza RDP per connetterti alla macchina host.
  2. In qualità di amministratore, esegui il seguente comando da PowerShell:
    googet installed google-cloud-sql-server-agent

RHEL

  1. Utilizza SSH per connetterti alla macchina host.
  2. Esegui questo comando:
    yum info google-cloud-sql-server-agent

SUSE

  1. Utilizza SSH per connetterti alla macchina host.
  2. Esegui questo comando:
    zypper info google-cloud-sql-server-agent

Riavvia l'agente

Se l'agente per SQL Server smette di funzionare o se aggiorni la relativa configurazione, riavvia l'agente.

Seleziona il tuo sistema operativo e segui i passaggi:

Windows

  1. Utilizza RDP per connetterti alla macchina host.
  2. In qualità di amministratore, esegui il seguente comando da PowerShell:
    Restart-Service -Name 'google-cloud-sql-server-agent' -Force

Linux

  1. Utilizza SSH per connetterti alla macchina host.
  2. Esegui questo comando:
    sudo systemctl restart google-cloud-sql-server-agent

Aggiorna l'agente

Per assicurarti di avere la versione più recente dell'agente, devi controllare periodicamente la disponibilità di aggiornamenti e aggiornare l'agente.

Cerca aggiornamenti

Seleziona il tuo sistema operativo e segui i passaggi:

Windows

  1. Utilizza RDP per connetterti alla macchina host.
  2. In qualità di amministratore, esegui il seguente comando da PowerShell:
    googet latest google-cloud-sql-server-agent

RHEL

  1. Utilizza SSH per connetterti alla macchina host.
  2. Esegui questo comando:
    sudo yum check-update google-cloud-sql-server-agent

SLES

  1. Utilizza SSH per connetterti alla macchina host.
  2. Esegui questo comando:
    sudo zypper list-updates -r google-cloud-sql-server-agent

Installare un aggiornamento

Seleziona il tuo sistema operativo e segui i passaggi:

Windows

  1. Utilizza RDP per connetterti alla macchina host.
  2. In qualità di amministratore, esegui il seguente comando da PowerShell:
    googet install google-cloud-sql-server-agent

RHEL

  1. Utilizza SSH per connetterti alla macchina host.
  2. Esegui questo comando:
    sudo yum --nogpgcheck update google-cloud-sql-server-agent

SLES

  1. Utilizza SSH per connetterti alla macchina host.
  2. Esegui questo comando:
    sudo zypper --no-gpg-checks update google-cloud-sql-server-agent

Visualizza i log dell'agente in Cloud Logging

Per impostazione predefinita, i log di Agent for SQL Server vengono reindirizzati dalle istanze VM a Cloud Logging.

Per visualizzare i log dell'agente in Log:

  1. Nella console Google Cloud, vai alla pagina Esplora log.

    Vai a Esplora log

  2. Vai al riquadro Query.

  3. Nel menu a discesa Risorse, seleziona Globale e poi fai clic su Applica.

  4. Nell'editor di query, inserisci google-cloud-sql-server-agent.

  5. Fai clic su Esegui query.

    Dovresti vedere i log generati dalle istanze dell'agente in esecuzione su tutte le istanze VM. Per filtrare i log di una macchina specifica, utilizza i filtri disponibili nell'interfaccia.

Disattivare i log dell'agente in Cloud Logging

Per disattivare il reindirizzamento predefinito dei log dell'agente a Cloud Logging, segui questi passaggi:

  1. Stabilisci una connessione RDP o SSH con l'istanza VM host.

  2. Apri il file di configurazione dell'agente:

    Windows

    %ProgramFiles%\Google\google-cloud-sql-server-agent\configuration.json

    Linux

    /etc/google-cloud-sql-server-agent/configuration.json

  3. Per la proprietà log_to_cloud, aggiorna il valore su false.

  4. Salva il file di configurazione.

  5. Riavvia l'agente per applicare la modifica.

Risoluzione dei problemi

Le sezioni seguenti forniscono informazioni sui problemi comuni relativi all'utilizzo di Agent for SQL Server, sulle relative cause e sulla loro risoluzione.

Ambiti di autenticazione insufficienti

Problema: se limiti gli ambiti di accesso nell'istanza VM host, i log di Agent for SQL Server potrebbero mostrare un errore di autorizzazioni IAM insufficienti.

  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

Causa: l'agente per SQL Server richiede ambiti di accesso minimi all'API Cloud nell'istanza VM host.

Soluzione:per risolvere il problema, attiva i campi di accesso richiesti

Impossibile caricare il file di configurazione

Problema: se il file di configurazione contiene valori non validi, viene visualizzato il seguente errore.

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

Risoluzione: per risolvere il problema, aggiorna il file di configurazione utilizzando i dettagli in Proprietà di configurazione

Impossibile inizializzare la raccolta dei dati

Problema: dopo aver installato l'agente, se il file di configurazione non viene aggiornato, viene visualizzato il seguente errore:

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

Risoluzione: per risolvere il problema, inizializza la configurazione delle credenziali utilizzando le proprietà di configurazione.

Passaggi successivi