Windows RDS上のMSSQL向けNRDOTのインストールと設定：SQL認証

SQL Server認証を使用してAWS RDS for SQL Serverインスタンスをモニターするために、Windows環境でNRDOT Collectorを使用してMicrosoft SQL Serverの監視をセットアップしてください。セルフホスト環境でモニターするには、Windowsセルフホストの計装を参照してください。

ガイド付きインストレーション

代わりにNew Relic UIからこれをインストールするには、one.newrelic.com > Integrations & Agents > Microsoft SQL Server (Database 360) に移動してください。画面上の指示に従って、インテグレーションをセットアップします。このページでは、手動インストレーションについてのみ説明します。

このページでは、SQL Server認証について説明します。環境で異なる認証方法を使用している場合は、Windowsドメイン認証またはgMSAをご覧ください。

前提条件

NRDOTを使用してMicrosoft SQL Serverを監視する前に、環境がこれらの要件を満たしていることを確認します：

有効なライセンスキーを持つNew Relicアカウント。
ご利用のリージョンのNew Relic OTLPエンドポイントへのネットワーク接続。
AWS RDS SQL Serverの要件：
- RDS インスタンスで SQL Server 認証が有効になっています。
- RDSマスターユーザーの認証情報、またはrds_superuserロールを持つSQL Serverログインの認証情報。
- ポート1433またはカスタムポートでの接続を許可するように構成されたRDSセキュリティグループ。
- SQL Server Management Studio（SSMS）または sqlcmd ユーティリティ。
RDS SQL ServerのエンドポイントURL。AWS RDSコンソールの「Connectivity & security」で確認できます。詳細については、AWS RDSのドキュメントを参照してください。

NRDOT Collectorをインストールする

RDS SQL Serverインスタンスに接続できるEC2 Windowsインスタンス、またはローカルのWindowsマシンにNRDOT Collectorをインストールしてください。

重要

RDS監視の場合、最適なネットワーク接続と低レイテンシを実現するために、RDSインスタンスと同じVPC内の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

監視ユーザーを作成する

このスクリプトをアドミンユーザーとして実行して、newrelic監視ユーザーを作成し、SQL Serverのメトリクスを収集するために必要な権限を付与してください。

ヒント

RDSマスターユーザー名、またはrds_superuserロールを持つユーザーを使用して、このスクリプトを実行してください。このスクリプトは、AWSによって予約されているrdsadminデータベースを自動的に除外します。

SQL Server Management Studio（SSMS）で、次のスクリプトを実行してnewrelic監視ユーザーを作成します。<YOUR_PASSWORD>を希望するパスワードに置き換えます：

USE [master];
GO
CREATE LOGIN [newrelic] WITH PASSWORD = '<YOUR_PASSWORD>';
GO

GRANT VIEW SERVER STATE TO [newrelic];
GRANT VIEW ANY DEFINITION TO [newrelic];
GRANT VIEW ANY DATABASE TO [newrelic];
GO

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 = ''newrelic'')
    BEGIN
      CREATE USER [newrelic] FOR LOGIN [newrelic];
    END;
    GRANT VIEW DATABASE STATE TO [newrelic];');
  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

ヒント

データベースの認証情報などの機密情報を安全に管理するには、シークレット管理ツールに保存してください。

NRDOT Collectorを構成する

RDS SQL Serverのセットアップ用に、新しいNRDOT Collector設定ファイルを作成します。

アドミニストレーターとしてPowerShellでmssql-config.yamlという名前の設定ファイルを作成してください：
```
New-Item -Path "C:\Program Files\nrdot-collector\mssql-config.yaml" -ItemType File
```
前の手順で作成したmssql-config.yamlファイルに以下の設定を追加します：

完全な設定

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

SQL Serverユーザー名

SQL Serverのパスワード

RDSエンドポイント

サーバーポート

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

New Relicライセンスキー

mssql-config.yaml

1
receivers:
2
nrsqlserver:
3
   collection_interval: 15s
4
   username: newrelic
5
   password: YOUR_PASSWORD
6
   server: mydb-instance.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com
7
   port: 1433
8

9
   # Enable comprehensive database metrics
10
   metrics:
11
     sqlserver.database.count:
12
       enabled: true
13
     sqlserver.database.io:
14
       enabled: true
15
     sqlserver.database.latency:
16
       enabled: true
17
     sqlserver.database.operations:
18
       enabled: true
19
     sqlserver.database.tempdb.space:
20
       enabled: true
21
     sqlserver.database.tempdb.version_store.size:
22
       enabled: true
23
     sqlserver.deadlock.rate:
24
       enabled: true
25
     sqlserver.os.wait.duration:
26
       enabled: true
27
     sqlserver.processes.blocked:
28
       enabled: true
29
     sqlserver.memory.grants.pending.count:
30
       enabled: true
31
     sqlserver.database.file.size:
32
       enabled: true
33
     sqlserver.memory.area:
34
       enabled: true
35

36
   # Enable query sample, top query, query plan, and top procedure log collection
37
   events:
38
     db.server.query_sample:
39
       enabled: true
40
     db.server.top_query:
41
       enabled: true
42
     db.server.query_plan:
43
       enabled: true
44
     db.server.top_procedure:
45
       enabled: true
46

47
   # Top query collection configuration
48
   top_query_collection:
49
     lookback_time: 60s
50
     max_query_sample_count: 1000
51
     top_query_count: 250
52
     collection_interval: 60s
53
     collect_full_query_text: true
54
     allowed_comment_keys:
55
       - nr_service_guid
56

57
   # Query sample collection configuration
58
   query_sample_collection:
59
     max_rows_per_query: 100
60
     collect_full_query_text: true
61
     allowed_comment_keys:
62
       - nr_service_guid
63

64
   # Top stored procedure collection configuration
65
   top_procedure_collection:
66
     max_procedure_sample_count: 1000
67
     top_procedure_count: 250
68
     collection_interval: 60s
69

70
   resource_attributes:
71
     db.system.version:
72
       enabled: true
73
     sqlserver.db.edition:
74
       enabled: true
75

76
processors:
77
memory_limiter:
78
   check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
79
   limit_mib:       ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
80
   spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}
81

82
exporters:
83
otlp:
84
   endpoint: https://otlp.nr-data.net:4318
85
   headers:
86
     api-key: YOUR_LICENSE_KEY
87
   tls:
88
     insecure: false
89
   compression: gzip
90

91
   sending_queue:
92
     enabled: true
93
     sizer: bytes
94
     queue_size: 100_000_000
95
     num_consumers: 10
96
     batch:
97
       sizer: bytes
98
       max_size: 1_000_000
99
       min_size: 0
100
       flush_timeout: 5s
101

102
service:
103
telemetry:
104
   metrics:
105
     level: none
106

107
pipelines:
108
   metrics:
109
     receivers: [nrsqlserver]
110
     processors: [memory_limiter]
111
     exporters: [otlp]
112

113
   logs:
114
     receivers: [nrsqlserver]
115
     processors: [memory_limiter]
116
     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 が必要です。監視ユーザーの作成で作成された監視ユーザーは、すでに3つの権限をすべて持っています。

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

次のいずれかの方法を使用して、新しい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\""
```
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サービスを再起動します：

bash

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

ヒント

新しい設定を確実に適用するために、設定を変更した後は常にNRDOT Collectorサービスを再起動してください。

データを探す、使う

データの収集が開始されると、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のクエリ機能を使用して、データを探索します

APMとデータベースの相関を設定する

New Relicでアプリケーションパフォーマンスとデータベース操作を関連付ける方法について説明します。

トラブルシューティング

New RelicでのMSSQL Windows監視設定のトラブルシューティング方法を学びます。

メトリクスリファレンス

NRDOT Collectorによって収集される利用可能なメトリクスについて説明します。

この機械翻訳は、参考として提供されています。