グループ管理サービスアカウント(gMSA)を使用して、AWS RDS for SQL Serverインスタンスをモニターするために、Windows環境でNRDOT Collectorを使用してMicrosoft SQL Serverの監視を設定します。セルフホスト環境でモニターするには、Windowsセルフホスト計装を参照してください。
代わりにNew Relic UIからこれをインストールするには、one.newrelic.com > Integrations & Agents > MSSQL (OpenTelemetry) に移動してください。画面上の指示に従って、インテグレーションをセットアップします。このページでは、手動インストレーションについてのみ説明します。
このページでは、gMSA認証について説明します。お使いの環境で別の認証方法を使用している場合は、SQL Server認証またはWindowsドメイン認証をご覧ください。
前提条件
gMSA認証を使用して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インスタンス。
RDS SQL ServerのエンドポイントURL。AWS RDSコンソールの「Connectivity & security」で確認できます。詳細については、AWS RDSのドキュメントを参照してください。
gMSAをサポートするActive Directory環境。
gMSAアカウントの使用を許可された、ドメインに参加しているWindows EC2インスタンス。
NRDOT Collectorをインストールする
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監視ユーザーを作成する
管理者権限を持つSQL Server Management Studio(SSMS)またはsqlcmdを使用して、RDS SQL Serverインスタンスに接続します。
SQL Server Management Studio(SSMS)で次のスクリプトを実行し、gMSAアカウントのログインを作成して、必要な権限を付与します。<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>のすべての出現箇所を、実際のドメインとアカウント名に置き換えます。
USE [master];GO
CREATE LOGIN [<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$] FROM WINDOWS;GO
GRANT VIEW ANY DATABASE TO [<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$];GRANT VIEW SERVER STATE TO [<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$];GRANT VIEW ANY DEFINITION TO [<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$];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 = 0BEGIN 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;ENDCLOSE db_cursor;DEALLOCATE db_cursor;GOヒント
データベースの認証情報などの機密情報を安全に管理するには、シークレット管理ツールに保存してください。
gMSAアカウントとして実行する
PowerShellを使用して、gMSAアカウントとして実行するようにNRDOT Collectorサービスを設定します。<YOUR_DOMAIN>\<YOUR_GMSA_USERNAME>$をドメインとgMSAアカウント名に置き換えます。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_USERNAME>$" password= ""'$
$# Verify the configuration$Get-WmiObject Win32_Service -Filter "Name='nrdot-collector'" | Select Name, StartName$
$# Start the NRDOT Collector service $Start-Service nrdot-collector重要
gMSAアカウントはパスワードを必要としません。サービスを設定する際は、空のままにしてください。
NRDOT Collectorを構成する
アドミニストレーターとしてPowerShellで
mssql-config.yamlという名前の設定ファイルを作成してください:bash$New-Item -Path "C:\Program Files\nrdot-collector\mssql-config.yaml" -ItemType File前の手順で作成した
mssql-config.yamlファイルに以下の設定を追加します:完全な設定
この設定は、RDS環境の基本的なデータベース監視に焦点を当てています。利用可能なすべてのメトリクスを使用して包括的な監視を有効にするには、設定リファレンスを参照してください。
mssql-config.yaml1receivers:2nrsqlserver:3collection_interval: 15s4datasource: "server=mydb-instance.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com;port=1433;integrated security=true;encrypt=true;TrustServerCertificate=true;"56# Enable comprehensive database metrics7metrics:8sqlserver.database.count:9enabled: true10sqlserver.database.io:11enabled: true12sqlserver.database.latency:13enabled: true14sqlserver.database.operations:15enabled: true16sqlserver.database.tempdb.space:17enabled: true18sqlserver.database.tempdb.version_store.size:19enabled: true20sqlserver.deadlock.rate:21enabled: true22sqlserver.os.wait.duration:23enabled: true24sqlserver.processes.blocked:25enabled: true26sqlserver.memory.grants.pending.count:27enabled: true28sqlserver.database.file.size:29enabled: true30sqlserver.memory.area:31enabled: true3233# Enable query sample, top query, query plan, and top procedure log collection34events:35db.server.query_sample:36enabled: true37db.server.top_query:38enabled: true39db.server.query_plan:40enabled: true41db.server.top_procedure:42enabled: true4344# Top query collection configuration45top_query_collection:46lookback_time: 60s47max_query_sample_count: 100048top_query_count: 25049collection_interval: 60s50collect_full_query_text: true51allowed_comment_keys:52- nr_service_guid5354# Query sample collection configuration55query_sample_collection:56max_rows_per_query: 10057collect_full_query_text: true58allowed_comment_keys:59- nr_service_guid6061# Top stored procedure collection configuration62top_procedure_collection:63max_procedure_sample_count: 100064top_procedure_count: 25065collection_interval: 60s6667resource_attributes:68db.system.version:69enabled: true70sqlserver.db.edition:71enabled: true7273processors:74memory_limiter:75check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}76limit_mib: ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}77spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}7879exporters:80otlp:81endpoint: https://otlp.nr-data.net:431882headers:83api-key: YOUR_LICENSE_KEY84tls:85insecure: false86compression: gzip8788sending_queue:89enabled: true90sizer: bytes91queue_size: 100_000_00092num_consumers: 1093batch:94sizer: bytes95max_size: 1_000_00096min_size: 097flush_timeout: 5s9899service:100telemetry:101metrics:102level: none103104pipelines:105metrics:106receivers: [nrsqlserver]107processors: [memory_limiter]108exporters: [otlp]109110logs:111receivers: [nrsqlserver]112processors: [memory_limiter]113exporters: [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が必要です。監視ユーザーの作成で作成された gMSA ログインは、すでに3つの権限すべてを持っています。
Windowsサービスレジストリの更新
次のいずれかの方法を使用して、新しい
mssql-config.yamlファイルを使用するようにWindowsサービスレジストリを更新します:PowerShellの場合:アドミニストレーターとして次のコマンドを実行します:
bash$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\""NRDOT Collectorの設定を検証して、正しくフォーマットされ、適切に機能することを確認します:
bash$& "C:\Program Files\nrdot-collector\nrdot-collector.exe" validate --config="C:\Program Files\nrdot-collector\mssql-config.yaml"ヒント
アプリケーションパフォーマンスをデータベース操作と関連付けるには、データベースサービス識別を設定できます。詳細については、データベースサービス識別の設定を参照してください。
NRDOT Collectorを再起動します
設定を更新した後、ドメインに参加しているEC2 WindowsインスタンスでNRDOT Collectorサービスを再起動します:
$net stop nrdot-collector$net start nrdot-collectorWindowsサービス(services.msc)を確認して、サービスがgMSAアカウントで実行されていることを検証します。Log On As列には、gMSAアカウント(たとえばCORP\SQL-gMSA$)が表示されます。
データを探す、使う
データの収集が開始されると、New Relic UIを通じて包括的なSQL Serverデータベース監視にアクセスできます。
New Relic で SQL Server データベース エンティティを見つけるには:
https://one.newrelic.com > All Capabilities > Databasesに移動します。
Entity typeドロップダウンからMSSQL instanceを選択し、Applyをクリックします。
エンティティのリストから SQL Server データベースを選択します。
NRDOTを使用してSQL Serverの監視をセットアップした後、次のことができます:
- データベースのメトリクスを視覚化するカスタムダッシュボードを作成する
- クリティカルデータベースパフォーマンス閾値のアラートを設定する
- New Relicのクエリ機能を使用して、データを探索します