Instalar y configurar NRDOT para MSSQL en Windows autohospedado: autenticación de dominio

Requisitos previos

Antes de monitorear Microsoft SQL Server con NRDOT usando la autenticación de Windows, asegúrese de que el entorno cumpla con estos requisitos:

• Una cuenta de New Relic con una clave de licencia válida.

• Conectividad de red al extremo OTLP de New Relic para su región.

• Requisitos de SQL Server:

  • SQL Server 2017 o posterior.
  • Acceso administrativo a SQL Server (rol sysadmin o equivalente).
  • Conectividad de red entre el recolector y SQL Server en el puerto 1433 o un puerto personalizado.
  • SQL Server Management Studio (SSMS) o la utilidad sqlcmd.

• Un entorno de dominio de Windows con Active Directory.

• SQL Server configurado para aceptar la autenticación de Windows.

• Una cuenta de usuario de dominio con los permisos apropiados de SQL Server.

Instalar NRDOT Collector

Descarga e instala el NRDOT Collector usando 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

Crear usuario de monitoreo

Asegúrese de que su SQL Server esté configurado para la autenticación de Windows y verifique la conectividad.

SELECT SYSTEM_USER;

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];

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

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

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

Configurar el Colector NRDOT

1. Cree un archivo de configuración llamado mssql-config.yaml en PowerShell como administrador:

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

2. Agregue la siguiente configuración al archivo mssql-config.yaml creado en el paso anterior:

   configuración completa

   Esta configuración se centra en el monitoreo esencial de la base de datos para el entorno de Windows SQL Server. Para habilitar el monitoreo integral con todas las métricas disponibles, consulte la referencia de configuración.

   Nombre de host/IP de SQL Server

   Ingrese el nombre de host o la dirección IP de SQL Server

   Puerto de SQL Server

   Ingrese el número de puerto de SQL Server. El valor predeterminado es 1433.

   Extremo OTLP de New Relic con número de puerto

   Ingrese el extremo OTLP de New Relic. Para obtener más información, consulte https://docs.newrelic.com/docs/opentelemetry/best-practices/opentelemetry-otlp/

   Clave de licencia de New Relic

   Ingrese la clave de licencia de ingesta de New Relic

   mssql-config.yaml

   DownloadCopia

   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]

   Sugerencia

   El pipeline logs no transporta registros de depuración del recolector ni logs internos del agente. Transmite telemetría de consultas de SQL Server, incluido el texto de la consulta, los planes de ejecución y los datos de muestra. El receptor nrsqlserver captura esta telemetría a través de los eventos db.server.query_sample, db.server.top_query, db.server.query_plan y db.server.top_procedure emitidos como registros de log de OpenTelemetry.

   El evento db.server.top_procedure requiere SQL Server 2017 CU3 o posterior, que introdujo la compatibilidad con sys.dm_exec_procedure_stats.total_spills. En versiones anteriores, este evento no emite datos y registra un error. Otros eventos no se ven afectados. El acceso a sys.dm_exec_procedure_stats requiere VIEW SERVER STATE (o VIEW SERVER PERFORMANCE STATE, según la versión de SQL Server). Además, se requiere VIEW ANY DEFINITION para que OBJECT_NAME y OBJECT_SCHEMA_NAME se resuelvan correctamente en todas las bases de datos de usuario, y se necesita CONNECT SQL para configurar las sesiones iniciales. La cuenta que configuró en Crear usuario de monitoreo ya tiene los 3 permisos.

Actualizar el registro del servicio de Windows

1. Actualice el registro de servicios de Windows para usar el nuevo archivo mssql-config.yaml mediante uno de los siguientes métodos:

   • Para PowerShell: ejecute el siguiente 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 el símbolo del sistema: si PowerShell no está disponible, use el símbolo del sistema en su lugar y ejecute el siguiente 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 la configuración del NRDOT Collector para asegurarse de que tenga el formato correcto y funcione correctamente:

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

Reiniciar NRDOT Collector

Después de actualizar su configuración, reinicie el servicio NRDOT Collector:

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

Encuentra y utiliza tus datos

Una vez que sus datos se estén recopilando, puede acceder al monitoreo integral de bases de datos SQL Server a través de la UI de New Relic.

Para encontrar su entidad de base de datos SQL Server en New Relic:

1. Vaya a https://one.newrelic.com > All Capabilities > Databases.

2. En el menú desplegable Entity type, seleccione MSSQL instance y luego haga clic en Apply.

3. Seleccione su base de datos SQL Server de la lista de entidades.

   Después de configurar el monitoreo de SQL Server con NRDOT, puede:

   • Crea dashboards personalizados para visualizar las métricas de tu base de datos
   • Configura alertas para umbrales críticos de rendimiento de la base de datos
   • Explore los datos con las capacidades de consulta de New Relic