Windows RDSでのMSSQL用NRDOTのインストールと設定：ドメイン認証

前提条件

Windowsドメイン認証を使用してNRDOTでMicrosoft SQL Serverを監視する前に、環境が以下の要件を満たしていることを確認してください：

• 有効なライセンスキーを持つNew Relicアカウント。

• ご利用のリージョンのNew Relic OTLPエンドポイントへのネットワーク接続。

• SQL Serverの要件：

  • Amazon RDS上のSQL Server 2017以降。
  • RDSマスターユーザーの認証情報、またはrds_superuserロールを持つSQL Serverログインの認証情報。
  • ポート1433またはカスタムポートでの接続を許可するように構成されたRDSセキュリティグループ。
  • SQL Server Management Studio（SSMS）または sqlcmd ユーティリティ。
  • AWS Active Directoryサービスに関連付けられたRDSインスタンス。

• Windowsドメイン認証の要件：

  • Active Directory を備えた Windows ドメイン環境。
  • ドメインに参加しているWindows EC2インスタンス。
  • Windows認証を受け付けるように設定されたRDS SQL Server。
  • NRDOT Collectorが使用するドメインユーザーアカウント。

• RDS SQL ServerのエンドポイントURL。AWS RDSコンソールの「Connectivity & security」で確認できます。詳細については、AWS RDSのドキュメントを参照してください。

NRDOT Collectorをインストールする

ドメインに参加しているEC2 Windowsインスタンス、または同じドメインに属し、RDS SQL Serverインスタンスに接続できるローカルのWindowsマシンに、NRDOT Collectorをインストールします。

1. PowerShellを使用してNRDOT Collectorをダウンロードし、インストールします：

   [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

   コピー

Windowsドメインログインの作成

管理者権限を持つSQL Server Management Studio（SSMS）またはsqlcmdを使用して、RDS SQL Serverインスタンスに接続します。

SQL Server Management Studio（SSMS）で次のスクリプトを実行し、gMSAアカウントのログインを作成して、必要な権限を付与します。<YOUR_DOMAIN>\<YOUR_DOMAIN_USER>のすべての出現箇所を、実際のドメインとアカウント名に置き換えます。

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

ドメインユーザーとして実行

1. PowerShellを使用して、ドメインユーザーとして実行するようにNRDOT Collectorサービスを設定します。YOUR_DOMAIN\YOUR_USER_ACCOUNTをドメインとアカウント名に置き換えます：

   # 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

   コピー

2. サービスIDを検証します：

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

   コピー

NRDOT Collectorを構成する

1. アドミニストレーターとしてPowerShellでmssql-config.yamlという名前の設定ファイルを作成してください：

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

   コピー

2. 前の手順で作成したmssql-config.yamlファイルに以下の設定を追加します：

   重要

   Windowsドメイン認証は統合セキュリティを使用しており、gMSA認証と同じ設定アプローチを使用します。datasourceサーバーの値をRDSエンドポイントに更新してください。NRDOTサービスは、「Windowsドメインログインの作成」で設定したドメインアカウントを使用して認証します。

   完全な設定

   この設定は、RDS環境における必須のデータベース監視に重点を置いています。利用可能なすべてのメトリクスを使用した包括的な監視を有効にするには、設定リファレンスを参照してください。

   RDSエンドポイント

   RDS SQL Serverエンドポイントを入力します

   RDSポート

   RDS SQL Serverのポート番号を入力します。デフォルト値は1433です。

   ポート番号付きNew Relic OTLPエンドポイント

   New Relic OTLPエンドポイントを入力します。詳細については、https://docs.newrelic.com/docs/opentelemetry/best-practices/opentelemetry-otlp/ を参照してください。

   New Relicライセンスキー

   New Relicライセンスキーを入力してください。

   mssql-config.yaml

   Downloadコピー

   1
   receivers:
   2
   nrsqlserver:
   3
      collection_interval: 15s
   4
      datasource: "server=mydb-instance.xxxxxxxxxxxx.us-east-1.rds.amazonaws.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]

   ヒント

   logsパイプラインは、コレクターのデバッグログや内部エージェントのログを転送しません。クエリテキスト、実行プラン、およびサンプルデータを含む、SQL Serverのクエリテレメトリーを送信します。nrsqlserverレシーバーは、OpenTelemetryのログレコードとして出力されるdb.server.query_sample、db.server.top_query、db.server.query_plan、およびdb.server.top_procedureイベントを通じて、このテレメトリーをキャプチャします。

   db.server.top_procedure イベントには、sys.dm_exec_procedure_stats.total_spills のサポートが導入された SQL Server 2017 CU3 以降が必要です。以前のバージョンでは、このイベントはデータを出力せず、エラーをログに記録します。他のイベントは影響を受けません。sys.dm_exec_procedure_stats にアクセスするには、VIEW SERVER STATE（または SQL Server のバージョンによっては VIEW SERVER PERFORMANCE STATE）が必要です。さらに、すべてのユーザーデータベースで OBJECT_NAME と OBJECT_SCHEMA_NAME を正しく解決するには VIEW ANY DEFINITION が必要であり、初期セッションを設定するには CONNECT SQL が必要です。Windowsドメインログインの作成で設定したアカウントは、すでに3つの権限をすべて持っています。

Windowsサービスレジストリの更新

1. 次のいずれかの方法を使用して、新しいmssql-config.yamlファイルを使用するようにWindowsサービスレジストリを更新します：

   • PowerShellの場合：アドミニストレーターとして次のコマンドを実行します：

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

     コピー

   • コマンドプロンプトの場合：PowerShellが利用できない場合は、代わりにコマンドプロンプトを使用し、アドミニストレーターとして次のコマンドを実行します：

   bash

   コピー

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

2. NRDOT Collectorの設定を検証して、正しくフォーマットされ、適切に機能することを確認します：

   bash

   コピー

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

   ヒント

   アプリケーションパフォーマンスをデータベース操作と関連付けるには、データベースサービス識別を設定できます。詳細については、データベースサービス識別設定ガイドを参照してください。

NRDOT Collectorを再起動します

設定を更新した後、NRDOT Collectorサービスを再起動します：

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

Windowsサービス（services.msc）をチェックして、サービスがドメインアカウントで実行されていることを確認してください。Log On As列にドメインアカウントが表示されるはずです。例：CORP\SQLMonitor。

データを探す、使う

データの収集が開始されると、New Relic UIを通じて包括的なSQL Serverデータベース監視にアクセスできます。

New Relic で SQL Server データベース エンティティを見つけるには:

1. https://one.newrelic.com > All Capabilities > Databasesに移動します。

2. Entity typeドロップダウンからMSSQL instanceを選択し、Applyをクリックします。

3. エンティティのリストから SQL Server データベースを選択します。

   NRDOTを使用してSQL Serverの監視をセットアップした後、次のことができます：

   • データベースのメトリクスを視覚化するカスタムダッシュボードを作成する
   • クリティカルデータベースパフォーマンス閾値のアラートを設定する
   • New Relicのクエリ機能を使用して、データを探索します