Instalar & configurar NRDOT para MSSQL no Windows auto-hospedado: autenticação gMSA

Pré-requisitos

Antes de monitorar seu Microsoft SQL Server com o NRDOT usando a Autenticação gMSA, certifique-se de que seu ambiente atenda a estes requisitos:

• Uma conta New Relic com uma chave de licença válida.

• Conectividade de rede para o endpoint OTLP da New Relic para sua região.

• Requisitos do SQL Server:

  • SQL Server 2017 ou posterior.
  • Acesso administrativo ao SQL Server (função sysadmin ou equivalente).
  • Conectividade de rede entre o coletor e o SQL Server na porta 1433 ou em uma porta personalizada.
  • SQL Server Management Studio (SSMS) ou o utilitário sqlcmd.

• Um ambiente do Active Directory com suporte a gMSA.

• Um host Windows ingressado no domínio e autorizado a usar a conta gMSA.

Instalar o NRDOT Collector

Baixe e instale o NRDOT Collector usando o PowerShell:

[Net.ServicePointManager]::SecurityProtocol = 'tls12, tls'
    $NRDOT_VERSION = (Invoke-RestMethod -Uri "https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest").tag_name
    $WebClient = New-Object System.Net.WebClient
    $WebClient.Headers.Add("User-Agent", "Mozilla/5.0")
    $WebClient.DownloadFile("https://github.com/newrelic/nrdot-collector-releases/releases/download/$NRDOT_VERSION/nrdot-collector_${NRDOT_VERSION}_windows_x64.msi", "$env:TEMP\nrdot-collector.msi")
    Start-Process msiexec.exe -ArgumentList "/i `"$env:TEMP\nrdot-collector.msi`" /qn /norestart /L*V `"$env:TEMP\nrdot_install.log`"" -Wait
    Get-Service nrdot-collector -ErrorAction SilentlyContinue

Criar usuário de monitoramento

No seu SQL Server Management Studio (SSMS), execute o seguinte script para criar um login para a sua conta gMSA e conceder as permissões necessárias. Substitua todas as ocorrências de <YOUR_DOMAIN>\<YOUR_GMSA_USERNAME> pelo seu domínio real e nome da conta gMSA.

USE [master];
    GO

    -- Provision an engine login identity for the gMSA
    CREATE LOGIN [<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$] FROM WINDOWS;
    GO

    -- Grant monitoring permissions
    GRANT VIEW SERVER STATE TO [<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$];
    GRANT VIEW ANY DEFINITION TO [<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$];
    GRANT VIEW ANY DATABASE TO [<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$];
    GO

    -- Grant access to all databases (required for query monitoring and tempdb metrics)
    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;
    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 = ''<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$'')
        BEGIN
          CREATE USER [<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$] FOR LOGIN [<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$];
        END;
        GRANT VIEW DATABASE STATE TO [<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$];');
      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

Executar como conta gMSA

Após instalar o NRDOT Collector, configure o serviço para ser executado como sua conta gMSA usando o PowerShell. Substitua YOUR_DOMAIN\YOUR_gMSA_ACCOUNT$ pelo seu domínio e nome da conta gMSA. Você deve incluir o $ no final, pois é necessário para contas gMSA.

# Stop the NRDOT Collector service
    Stop-Service nrdot-collector

    # Configure service to use gMSA account
    # Use cmd /c to avoid PowerShell treating $ as a variable
    cmd /c 'sc config nrdot-collector obj= "YOUR_DOMAIN\YOUR_gMSA_ACCOUNT$" password= ""'

    # Verify the configuration
    Get-WmiObject Win32_Service -Filter "Name='nrdot-collector'" | Select Name, StartName

    # Start the NRDOT Collector service
    Start-Service nrdot-collector

Configurar o NRDOT Collector

1. Crie um arquivo de configuração nomeado como mssql-config.yaml no PowerShell como administrador:

New-Item -Path "C:\Program Files\nrdot-collector\mssql-config.yaml" -ItemType File

2. Adicione a seguinte configuração ao arquivo mssql-config.yaml criado na etapa anterior:

   configuração completa

   Esta configuração tem como foco o monitoramento essencial de banco de dados para o seu ambiente Windows SQL Server. Para habilitar o monitoramento abrangente com todas as métricas disponíveis, consulte a referência de configuração.

   Nome do host/IP do SQL Server

   Insira o nome do host ou endereço IP do SQL Server

   Porta do SQL Server

   Insira o número da porta do SQL Server. O valor padrão é 1433.

   Endpoint New Relic OTLP com número da porta

   Insira o seu endpoint OTLP da New Relic. Para obter mais informações, consulte https://docs.newrelic.com/docs/opentelemetry/best-practices/opentelemetry-otlp/

   Chave de licença da New Relic

   Insira sua chave de licença de ingestão da New Relic

   mssql-config.yaml

   DownloadCopiar

   1
   receivers:
   2
   nrsqlserver:
   3
      collection_interval: 15s
   4
      datasource: "server=sqlserver.example.com;port=1433;integrated security=true;encrypt=true;TrustServerCertificate=true;"
   5
   
   6
      # Enable comprehensive database metrics
   7
      metrics:
   8
        sqlserver.database.count:
   9
          enabled: true
   10
        sqlserver.database.io:
   11
          enabled: true
   12
        sqlserver.database.latency:
   13
          enabled: true
   14
        sqlserver.database.operations:
   15
          enabled: true
   16
        sqlserver.database.tempdb.space:
   17
          enabled: true
   18
        sqlserver.database.tempdb.version_store.size:
   19
          enabled: true
   20
        sqlserver.deadlock.rate:
   21
          enabled: true
   22
        sqlserver.os.wait.duration:
   23
          enabled: true
   24
        sqlserver.processes.blocked:
   25
          enabled: true
   26
        sqlserver.memory.grants.pending.count:
   27
          enabled: true
   28
        sqlserver.database.file.size:
   29
          enabled: true
   30
        sqlserver.memory.area:
   31
          enabled: true
   32
   
   33
      # Enable query sample, top query, query plan, and top procedure log collection
   34
      events:
   35
        db.server.query_sample:
   36
          enabled: true
   37
        db.server.top_query:
   38
          enabled: true
   39
        db.server.query_plan:
   40
          enabled: true
   41
        db.server.top_procedure:
   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
        collect_full_query_text: true
   51
        allowed_comment_keys:
   52
          - nr_service_guid
   53
   
   54
      # Query sample collection configuration
   55
      query_sample_collection:
   56
        max_rows_per_query: 100
   57
        collect_full_query_text: true
   58
        allowed_comment_keys:
   59
          - nr_service_guid
   60
   
   61
      # Top stored procedure collection configuration
   62
      top_procedure_collection:
   63
        max_procedure_sample_count: 1000
   64
        top_procedure_count: 250
   65
        collection_interval: 60s
   66
   
   67
      resource_attributes:
   68
        db.system.version:
   69
          enabled: true
   70
        sqlserver.db.edition:
   71
          enabled: true
   72
   
   73
   processors:
   74
   memory_limiter:
   75
      check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
   76
      limit_mib:       ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
   77
      spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}
   78
   
   79
   exporters:
   80
   otlp:
   81
      endpoint: https://otlp.nr-data.net:4318
   82
      headers:
   83
        api-key: YOUR_LICENSE_KEY
   84
      tls:
   85
        insecure: false
   86
      compression: gzip
   87
   
   88
      sending_queue:
   89
        enabled: true
   90
        sizer: bytes
   91
        queue_size: 100_000_000
   92
        num_consumers: 10
   93
        batch:
   94
          sizer: bytes
   95
          max_size: 1_000_000
   96
          min_size: 0
   97
          flush_timeout: 5s
   98
   
   99
   service:
   100
   telemetry:
   101
      metrics:
   102
        level: none
   103
   
   104
   pipelines:
   105
      metrics:
   106
        receivers: [nrsqlserver]
   107
        processors: [memory_limiter]
   108
        exporters: [otlp]
   109
   
   110
      logs:
   111
        receivers: [nrsqlserver]
   112
        processors: [memory_limiter]
   113
        exporters: [otlp]

   Dica

   O pipeline logs não transporta logs de depuração do coletor ou logs internos do agente. Ele transmite a telemetria de consulta do SQL Server, incluindo texto da consulta, planos de execução e dados de amostra. O receptor nrsqlserver captura essa telemetria por meio dos eventos db.server.query_sample, db.server.top_query, db.server.query_plan e db.server.top_procedure emitidos como registros de log do OpenTelemetry.

   O evento db.server.top_procedure requer o SQL Server 2017 CU3 ou posterior, que introduziu suporte para sys.dm_exec_procedure_stats.total_spills. Em versões anteriores, esse evento não emite dados e registra um erro. Outros eventos não são afetados. O acesso a sys.dm_exec_procedure_stats requer VIEW SERVER STATE (ou VIEW SERVER PERFORMANCE STATE, dependendo da versão do SQL Server). Além disso, VIEW ANY DEFINITION é necessário para que OBJECT_NAME e OBJECT_SCHEMA_NAME sejam resolvidos corretamente em todos os bancos de dados de usuário, e CONNECT SQL é necessário para configurar as sessões iniciais. O login gMSA criado em Criar usuário de monitoramento já possui todas as 3 permissões.

Atualizar Registro de Serviço do Windows

1. Atualize o Registro de Serviço do Windows para usar o novo arquivo mssql-config.yaml usando um dos seguintes métodos:

   • Para PowerShell: execute o seguinte comando como administrador:

Set-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Services\nrdot-collector" -Name "ImagePath" -Value '"C:\Program Files\nrdot-collector\nrdot-collector.exe" --config "C:\Program Files\nrdot-collector\mssql-config.yaml"'

• Para prompt de comando: se o PowerShell não estiver disponível, use o prompt de comando e execute o seguinte comando como administrador:

$
sc config "nrdot-collector" binPath= "\"C:\Program Files\nrdot-collector\nrdot-collector.exe\" --config \"C:\Program Files\nrdot-collector\mssql-config.yaml\""

2. Valide a configuração do Collector NRDOT para garantir que esteja formatada corretamente e funcione adequadamente:

$
& "C:\Program Files\nrdot-collector\nrdot-collector.exe" validate --config="C:\Program Files\nrdot-collector\mssql-config.yaml"

Reiniciar o NRDOT Collector

Após atualizar sua configuração, reinicie o serviço NRDOT Collector:

$
net stop nrdot-collector
$
    net start nrdot-collector

Encontre e use seus dados

Assim que seus dados estiverem sendo coletados, você poderá acessar o monitoramento abrangente do banco de dados SQL Server por meio da interface do New Relic.

Para encontrar sua entidade de banco de dados SQL Server no New Relic:

1. Vá para https://one.newrelic.com > All Capabilities > Databases.

2. Na dropdown Entity type, selecione MSSQL instance e clique em Apply.

3. Selecione seu banco de dados SQL Server na lista de entidades.

   Após configurar o monitoramento do SQL Server com o NRDOT, você pode:

   • Crie dashboards personalizados para visualizar suas métricas de banco de dados
   • Configure alertas para limites críticos de desempenho do banco de dados
   • Explore seus dados usando os recursos de consulta do New Relic