Instalar & configurar o NRDOT para MSSQL no Windows auto-hospedado: autenticação de domínio

Configure o monitoramento do Microsoft SQL Server usando o NRDOT Collector em ambientes auto-hospedados do Windows, incluindo servidores físicos, máquinas virtuais e instalações autônomas do Windows, usando a autenticação de domínio do Windows. Para monitorar em um ambiente Windows RDS, consulte a instrumentação do Windows RDS.

Instalação guiada

Para instalar isso pela interface da New Relic, acesse one.newrelic.com > Integrations & Agents > Microsoft SQL Server (Database 360) . Siga as instruções na tela para configurar a integração. Esta página aborda apenas a instalação manual.

Esta página aborda a autenticação de domínio do Windows. Se o seu ambiente usa um método de autenticação diferente, consulte Autenticação do SQL Server ou gMSA.

Pré-requisitos

Antes de monitorar seu Microsoft SQL Server com NRDOT usando a Autenticação do Windows, 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 de domínio Windows com Active Directory.
SQL Server configurado para aceitar a Autenticação do Windows.
Uma conta de usuário de domínio com as permissões apropriadas do SQL Server.

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

Certifique-se de que seu SQL Server esteja configurado para Autenticação do Windows e verifique a conectividade.

Recupere o seu nome de usuário do Windows:

SELECT SYSTEM_USER;

Execute o seguinte comando para verificar se as permissões necessárias foram concedidas ao seu usuário do Windows. Substitua todas as ocorrências de <ACCOUNT_USERNAME> pelo nome de usuário recuperado da etapa 1:

DECLARE @TargetUser SYSNAME = '<ACCOUNT_USERNAME>'; -- <-- Set your Windows user here

           -- 1. Create the checklist of required permissions from your script
           DECLARE @Checklist TABLE (Scope NVARCHAR(50), [Database] SYSNAME, [Permission] NVARCHAR(128));

           INSERT INTO @Checklist VALUES
           ('Server', 'ALL', 'VIEW SERVER STATE'),
           ('Server', 'ALL', 'VIEW ANY DEFINITION'),
           ('Server', 'ALL', 'VIEW ANY DATABASE');

           INSERT INTO @Checklist
           SELECT 'Database Role', [name], 'db_datareader' FROM sys.databases WHERE [name] NOT IN ('master', 'msdb', 'model', 'rdsadmin', 'distribution') AND [state] = 0
           UNION ALL
           SELECT 'Database Explicit', [name], 'VIEW DATABASE STATE' FROM sys.databases WHERE [name] NOT IN ('master', 'msdb', 'model', 'rdsadmin', 'distribution') AND [state] = 0
           UNION ALL
           SELECT 'Database Explicit', [name], 'VIEW DEFINITION' FROM sys.databases WHERE [name] NOT IN ('master', 'msdb', 'model', 'rdsadmin', 'distribution') AND [state] = 0;

           -- 2. Gather existing explicit permissions
           WITH ExplicitPerms AS (
               SELECT 'Server' AS Scope, CAST('ALL' AS NVARCHAR(128)) COLLATE DATABASE_DEFAULT AS [Database], p.permission_name COLLATE DATABASE_DEFAULT AS [Permission]
               FROM sys.server_permissions p JOIN sys.server_principals l ON p.grantee_principal_id = l.principal_id WHERE l.name = @TargetUser
               UNION ALL
               SELECT 'Database Role', d.name COLLATE DATABASE_DEFAULT, r.name COLLATE DATABASE_DEFAULT
               FROM sys.databases d CROSS APPLY (SELECT dp_role.name FROM sys.database_role_members drm JOIN sys.database_principals dp_role ON drm.role_principal_id = dp_role.principal_id JOIN sys.database_principals dp_user ON drm.member_principal_id = dp_user.principal_id JOIN sys.server_principals sp ON dp_user.sid = sp.sid WHERE sp.name = @TargetUser) r WHERE d.state = 0
               UNION ALL
               SELECT 'Database Explicit', d.name COLLATE DATABASE_DEFAULT, p.permission_name COLLATE DATABASE_DEFAULT
               FROM sys.databases d CROSS APPLY (SELECT db_p.permission_name FROM sys.database_permissions db_p JOIN sys.database_principals dp_user ON db_p.grantee_principal_id = dp_user.principal_id JOIN sys.server_principals sp ON dp_user.sid = sp.sid WHERE sp.name = @TargetUser) p WHERE d.state = 0
           )
           -- 3. Output the exact verification matrix
           SELECT
               chk.Scope,
               chk.[Database],
               chk.[Permission] AS [Required Permission],
               CASE
                   WHEN exp.[Permission] IS NOT NULL THEN 'GRANTED'
                   WHEN IS_SRVROLEMEMBER('sysadmin', @TargetUser) = 1 THEN 'PASSED (via SysAdmin Role)'
                   ELSE 'MISSING'
               END AS [Verification Status]
           FROM @Checklist chk
           LEFT JOIN ExplicitPerms exp ON chk.Scope = exp.Scope AND chk.[Database] = exp.[Database] AND chk.[Permission] = exp.[Permission]
           ORDER BY chk.Scope, chk.[Database], chk.[Permission];

(Opcional) Se você não tiver as permissões necessárias, no seu SSMS ou utilitário sqlcmd, execute o seguinte comando para conceder as permissões necessárias à sua conta do Windows. Substitua todas as ocorrências de <ACCOUNT_USERNAME> pelo seu nome de usuário do Windows recuperado na etapa 1:

USE [master];
           GO

           -- 1. Grant Instance-level permissions to your Windows Account
           GRANT VIEW SERVER STATE TO [<ACCOUNT_USERNAME>];
           GRANT VIEW ANY DEFINITION TO [<ACCOUNT_USERNAME>];
           GRANT VIEW ANY DATABASE TO [<ACCOUNT_USERNAME>];
           GO

           -- 2. Loop through all user databases and grant read/visibility permissions
           DECLARE @name SYSNAME;
           DECLARE @sql NVARCHAR(MAX);

           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; -- Only online databases

           OPEN db_cursor;
           FETCH NEXT FROM db_cursor INTO @name;

           WHILE @@FETCH_STATUS = 0
           BEGIN
               BEGIN TRY
                   PRINT 'Granting permissions on database: ' + @name;

                   -- Create the database user mapping if it doesn't exist, then grant roles
                   SET @sql = '
                       USE [' + @name + '];
                       IF NOT EXISTS (SELECT 1 FROM sys.database_principals WHERE name = ''<ACCOUNT_USERNAME>'')
                       BEGIN
                           CREATE USER [<ACCOUNT_USERNAME>] FOR LOGIN [<ACCOUNT_USERNAME>];
                       END;
                       GRANT VIEW DATABASE STATE TO [<ACCOUNT_USERNAME>];
                       GRANT VIEW DEFINITION TO [<ACCOUNT_USERNAME>];
                       ALTER ROLE db_datareader ADD MEMBER [<ACCOUNT_USERNAME>];';

                   EXEC sp_executesql @sql;
                   PRINT 'Success: ' + @name;
               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

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_DOMAIN_USER> pelo seu domínio e nome de conta reais.

USE [master];
        GO

        CREATE LOGIN [<YOUR_DOMAIN>\<YOUR_DOMAIN_USER>] FROM WINDOWS;
        GO

        GRANT VIEW ANY DATABASE   TO [<YOUR_DOMAIN>\<YOUR_DOMAIN_USER>];
        GRANT VIEW SERVER STATE TO [<YOUR_DOMAIN>\<YOUR_DOMAIN_USER>];
        GRANT VIEW ANY DEFINITION TO [<YOUR_DOMAIN>\<YOUR_DOMAIN_USER>];
        GO

        -- Grant access to all databases
        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_DOMAIN_USER>'')
            BEGIN
              CREATE USER [<YOUR_DOMAIN>\<YOUR_DOMAIN_USER>] FOR LOGIN [<YOUR_DOMAIN>\<YOUR_DOMAIN_USER>];
            END;
            GRANT VIEW DATABASE STATE TO [<YOUR_DOMAIN>\<YOUR_DOMAIN_USER>];');
          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

Configure o serviço NRDOT Collector para ser executado como seu usuário de domínio usando o PowerShell. Substitua YOUR_DOMAIN\YOUR_USER_ACCOUNT pelo seu domínio e nome de conta:

# Configure service to use domain account
           # The space after obj= and password= is required syntax for sc.exe
           sc.exe config "nrdot-collector" obj= "YOUR_DOMAIN\YOUR_USER_ACCOUNT" password= "<YOUR_PASSWORD>"

           # Restart the service
           Restart-Service nrdot-collector

Valide a identidade do serviço:

Get-WmiObject Win32_Service -Filter "Name='nrdot-collector'" | Select Name, State, StartName
           # Expected: StartName = YOUR_DOMAIN\YOUR_USER_ACCOUNT

Dica

Para gerenciar informações confidenciais com segurança, como credenciais de banco de dados, armazene-as em ferramentas de gerenciamento de segredos.

Configurar o NRDOT Collector

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

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
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 permanecem inalterados. 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. A conta configurada em Criar usuário de monitoramento já possui todas as 3 permissões.

Atualizar Registro de Serviço do Windows

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:

bash

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

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

bash

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

Dica

Para correlacionar o desempenho do seu aplicativo com as operações de banco de dados, você pode configurar a identificação de serviço de banco de dados. Para mais informações, consulte configurar a identificação de serviço de banco de dados.

Reiniciar o NRDOT Collector

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

bash

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

Dica

Sempre reinicie o serviço do NRDOT Collector após fazer alterações na configuração para garantir que as novas configurações entrem em vigor.

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:

Vá para https://one.newrelic.com > All Capabilities > Databases.
Na dropdown Entity type, selecione MSSQL instance e clique em Apply.
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

Configurar a correlação entre APM e banco de dados

Aprenda a correlacionar o desempenho do seu aplicativo com as operações de banco de dados no New Relic.

Resolução de problemas

Aprenda a solucionar problemas na sua configuração de monitoramento do MSSQL Windows no New Relic.

Referência de métricas

Saiba mais sobre as métricas disponíveis coletadas pelo NRDOT Collector.

Esta tradução de máquina é fornecida para sua comodidade.

Instalar & configurar o NRDOT para MSSQL no Windows auto-hospedado: autenticação de domínio

Instalação guiada

Pré-requisitos

Instalar o NRDOT Collector

Criar usuário de monitoramento

Collector no mesmo host do Windows

Collector em um host diferente do Windows

Dica

Configurar o NRDOT Collector

configuração completa

Dica

Atualizar Registro de Serviço do Windows

Dica

Reiniciar o NRDOT Collector

Dica

Encontre e use seus dados

Configurar a correlação entre APM e banco de dados

Resolução de problemas

Referência de métricas

Esta tradução de máquina é fornecida para sua comodidade.

Instalar & configurar o NRDOT para MSSQL no Windows auto-hospedado: autenticação de domínio

Instalação guiada

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

Instalar o NRDOT Collector

Criar usuário de monitoramento

Collector em um host diferente do Windows

Dica

Configurar o NRDOT Collector

configuração completa

Dica

Atualizar Registro de Serviço do Windows

Dica

Reiniciar o NRDOT Collector

Dica

Encontre e use seus dados

Documentação relacionada

Configurar a correlação entre APM e banco de dados

Resolução de problemas

Referência de métricas

Pré-requisitos