Configuration reference for Microsoft SQL Server monitoring with NRDOT

This reference provides comprehensive YAML configurations for Microsoft SQL Server monitoring with the New Relic Distribution of OpenTelemetry (NRDOT) Collector. These full-feature configurations include all available metrics, advanced processor settings, and optimized pipelines for production environments across Linux and Windows, both self-hosted and AWS RDS deployments.

Important

Looking to get started quickly? These are advanced configurations for production use. If you're setting up SQL Server monitoring for the first time, we recommend starting with the standard configurations in our setup guides and returning to these comprehensive configurations once you've verified basic functionality.

For Linux

This configuration provides comprehensive database monitoring with all available metrics for Linux self-hosted environments.

Database Username

Database Password

SQL Server Hostname/IP

SQL Server Port

New Relic OTLP Endpoint with port number

New Relic License Key

mssql-config.yaml

1
receivers:
2
    nrsqlserver:
3
      collection_interval: 15s
4
      username: newrelic
5
      password: YOUR_PASSWORD
6
      server: sqlserver.example.com
7
      port: 1433
8

9
      # Enable comprehensive database metrics
10
      metrics:
11
        # Database
12
        sqlserver.database.count:
13
          enabled: true
14
        sqlserver.database.file.size:
15
          enabled: true 
16
        sqlserver.database.io:
17
          enabled: true
18
        sqlserver.database.latency:
19
          enabled: true
20
        sqlserver.database.operations:
21
          enabled: true
22
        sqlserver.database.transactions.active:
23
          enabled: true
24
        sqlserver.database.backup_or_restore.rate:
25
          enabled: true
26
        sqlserver.database.execution.errors:
27
          enabled: true
28
        sqlserver.database.full_scan.rate:
29
          enabled: true
30
        sqlserver.database.tempdb.space:
31
          enabled: true
32
        sqlserver.database.tempdb.version_store.size:
33
          enabled: true
34
        # Locks
35
        sqlserver.lock.timeout.rate:
36
          enabled: true
37
        sqlserver.lock.wait.count:
38
          enabled: true
39
        sqlserver.deadlock.rate:
40
          enabled: true
41
        # Transactions
42
        sqlserver.transaction.delay:
43
          enabled: true
44
        sqlserver.transaction.longest_running_time:
45
          enabled: true
46
        sqlserver.transaction.version_cleanup.rate:
47
          enabled: true
48
        sqlserver.transaction.version_generation.rate:
49
          enabled: true
50
        # Memory
51
        sqlserver.memory.area:
52
          enabled: true
53
        sqlserver.memory.cache.object.count:
54
          enabled: true
55
        sqlserver.memory.grants.pending.count:
56
          enabled: true
57
        sqlserver.memory.page.count:
58
          enabled: true
59
        sqlserver.memory.usage:
60
          enabled: true
61
        # OS
62
        sqlserver.os.memory.usage:
63
          enabled: true
64
        sqlserver.os.memory.utilization:
65
          enabled: true
66
        sqlserver.os.scheduler.runnable_tasks.count:
67
          enabled: true
68
        sqlserver.os.wait.duration:
69
          enabled: true
70
        sqlserver.os.wait.tasks.count:
71
          enabled: true
72
        # Pages / Buffer
73
        sqlserver.page.buffer_cache.free_list.stalls.rate:
74
          enabled: true
75
        sqlserver.page.lookup.rate:
76
          enabled: true
77
        # Batch / Compilation
78
        sqlserver.batch.compilation.utilization:
79
          enabled: true
80
        sqlserver.batch.page_split.utilization:
81
          enabled: true
82
        sqlserver.recompilation.ratio:
83
          enabled: true
84
        sqlserver.parameterization.rate:
85
          enabled: true
86
        sqlserver.plan.execution.rate:
87
          enabled: true
88
        sqlserver.attention.rate:
89
          enabled: true
90
        # Processes / Connections
91
        sqlserver.process.count:
92
          enabled: true
93
        sqlserver.processes.blocked:
94
          enabled: true
95
        sqlserver.login.rate:
96
          enabled: true
97
        sqlserver.logout.rate:
98
          enabled: true
99
        # Thread Pool
100
        sqlserver.thread_pool.tasks.count:
101
          enabled: true
102
        sqlserver.thread_pool.workers.count:
103
          enabled: true
104
        sqlserver.thread_pool.workers.max:
105
          enabled: true
106
        sqlserver.thread_pool.workers.utilization:
107
          enabled: true
108
        # TempDB
109
        sqlserver.tempdb.allocation.wait_time.total:
110
          enabled: true
111
        sqlserver.tempdb.contention.waiters.count:
112
          enabled: true
113
        sqlserver.tempdb.data_files.count:
114
          enabled: true
115
        sqlserver.tempdb.file.size:
116
          enabled: true
117
        sqlserver.tempdb.space.usage:
118
          enabled: true
119
        # Latch
120
        sqlserver.latch.superlatch.count:
121
          enabled: true
122
        sqlserver.latch.superlatch.transition.rate:
123
          enabled: true
124
        sqlserver.latch.wait.rate:
125
          enabled: true
126
        sqlserver.latch.wait_time.avg:
127
          enabled: true
128
        sqlserver.latch.wait_time.total:
129
          enabled: true
130
        # Index
131
        sqlserver.index.search.rate:
132
          enabled: true
133
        # Resource Pool
134
        sqlserver.resource_pool.disk.operations:
135
          enabled: true
136
        sqlserver.resource_pool.disk.throttled.read.rate:
137
          enabled: true
138
        sqlserver.resource_pool.disk.throttled.write.rate:
139
          enabled: true
140
        # Replica / Always-On
141
        sqlserver.replica.data.rate:
142
          enabled: true
143
        sqlserver.failover_cluster.ag.cluster_type:
144
          enabled: true
145
        sqlserver.failover_cluster.ag.failure_condition_level:
146
          enabled: true
147
        sqlserver.failover_cluster.ag.health_check_timeout:
148
          enabled: true
149
        sqlserver.failover_cluster.ag.required_sync_secondaries:
150
          enabled: true
151
        sqlserver.failover_cluster.replica.database.queue_size:
152
          enabled: true
153
        sqlserver.failover_cluster.replica.database.redo.rate:
154
          enabled: true
155
        sqlserver.failover_cluster.replica.flow_control_time:
156
          enabled: true
157
        sqlserver.failover_cluster.replica.role:
158
          enabled: true
159
        sqlserver.failover_cluster.replica.synchronization_health:
160
          enabled: true
161
        # Server Properties
162
        sqlserver.computer.uptime:
163
          enabled: true
164
        sqlserver.cpu.count:
165
          enabled: true
166
        # Tables
167
        sqlserver.table.count:
168
          enabled: true
169

170
      # Enable query sample, top query, query plan, and top procedure log collection
171
      events:
172
        db.server.query_sample:
173
          enabled: true
174
        db.server.top_query:
175
          enabled: true
176
        db.server.query_plan:
177
          enabled: true
178
        db.server.top_procedure:
179
          enabled: true
180

181
      # Top query collection configuration
182
      top_query_collection:
183
        lookback_time: 60s
184
        max_query_sample_count: 1000
185
        top_query_count: 250
186
        collection_interval: 60s
187
        collect_full_query_text: true
188
        allowed_comment_keys:
189
          - nr_service_guid
190

191
      # Query sample collection configuration
192
      query_sample_collection:
193
        max_rows_per_query: 100
194
        collect_full_query_text: true
195
        allowed_comment_keys:
196
          - nr_service_guid
197

198
      # Top stored procedure collection configuration
199
      top_procedure_collection:
200
        max_procedure_sample_count: 1000
201
        top_procedure_count: 250
202
        collection_interval: 60s
203

204
      resource_attributes:
205
        db.system.version:
206
          enabled: true
207
        sqlserver.db.edition:
208
          enabled: true
209

210
processors:
211
    memory_limiter:
212
      check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
213
      limit_mib: ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
214
      spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}
215

216
exporters:
217
    otlp:
218
      endpoint: https://otlp.nr-data.net:4318
219
      headers:
220
        api-key: YOUR_LICENSE_KEY
221
      tls:
222
        insecure: false
223
      compression: gzip
224

225
      sending_queue:
226
        enabled: true
227
        sizer: bytes
228
        queue_size: 100_000_000
229
        num_consumers: 10
230
        batch:
231
          sizer: bytes
232
          max_size: 1_000_000
233
          min_size: 0
234
          flush_timeout: 5s
235

236
service:
237
    telemetry:
238
      metrics:
239
        level: none
240

241
    pipelines:
242
      metrics:
243
        receivers: [nrsqlserver]
244
        processors: [memory_limiter]
245
        exporters: [otlp]
246

247
      logs:
248
        receivers: [nrsqlserver]
249
        processors: [memory_limiter]
250
        exporters: [otlp]

Once you've downloaded or pasted the full configuration into your mssql-config.yaml file, follow the Linux self-hosted guide to complete the setup.

This configuration provides comprehensive database monitoring with all available metrics for AWS RDS SQL Server environments on Linux.

Database Username

Database Password

RDS Endpoint

SQL Server Port

New Relic OTLP Endpoint with port number

New Relic License Key

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
        # Database
12
        sqlserver.database.count:
13
          enabled: true
14
        sqlserver.database.file.size:
15
          enabled: true 
16
        sqlserver.database.io:
17
          enabled: true
18
        sqlserver.database.latency:
19
          enabled: true
20
        sqlserver.database.operations:
21
          enabled: true
22
        sqlserver.database.transactions.active:
23
          enabled: true
24
        sqlserver.database.backup_or_restore.rate:
25
          enabled: true
26
        sqlserver.database.full_scan.rate:
27
          enabled: true
28
        sqlserver.database.tempdb.space:
29
          enabled: true
30
        sqlserver.database.tempdb.version_store.size:
31
          enabled: true
32
        # Locks
33
        sqlserver.lock.timeout.rate:
34
          enabled: true
35
        sqlserver.lock.wait.count:
36
          enabled: true
37
        sqlserver.deadlock.rate:
38
          enabled: true
39
        # Transactions
40
        sqlserver.transaction.delay:
41
          enabled: true
42
        sqlserver.transaction.longest_running_time:
43
          enabled: true
44
        sqlserver.transaction.version_cleanup.rate:
45
          enabled: true
46
        sqlserver.transaction.version_generation.rate:
47
          enabled: true
48
        # Memory
49
        sqlserver.memory.area:
50
          enabled: true
51
        sqlserver.memory.cache.object.count:
52
          enabled: true
53
        sqlserver.memory.grants.pending.count:
54
          enabled: true
55
        sqlserver.memory.page.count:
56
          enabled: true
57
        sqlserver.memory.usage:
58
          enabled: true
59
        # OS
60
        sqlserver.os.memory.usage:
61
          enabled: true
62
        sqlserver.os.memory.utilization:
63
          enabled: true
64
        sqlserver.os.scheduler.runnable_tasks.count:
65
          enabled: true
66
        sqlserver.os.wait.duration:
67
          enabled: true
68
        sqlserver.os.wait.tasks.count:
69
          enabled: true
70
        # Pages / Buffer
71
        sqlserver.page.buffer_cache.free_list.stalls.rate:
72
          enabled: true
73
        sqlserver.page.lookup.rate:
74
          enabled: true
75
        # Batch / Compilation
76
        sqlserver.batch.compilation.utilization:
77
          enabled: true
78
        sqlserver.batch.page_split.utilization:
79
          enabled: true
80
        sqlserver.recompilation.ratio:
81
          enabled: true
82
        sqlserver.parameterization.rate:
83
          enabled: true
84
        sqlserver.plan.execution.rate:
85
          enabled: true
86
        sqlserver.attention.rate:
87
          enabled: true
88
        # Processes / Connections
89
        sqlserver.process.count:
90
          enabled: true
91
        sqlserver.processes.blocked:
92
          enabled: true
93
        sqlserver.login.rate:
94
          enabled: true
95
        sqlserver.logout.rate:
96
          enabled: true
97
        # Thread Pool
98
        sqlserver.thread_pool.tasks.count:
99
          enabled: true
100
        sqlserver.thread_pool.workers.count:
101
          enabled: true
102
        sqlserver.thread_pool.workers.max:
103
          enabled: true
104
        sqlserver.thread_pool.workers.utilization:
105
          enabled: true
106
        # TempDB
107
        sqlserver.tempdb.allocation.wait_time.total:
108
          enabled: true
109
        sqlserver.tempdb.contention.waiters.count:
110
          enabled: true
111
        sqlserver.tempdb.data_files.count:
112
          enabled: true
113
        sqlserver.tempdb.file.size:
114
          enabled: true
115
        sqlserver.tempdb.space.usage:
116
          enabled: true
117
        # Latch
118
        sqlserver.latch.superlatch.count:
119
          enabled: true
120
        sqlserver.latch.superlatch.transition.rate:
121
          enabled: true
122
        sqlserver.latch.wait.rate:
123
          enabled: true
124
        sqlserver.latch.wait_time.avg:
125
          enabled: true
126
        sqlserver.latch.wait_time.total:
127
          enabled: true
128
        # Index
129
        sqlserver.index.search.rate:
130
          enabled: true
131
        # Resource Pool
132
        sqlserver.resource_pool.disk.operations:
133
          enabled: true
134
        sqlserver.resource_pool.disk.throttled.read.rate:
135
          enabled: true
136
        sqlserver.resource_pool.disk.throttled.write.rate:
137
          enabled: true
138
        # Replica / Always-On
139
        sqlserver.replica.data.rate:
140
          enabled: true
141
        sqlserver.failover_cluster.ag.cluster_type:
142
          enabled: true
143
        sqlserver.failover_cluster.ag.failure_condition_level:
144
          enabled: true
145
        sqlserver.failover_cluster.ag.health_check_timeout:
146
          enabled: true
147
        sqlserver.failover_cluster.ag.required_sync_secondaries:
148
          enabled: true
149
        sqlserver.failover_cluster.replica.database.queue_size:
150
          enabled: true
151
        sqlserver.failover_cluster.replica.database.redo.rate:
152
          enabled: true
153
        sqlserver.failover_cluster.replica.flow_control_time:
154
          enabled: true
155
        sqlserver.failover_cluster.replica.role:
156
          enabled: true
157
        sqlserver.failover_cluster.replica.synchronization_health:
158
          enabled: true
159
        # Server Properties
160
        sqlserver.computer.uptime:
161
          enabled: true
162
        sqlserver.cpu.count:
163
          enabled: true
164
        # Tables
165
        sqlserver.table.count:
166
          enabled: true
167

168
      # Enable query sample, top query, query plan, and top procedure log collection
169
      events:
170
        db.server.query_sample:
171
          enabled: true
172
        db.server.top_query:
173
          enabled: true
174
        db.server.query_plan:
175
          enabled: true
176
        db.server.top_procedure:
177
          enabled: true
178

179
      # Top query collection configuration
180
      top_query_collection:
181
        lookback_time: 60s
182
        max_query_sample_count: 1000
183
        top_query_count: 250
184
        collection_interval: 60s
185
        collect_full_query_text: true
186
        allowed_comment_keys:
187
          - nr_service_guid
188

189
      # Query sample collection configuration
190
      query_sample_collection:
191
        max_rows_per_query: 100
192
        collect_full_query_text: true
193
        allowed_comment_keys:
194
          - nr_service_guid
195

196
      # Top stored procedure collection configuration
197
      top_procedure_collection:
198
        max_procedure_sample_count: 1000
199
        top_procedure_count: 250
200
        collection_interval: 60s
201

202
      resource_attributes:
203
        db.system.version:
204
          enabled: true
205
        sqlserver.db.edition:
206
          enabled: true
207

208
processors:
209
    memory_limiter:
210
      check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
211
      limit_mib: ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
212
      spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}
213

214
exporters:
215
    otlp:
216
      endpoint: https://otlp.nr-data.net:4318
217
      headers:
218
        api-key: YOUR_LICENSE_KEY
219
      tls:
220
        insecure: false
221
      compression: gzip
222

223
      sending_queue:
224
        enabled: true
225
        sizer: bytes
226
        queue_size: 100_000_000
227
        num_consumers: 10
228
        batch:
229
          sizer: bytes
230
          max_size: 1_000_000
231
          min_size: 0
232
          flush_timeout: 5s
233

234
service:
235
    telemetry:
236
      metrics:
237
        level: none
238

239
    pipelines:
240
      metrics:
241
        receivers: [nrsqlserver]
242
        processors: [memory_limiter]
243
        exporters: [otlp]
244

245
      logs:
246
        receivers: [nrsqlserver]
247
        processors: [memory_limiter]
248
        exporters: [otlp]

Once you've downloaded or pasted the full configuration into your mssql-config.yaml file, follow the Linux RDS guide to complete the setup.

For Windows

This configuration provides comprehensive database monitoring with all available metrics for Windows self-hosted environments using SQL Server authentication.

SQL Server Username

SQL Server Password

Server Hostname/IP

Server Port

New Relic OTLP Endpoint with port number

New Relic License Key

mssql-config.yaml

1
receivers:
2
    nrsqlserver:
3
      collection_interval: 15s
4
      username: newrelic
5
      password: YOUR_PASSWORD
6
      server: sqlserver.example.com
7
      port: 1433
8

9
      # Enable comprehensive database metrics
10
      metrics:
11
        # Database
12
        sqlserver.database.count:
13
          enabled: true
14
        sqlserver.database.file.size:
15
          enabled: true 
16
        sqlserver.database.io:
17
          enabled: true
18
        sqlserver.database.latency:
19
          enabled: true
20
        sqlserver.database.operations:
21
          enabled: true
22
        sqlserver.database.transactions.active:
23
          enabled: true
24
        sqlserver.database.backup_or_restore.rate:
25
          enabled: true
26
        sqlserver.database.execution.errors:
27
          enabled: true
28
        sqlserver.database.full_scan.rate:
29
          enabled: true
30
        sqlserver.database.tempdb.space:
31
          enabled: true
32
        sqlserver.database.tempdb.version_store.size:
33
          enabled: true
34
        # Locks
35
        sqlserver.lock.timeout.rate:
36
          enabled: true
37
        sqlserver.lock.wait.count:
38
          enabled: true
39
        sqlserver.deadlock.rate:
40
          enabled: true
41
        # Transactions
42
        sqlserver.transaction.delay:
43
          enabled: true
44
        sqlserver.transaction.longest_running_time:
45
          enabled: true
46
        sqlserver.transaction.version_cleanup.rate:
47
          enabled: true
48
        sqlserver.transaction.version_generation.rate:
49
          enabled: true
50
        # Memory
51
        sqlserver.memory.area:
52
          enabled: true
53
        sqlserver.memory.cache.object.count:
54
          enabled: true
55
        sqlserver.memory.grants.pending.count:
56
          enabled: true
57
        sqlserver.memory.page.count:
58
          enabled: true
59
        sqlserver.memory.usage:
60
          enabled: true
61
        # OS
62
        sqlserver.os.memory.usage:
63
          enabled: true
64
        sqlserver.os.memory.utilization:
65
          enabled: true
66
        sqlserver.os.scheduler.runnable_tasks.count:
67
          enabled: true
68
        sqlserver.os.wait.duration:
69
          enabled: true
70
        sqlserver.os.wait.tasks.count:
71
          enabled: true
72
        # Pages / Buffer
73
        sqlserver.page.buffer_cache.free_list.stalls.rate:
74
          enabled: true
75
        sqlserver.page.lookup.rate:
76
          enabled: true
77
        # Batch / Compilation
78
        sqlserver.batch.compilation.utilization:
79
          enabled: true
80
        sqlserver.batch.page_split.utilization:
81
          enabled: true
82
        sqlserver.recompilation.ratio:
83
          enabled: true
84
        sqlserver.parameterization.rate:
85
          enabled: true
86
        sqlserver.plan.execution.rate:
87
          enabled: true
88
        sqlserver.attention.rate:
89
          enabled: true
90
        # Processes / Connections
91
        sqlserver.process.count:
92
          enabled: true
93
        sqlserver.processes.blocked:
94
          enabled: true
95
        sqlserver.login.rate:
96
          enabled: true
97
        sqlserver.logout.rate:
98
          enabled: true
99
        # Thread Pool
100
        sqlserver.thread_pool.tasks.count:
101
          enabled: true
102
        sqlserver.thread_pool.workers.count:
103
          enabled: true
104
        sqlserver.thread_pool.workers.max:
105
          enabled: true
106
        sqlserver.thread_pool.workers.utilization:
107
          enabled: true
108
        # TempDB
109
        sqlserver.tempdb.allocation.wait_time.total:
110
          enabled: true
111
        sqlserver.tempdb.contention.waiters.count:
112
          enabled: true
113
        sqlserver.tempdb.data_files.count:
114
          enabled: true
115
        sqlserver.tempdb.file.size:
116
          enabled: true
117
        sqlserver.tempdb.space.usage:
118
          enabled: true
119
        # Latch
120
        sqlserver.latch.superlatch.count:
121
          enabled: true
122
        sqlserver.latch.superlatch.transition.rate:
123
          enabled: true
124
        sqlserver.latch.wait.rate:
125
          enabled: true
126
        sqlserver.latch.wait_time.avg:
127
          enabled: true
128
        sqlserver.latch.wait_time.total:
129
          enabled: true
130
        # Index
131
        sqlserver.index.search.rate:
132
          enabled: true
133
        # Resource Pool
134
        sqlserver.resource_pool.disk.operations:
135
          enabled: true
136
        sqlserver.resource_pool.disk.throttled.read.rate:
137
          enabled: true
138
        sqlserver.resource_pool.disk.throttled.write.rate:
139
          enabled: true
140
        # Replica / Always-On
141
        sqlserver.replica.data.rate:
142
          enabled: true
143
        sqlserver.failover_cluster.ag.cluster_type:
144
          enabled: true
145
        sqlserver.failover_cluster.ag.failure_condition_level:
146
          enabled: true
147
        sqlserver.failover_cluster.ag.health_check_timeout:
148
          enabled: true
149
        sqlserver.failover_cluster.ag.required_sync_secondaries:
150
          enabled: true
151
        sqlserver.failover_cluster.replica.database.queue_size:
152
          enabled: true
153
        sqlserver.failover_cluster.replica.database.redo.rate:
154
          enabled: true
155
        sqlserver.failover_cluster.replica.flow_control_time:
156
          enabled: true
157
        sqlserver.failover_cluster.replica.role:
158
          enabled: true
159
        sqlserver.failover_cluster.replica.synchronization_health:
160
          enabled: true
161
        # Server Properties
162
        sqlserver.computer.uptime:
163
          enabled: true
164
        sqlserver.cpu.count:
165
          enabled: true
166
        # Tables
167
        sqlserver.table.count:
168
          enabled: true
169

170
      # Enable query sample, top query, query plan, and top procedure log collection
171
      events:
172
        db.server.query_sample:
173
          enabled: true
174
        db.server.top_query:
175
          enabled: true
176
        db.server.query_plan:
177
          enabled: true
178
        db.server.top_procedure:
179
          enabled: true
180

181
      # Top query collection configuration
182
      top_query_collection:
183
        lookback_time: 60s
184
        max_query_sample_count: 1000
185
        top_query_count: 250
186
        collection_interval: 60s
187
        collect_full_query_text: true
188
        allowed_comment_keys:
189
          - nr_service_guid
190

191
      # Query sample collection configuration
192
      query_sample_collection:
193
        max_rows_per_query: 100
194
        collect_full_query_text: true
195
        allowed_comment_keys:
196
          - nr_service_guid
197

198
      # Top stored procedure collection configuration
199
      top_procedure_collection:
200
        max_procedure_sample_count: 1000
201
        top_procedure_count: 250
202
        collection_interval: 60s
203

204
      resource_attributes:
205
        db.system.version:
206
          enabled: true
207
        sqlserver.db.edition:
208
          enabled: true
209

210
processors:
211
    memory_limiter:
212
      check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
213
      limit_mib: ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
214
      spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}
215

216
exporters:
217
    otlp:
218
      endpoint: https://otlp.nr-data.net:4318
219
      headers:
220
        api-key: YOUR_LICENSE_KEY
221
      tls:
222
        insecure: false
223
      compression: gzip
224

225
      sending_queue:
226
        enabled: true
227
        sizer: bytes
228
        queue_size: 100_000_000
229
        num_consumers: 10
230
        batch:
231
          sizer: bytes
232
          max_size: 1_000_000
233
          min_size: 0
234
          flush_timeout: 5s
235

236
service:
237
    telemetry:
238
      metrics:
239
        level: none
240

241
    pipelines:
242
      metrics:
243
        receivers: [nrsqlserver]
244
        processors: [memory_limiter]
245
        exporters: [otlp]
246

247
      logs:
248
        receivers: [nrsqlserver]
249
        processors: [memory_limiter]
250
        exporters: [otlp]

Once you've downloaded or pasted the full configuration into your mssql-config.yaml file, follow the Windows self-hosted guide to complete the setup using SQL Server authentication.

This configuration provides comprehensive database monitoring with all available metrics for Windows self-hosted environments using Windows Domain Authentication (integrated security).

SQL Server Hostname/IP

SQL Server Port

New Relic OTLP Endpoint with port number

New Relic License Key

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
        # Database
9
        sqlserver.database.count:
10
          enabled: true
11
        sqlserver.database.file.size:
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.transactions.active:
20
          enabled: true
21
        sqlserver.database.backup_or_restore.rate:
22
          enabled: true
23
        sqlserver.database.execution.errors:
24
          enabled: true
25
        sqlserver.database.full_scan.rate:
26
          enabled: true
27
        sqlserver.database.tempdb.space:
28
          enabled: true
29
        sqlserver.database.tempdb.version_store.size:
30
          enabled: true
31
        # Locks
32
        sqlserver.lock.timeout.rate:
33
          enabled: true
34
        sqlserver.lock.wait.count:
35
          enabled: true
36
        sqlserver.deadlock.rate:
37
          enabled: true
38
        # Transactions
39
        sqlserver.transaction.delay:
40
          enabled: true
41
        sqlserver.transaction.longest_running_time:
42
          enabled: true
43
        sqlserver.transaction.version_cleanup.rate:
44
          enabled: true
45
        sqlserver.transaction.version_generation.rate:
46
          enabled: true
47
        # Memory
48
        sqlserver.memory.area:
49
          enabled: true
50
        sqlserver.memory.cache.object.count:
51
          enabled: true
52
        sqlserver.memory.grants.pending.count:
53
          enabled: true
54
        sqlserver.memory.page.count:
55
          enabled: true
56
        sqlserver.memory.usage:
57
          enabled: true
58
        # OS
59
        sqlserver.os.memory.usage:
60
          enabled: true
61
        sqlserver.os.memory.utilization:
62
          enabled: true
63
        sqlserver.os.scheduler.runnable_tasks.count:
64
          enabled: true
65
        sqlserver.os.wait.duration:
66
          enabled: true
67
        sqlserver.os.wait.tasks.count:
68
          enabled: true
69
        # Pages / Buffer
70
        sqlserver.page.buffer_cache.free_list.stalls.rate:
71
          enabled: true
72
        sqlserver.page.lookup.rate:
73
          enabled: true
74
        # Batch / Compilation
75
        sqlserver.batch.compilation.utilization:
76
          enabled: true
77
        sqlserver.batch.page_split.utilization:
78
          enabled: true
79
        sqlserver.recompilation.ratio:
80
          enabled: true
81
        sqlserver.parameterization.rate:
82
          enabled: true
83
        sqlserver.plan.execution.rate:
84
          enabled: true
85
        sqlserver.attention.rate:
86
          enabled: true
87
        # Processes / Connections
88
        sqlserver.process.count:
89
          enabled: true
90
        sqlserver.processes.blocked:
91
          enabled: true
92
        sqlserver.login.rate:
93
          enabled: true
94
        sqlserver.logout.rate:
95
          enabled: true
96
        # Thread Pool
97
        sqlserver.thread_pool.tasks.count:
98
          enabled: true
99
        sqlserver.thread_pool.workers.count:
100
          enabled: true
101
        sqlserver.thread_pool.workers.max:
102
          enabled: true
103
        sqlserver.thread_pool.workers.utilization:
104
          enabled: true
105
        # TempDB
106
        sqlserver.tempdb.allocation.wait_time.total:
107
          enabled: true
108
        sqlserver.tempdb.contention.waiters.count:
109
          enabled: true
110
        sqlserver.tempdb.data_files.count:
111
          enabled: true
112
        sqlserver.tempdb.file.size:
113
          enabled: true
114
        sqlserver.tempdb.space.usage:
115
          enabled: true
116
        # Latch
117
        sqlserver.latch.superlatch.count:
118
          enabled: true
119
        sqlserver.latch.superlatch.transition.rate:
120
          enabled: true
121
        sqlserver.latch.wait.rate:
122
          enabled: true
123
        sqlserver.latch.wait_time.avg:
124
          enabled: true
125
        sqlserver.latch.wait_time.total:
126
          enabled: true
127
        # Index
128
        sqlserver.index.search.rate:
129
          enabled: true
130
        # Resource Pool
131
        sqlserver.resource_pool.disk.operations:
132
          enabled: true
133
        sqlserver.resource_pool.disk.throttled.read.rate:
134
          enabled: true
135
        sqlserver.resource_pool.disk.throttled.write.rate:
136
          enabled: true
137
        # Replica / Always-On
138
        sqlserver.replica.data.rate:
139
          enabled: true
140
        sqlserver.failover_cluster.ag.cluster_type:
141
          enabled: true
142
        sqlserver.failover_cluster.ag.failure_condition_level:
143
          enabled: true
144
        sqlserver.failover_cluster.ag.health_check_timeout:
145
          enabled: true
146
        sqlserver.failover_cluster.ag.required_sync_secondaries:
147
          enabled: true
148
        sqlserver.failover_cluster.replica.database.queue_size:
149
          enabled: true
150
        sqlserver.failover_cluster.replica.database.redo.rate:
151
          enabled: true
152
        sqlserver.failover_cluster.replica.flow_control_time:
153
          enabled: true
154
        sqlserver.failover_cluster.replica.role:
155
          enabled: true
156
        sqlserver.failover_cluster.replica.synchronization_health:
157
          enabled: true
158
        # Server Properties
159
        sqlserver.computer.uptime:
160
          enabled: true
161
        sqlserver.cpu.count:
162
          enabled: true
163
        # Tables
164
        sqlserver.table.count:
165
          enabled: true
166

167
      # Enable query sample, top query, query plan, and top procedure log collection
168
      events:
169
        db.server.query_sample:
170
          enabled: true
171
        db.server.top_query:
172
          enabled: true
173
        db.server.query_plan:
174
          enabled: true
175
        db.server.top_procedure:
176
          enabled: true
177

178
      # Top query collection configuration
179
      top_query_collection:
180
        lookback_time: 60s
181
        max_query_sample_count: 1000
182
        top_query_count: 250
183
        collection_interval: 60s
184
        collect_full_query_text: true
185
        allowed_comment_keys:
186
          - nr_service_guid
187

188
      # Query sample collection configuration
189
      query_sample_collection:
190
        max_rows_per_query: 100
191
        collect_full_query_text: true
192
        allowed_comment_keys:
193
          - nr_service_guid
194

195
      # Top stored procedure collection configuration
196
      top_procedure_collection:
197
        max_procedure_sample_count: 1000
198
        top_procedure_count: 250
199
        collection_interval: 60s
200

201
      resource_attributes:
202
        db.system.version:
203
          enabled: true
204
        sqlserver.db.edition:
205
          enabled: true
206

207
processors:
208
    memory_limiter:
209
      check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
210
      limit_mib: ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
211
      spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}
212

213
exporters:
214
    otlp:
215
      endpoint: https://otlp.nr-data.net:4318
216
      headers:
217
        api-key: YOUR_LICENSE_KEY
218
      tls:
219
        insecure: false
220
      compression: gzip
221

222
      sending_queue:
223
        enabled: true
224
        sizer: bytes
225
        queue_size: 100_000_000
226
        num_consumers: 10
227
        batch:
228
          sizer: bytes
229
          max_size: 1_000_000
230
          min_size: 0
231
          flush_timeout: 5s
232

233
service:
234
    telemetry:
235
      metrics:
236
        level: none
237

238
    pipelines:
239
      metrics:
240
        receivers: [nrsqlserver]
241
        processors: [memory_limiter]
242
        exporters: [otlp]
243

244
      logs:
245
        receivers: [nrsqlserver]
246
        processors: [memory_limiter]
247
        exporters: [otlp]

Once you've downloaded or pasted the full configuration into your mssql-config.yaml file, follow the Windows self-hosted guide to complete the setup using Windows authentication.

This configuration provides comprehensive database monitoring with all available metrics for Windows self-hosted environments using gMSA authentication (integrated security).

SQL Server Hostname/IP

SQL Server Port

New Relic OTLP Endpoint with port number

New Relic License Key

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
        # Database
9
        sqlserver.database.count:
10
          enabled: true
11
        sqlserver.database.file.size:
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.transactions.active:
20
          enabled: true
21
        sqlserver.database.backup_or_restore.rate:
22
          enabled: true
23
        sqlserver.database.execution.errors:
24
          enabled: true
25
        sqlserver.database.full_scan.rate:
26
          enabled: true
27
        sqlserver.database.tempdb.space:
28
          enabled: true
29
        sqlserver.database.tempdb.version_store.size:
30
          enabled: true
31
        # Locks
32
        sqlserver.lock.timeout.rate:
33
          enabled: true
34
        sqlserver.lock.wait.count:
35
          enabled: true
36
        sqlserver.deadlock.rate:
37
          enabled: true
38
        # Transactions
39
        sqlserver.transaction.delay:
40
          enabled: true
41
        sqlserver.transaction.longest_running_time:
42
          enabled: true
43
        sqlserver.transaction.version_cleanup.rate:
44
          enabled: true
45
        sqlserver.transaction.version_generation.rate:
46
          enabled: true
47
        # Memory
48
        sqlserver.memory.area:
49
          enabled: true
50
        sqlserver.memory.cache.object.count:
51
          enabled: true
52
        sqlserver.memory.grants.pending.count:
53
          enabled: true
54
        sqlserver.memory.page.count:
55
          enabled: true
56
        sqlserver.memory.usage:
57
          enabled: true
58
        # OS
59
        sqlserver.os.memory.usage:
60
          enabled: true
61
        sqlserver.os.memory.utilization:
62
          enabled: true
63
        sqlserver.os.scheduler.runnable_tasks.count:
64
          enabled: true
65
        sqlserver.os.wait.duration:
66
          enabled: true
67
        sqlserver.os.wait.tasks.count:
68
          enabled: true
69
        # Pages / Buffer
70
        sqlserver.page.buffer_cache.free_list.stalls.rate:
71
          enabled: true
72
        sqlserver.page.lookup.rate:
73
          enabled: true
74
        # Batch / Compilation
75
        sqlserver.batch.compilation.utilization:
76
          enabled: true
77
        sqlserver.batch.page_split.utilization:
78
          enabled: true
79
        sqlserver.recompilation.ratio:
80
          enabled: true
81
        sqlserver.parameterization.rate:
82
          enabled: true
83
        sqlserver.plan.execution.rate:
84
          enabled: true
85
        sqlserver.attention.rate:
86
          enabled: true
87
        # Processes / Connections
88
        sqlserver.process.count:
89
          enabled: true
90
        sqlserver.processes.blocked:
91
          enabled: true
92
        sqlserver.login.rate:
93
          enabled: true
94
        sqlserver.logout.rate:
95
          enabled: true
96
        # Thread Pool
97
        sqlserver.thread_pool.tasks.count:
98
          enabled: true
99
        sqlserver.thread_pool.workers.count:
100
          enabled: true
101
        sqlserver.thread_pool.workers.max:
102
          enabled: true
103
        sqlserver.thread_pool.workers.utilization:
104
          enabled: true
105
        # TempDB
106
        sqlserver.tempdb.allocation.wait_time.total:
107
          enabled: true
108
        sqlserver.tempdb.contention.waiters.count:
109
          enabled: true
110
        sqlserver.tempdb.data_files.count:
111
          enabled: true
112
        sqlserver.tempdb.file.size:
113
          enabled: true
114
        sqlserver.tempdb.space.usage:
115
          enabled: true
116
        # Latch
117
        sqlserver.latch.superlatch.count:
118
          enabled: true
119
        sqlserver.latch.superlatch.transition.rate:
120
          enabled: true
121
        sqlserver.latch.wait.rate:
122
          enabled: true
123
        sqlserver.latch.wait_time.avg:
124
          enabled: true
125
        sqlserver.latch.wait_time.total:
126
          enabled: true
127
        # Index
128
        sqlserver.index.search.rate:
129
          enabled: true
130
        # Resource Pool
131
        sqlserver.resource_pool.disk.operations:
132
          enabled: true
133
        sqlserver.resource_pool.disk.throttled.read.rate:
134
          enabled: true
135
        sqlserver.resource_pool.disk.throttled.write.rate:
136
          enabled: true
137
        # Replica / Always-On
138
        sqlserver.replica.data.rate:
139
          enabled: true
140
        sqlserver.failover_cluster.ag.cluster_type:
141
          enabled: true
142
        sqlserver.failover_cluster.ag.failure_condition_level:
143
          enabled: true
144
        sqlserver.failover_cluster.ag.health_check_timeout:
145
          enabled: true
146
        sqlserver.failover_cluster.ag.required_sync_secondaries:
147
          enabled: true
148
        sqlserver.failover_cluster.replica.database.queue_size:
149
          enabled: true
150
        sqlserver.failover_cluster.replica.database.redo.rate:
151
          enabled: true
152
        sqlserver.failover_cluster.replica.flow_control_time:
153
          enabled: true
154
        sqlserver.failover_cluster.replica.role:
155
          enabled: true
156
        sqlserver.failover_cluster.replica.synchronization_health:
157
          enabled: true
158
        # Server Properties
159
        sqlserver.computer.uptime:
160
          enabled: true
161
        sqlserver.cpu.count:
162
          enabled: true
163
        # Tables
164
        sqlserver.table.count:
165
          enabled: true
166

167
      # Enable query sample, top query, query plan, and top procedure log collection
168
      events:
169
        db.server.query_sample:
170
          enabled: true
171
        db.server.top_query:
172
          enabled: true
173
        db.server.query_plan:
174
          enabled: true
175
        db.server.top_procedure:
176
          enabled: true
177

178
      # Top query collection configuration
179
      top_query_collection:
180
        lookback_time: 60s
181
        max_query_sample_count: 1000
182
        top_query_count: 250
183
        collection_interval: 60s
184
        collect_full_query_text: true
185
        allowed_comment_keys:
186
          - nr_service_guid
187

188
      # Query sample collection configuration
189
      query_sample_collection:
190
        max_rows_per_query: 100
191
        collect_full_query_text: true
192
        allowed_comment_keys:
193
          - nr_service_guid
194

195
      # Top stored procedure collection configuration
196
      top_procedure_collection:
197
        max_procedure_sample_count: 1000
198
        top_procedure_count: 250
199
        collection_interval: 60s
200

201
      resource_attributes:
202
        db.system.version:
203
          enabled: true
204
        sqlserver.db.edition:
205
          enabled: true
206

207
processors:
208
    memory_limiter:
209
      check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
210
      limit_mib: ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
211
      spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}
212

213
exporters:
214
    otlp:
215
      endpoint: https://otlp.nr-data.net:4318
216
      headers:
217
        api-key: YOUR_LICENSE_KEY
218
      tls:
219
        insecure: false
220
      compression: gzip
221

222
      sending_queue:
223
        enabled: true
224
        sizer: bytes
225
        queue_size: 100_000_000
226
        num_consumers: 10
227
        batch:
228
          sizer: bytes
229
          max_size: 1_000_000
230
          min_size: 0
231
          flush_timeout: 5s
232

233
service:
234
    telemetry:
235
      metrics:
236
        level: none
237

238
    pipelines:
239
      metrics:
240
        receivers: [nrsqlserver]
241
        processors: [memory_limiter]
242
        exporters: [otlp]
243

244
      logs:
245
        receivers: [nrsqlserver]
246
        processors: [memory_limiter]
247
        exporters: [otlp]

Once you've downloaded or pasted the full configuration into your mssql-config.yaml file, follow the Windows self-hosted guide to complete the setup using gMSA authentication.

This configuration provides comprehensive database monitoring for Windows environments connecting to AWS RDS SQL Server instances using SQL Server authentication.

SQL Server Username

SQL Server Password

RDS Endpoint

Server Port

New Relic OTLP Endpoint with port number

New Relic License Key

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
        # Database
12
        sqlserver.database.count:
13
          enabled: true
14
        sqlserver.database.file.size:
15
          enabled: true 
16
        sqlserver.database.io:
17
          enabled: true
18
        sqlserver.database.latency:
19
          enabled: true
20
        sqlserver.database.operations:
21
          enabled: true
22
        sqlserver.database.transactions.active:
23
          enabled: true
24
        sqlserver.database.backup_or_restore.rate:
25
          enabled: true
26
        sqlserver.database.full_scan.rate:
27
          enabled: true
28
        sqlserver.database.tempdb.space:
29
          enabled: true
30
        sqlserver.database.tempdb.version_store.size:
31
          enabled: true
32
        # Locks
33
        sqlserver.lock.timeout.rate:
34
          enabled: true
35
        sqlserver.lock.wait.count:
36
          enabled: true
37
        sqlserver.deadlock.rate:
38
          enabled: true
39
        # Transactions
40
        sqlserver.transaction.delay:
41
          enabled: true
42
        sqlserver.transaction.longest_running_time:
43
          enabled: true
44
        sqlserver.transaction.version_cleanup.rate:
45
          enabled: true
46
        sqlserver.transaction.version_generation.rate:
47
          enabled: true
48
        # Memory
49
        sqlserver.memory.area:
50
          enabled: true
51
        sqlserver.memory.cache.object.count:
52
          enabled: true
53
        sqlserver.memory.grants.pending.count:
54
          enabled: true
55
        sqlserver.memory.page.count:
56
          enabled: true
57
        sqlserver.memory.usage:
58
          enabled: true
59
        # OS
60
        sqlserver.os.memory.usage:
61
          enabled: true
62
        sqlserver.os.memory.utilization:
63
          enabled: true
64
        sqlserver.os.scheduler.runnable_tasks.count:
65
          enabled: true
66
        sqlserver.os.wait.duration:
67
          enabled: true
68
        sqlserver.os.wait.tasks.count:
69
          enabled: true
70
        # Pages / Buffer
71
        sqlserver.page.buffer_cache.free_list.stalls.rate:
72
          enabled: true
73
        sqlserver.page.lookup.rate:
74
          enabled: true
75
        # Batch / Compilation
76
        sqlserver.batch.compilation.utilization:
77
          enabled: true
78
        sqlserver.batch.page_split.utilization:
79
          enabled: true
80
        sqlserver.recompilation.ratio:
81
          enabled: true
82
        sqlserver.parameterization.rate:
83
          enabled: true
84
        sqlserver.plan.execution.rate:
85
          enabled: true
86
        sqlserver.attention.rate:
87
          enabled: true
88
        # Processes / Connections
89
        sqlserver.process.count:
90
          enabled: true
91
        sqlserver.processes.blocked:
92
          enabled: true
93
        sqlserver.login.rate:
94
          enabled: true
95
        sqlserver.logout.rate:
96
          enabled: true
97
        # Thread Pool
98
        sqlserver.thread_pool.tasks.count:
99
          enabled: true
100
        sqlserver.thread_pool.workers.count:
101
          enabled: true
102
        sqlserver.thread_pool.workers.max:
103
          enabled: true
104
        sqlserver.thread_pool.workers.utilization:
105
          enabled: true
106
        # TempDB
107
        sqlserver.tempdb.allocation.wait_time.total:
108
          enabled: true
109
        sqlserver.tempdb.contention.waiters.count:
110
          enabled: true
111
        sqlserver.tempdb.data_files.count:
112
          enabled: true
113
        sqlserver.tempdb.file.size:
114
          enabled: true
115
        sqlserver.tempdb.space.usage:
116
          enabled: true
117
        # Latch
118
        sqlserver.latch.superlatch.count:
119
          enabled: true
120
        sqlserver.latch.superlatch.transition.rate:
121
          enabled: true
122
        sqlserver.latch.wait.rate:
123
          enabled: true
124
        sqlserver.latch.wait_time.avg:
125
          enabled: true
126
        sqlserver.latch.wait_time.total:
127
          enabled: true
128
        # Index
129
        sqlserver.index.search.rate:
130
          enabled: true
131
        # Resource Pool
132
        sqlserver.resource_pool.disk.operations:
133
          enabled: true
134
        sqlserver.resource_pool.disk.throttled.read.rate:
135
          enabled: true
136
        sqlserver.resource_pool.disk.throttled.write.rate:
137
          enabled: true
138
        # Replica / Always-On
139
        sqlserver.replica.data.rate:
140
          enabled: true
141
        sqlserver.failover_cluster.ag.cluster_type:
142
          enabled: true
143
        sqlserver.failover_cluster.ag.failure_condition_level:
144
          enabled: true
145
        sqlserver.failover_cluster.ag.health_check_timeout:
146
          enabled: true
147
        sqlserver.failover_cluster.ag.required_sync_secondaries:
148
          enabled: true
149
        sqlserver.failover_cluster.replica.database.queue_size:
150
          enabled: true
151
        sqlserver.failover_cluster.replica.database.redo.rate:
152
          enabled: true
153
        sqlserver.failover_cluster.replica.flow_control_time:
154
          enabled: true
155
        sqlserver.failover_cluster.replica.role:
156
          enabled: true
157
        sqlserver.failover_cluster.replica.synchronization_health:
158
          enabled: true
159
        # Server Properties
160
        sqlserver.computer.uptime:
161
          enabled: true
162
        sqlserver.cpu.count:
163
          enabled: true
164
        # Tables
165
        sqlserver.table.count:
166
          enabled: true
167

168
      # Enable query sample, top query, query plan, and top procedure log collection
169
      events:
170
        db.server.query_sample:
171
          enabled: true
172
        db.server.top_query:
173
          enabled: true
174
        db.server.query_plan:
175
          enabled: true
176
        db.server.top_procedure:
177
          enabled: true
178

179
      # Top query collection configuration
180
      top_query_collection:
181
        lookback_time: 60s
182
        max_query_sample_count: 1000
183
        top_query_count: 250
184
        collection_interval: 60s
185
        collect_full_query_text: true
186
        allowed_comment_keys:
187
          - nr_service_guid
188

189
      # Query sample collection configuration
190
      query_sample_collection:
191
        max_rows_per_query: 100
192
        collect_full_query_text: true
193
        allowed_comment_keys:
194
          - nr_service_guid
195

196
      # Top stored procedure collection configuration
197
      top_procedure_collection:
198
        max_procedure_sample_count: 1000
199
        top_procedure_count: 250
200
        collection_interval: 60s
201

202
      resource_attributes:
203
        db.system.version:
204
          enabled: true
205
        sqlserver.db.edition:
206
          enabled: true
207

208
processors:
209
    memory_limiter:
210
      check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
211
      limit_mib: ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
212
      spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}
213

214
exporters:
215
    otlp:
216
      endpoint: https://otlp.nr-data.net:4318
217
      headers:
218
        api-key: YOUR_LICENSE_KEY
219
      tls:
220
        insecure: false
221
      compression: gzip
222

223
      sending_queue:
224
        enabled: true
225
        sizer: bytes
226
        queue_size: 100_000_000
227
        num_consumers: 10
228
        batch:
229
          sizer: bytes
230
          max_size: 1_000_000
231
          min_size: 0
232
          flush_timeout: 5s
233

234
service:
235
    telemetry:
236
      metrics:
237
        level: none
238

239
    pipelines:
240
      metrics:
241
        receivers: [nrsqlserver]
242
        processors: [memory_limiter]
243
        exporters: [otlp]
244

245
      logs:
246
        receivers: [nrsqlserver]
247
        processors: [memory_limiter]
248
        exporters: [otlp]

Once you've downloaded or pasted the full configuration into your mssql-config.yaml file, follow the Windows RDS guide to complete the setup using SQL Server authentication.

This configuration provides comprehensive database monitoring for Windows environments connecting to AWS RDS SQL Server instances using Windows Domain Authentication (integrated security).

RDS Endpoint

RDS Port

New Relic OTLP Endpoint with port number

New Relic License Key

mssql-config.yaml

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
        # Database
9
        sqlserver.database.count:
10
          enabled: true
11
        sqlserver.database.file.size:
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.transactions.active:
20
          enabled: true
21
        sqlserver.database.backup_or_restore.rate:
22
          enabled: true
23
        sqlserver.database.full_scan.rate:
24
          enabled: true
25
        sqlserver.database.tempdb.space:
26
          enabled: true
27
        sqlserver.database.tempdb.version_store.size:
28
          enabled: true
29
        # Locks
30
        sqlserver.lock.timeout.rate:
31
          enabled: true
32
        sqlserver.lock.wait.count:
33
          enabled: true
34
        sqlserver.deadlock.rate:
35
          enabled: true
36
        # Transactions
37
        sqlserver.transaction.delay:
38
          enabled: true
39
        sqlserver.transaction.longest_running_time:
40
          enabled: true
41
        sqlserver.transaction.version_cleanup.rate:
42
          enabled: true
43
        sqlserver.transaction.version_generation.rate:
44
          enabled: true
45
        # Memory
46
        sqlserver.memory.area:
47
          enabled: true
48
        sqlserver.memory.cache.object.count:
49
          enabled: true
50
        sqlserver.memory.grants.pending.count:
51
          enabled: true
52
        sqlserver.memory.page.count:
53
          enabled: true
54
        sqlserver.memory.usage:
55
          enabled: true
56
        # OS
57
        sqlserver.os.memory.usage:
58
          enabled: true
59
        sqlserver.os.memory.utilization:
60
          enabled: true
61
        sqlserver.os.scheduler.runnable_tasks.count:
62
          enabled: true
63
        sqlserver.os.wait.duration:
64
          enabled: true
65
        sqlserver.os.wait.tasks.count:
66
          enabled: true
67
        # Pages / Buffer
68
        sqlserver.page.buffer_cache.free_list.stalls.rate:
69
          enabled: true
70
        sqlserver.page.lookup.rate:
71
          enabled: true
72
        # Batch / Compilation
73
        sqlserver.batch.compilation.utilization:
74
          enabled: true
75
        sqlserver.batch.page_split.utilization:
76
          enabled: true
77
        sqlserver.recompilation.ratio:
78
          enabled: true
79
        sqlserver.parameterization.rate:
80
          enabled: true
81
        sqlserver.plan.execution.rate:
82
          enabled: true
83
        sqlserver.attention.rate:
84
          enabled: true
85
        # Processes / Connections
86
        sqlserver.process.count:
87
          enabled: true
88
        sqlserver.processes.blocked:
89
          enabled: true
90
        sqlserver.login.rate:
91
          enabled: true
92
        sqlserver.logout.rate:
93
          enabled: true
94
        # Thread Pool
95
        sqlserver.thread_pool.tasks.count:
96
          enabled: true
97
        sqlserver.thread_pool.workers.count:
98
          enabled: true
99
        sqlserver.thread_pool.workers.max:
100
          enabled: true
101
        sqlserver.thread_pool.workers.utilization:
102
          enabled: true
103
        # TempDB
104
        sqlserver.tempdb.allocation.wait_time.total:
105
          enabled: true
106
        sqlserver.tempdb.contention.waiters.count:
107
          enabled: true
108
        sqlserver.tempdb.data_files.count:
109
          enabled: true
110
        sqlserver.tempdb.file.size:
111
          enabled: true
112
        sqlserver.tempdb.space.usage:
113
          enabled: true
114
        # Latch
115
        sqlserver.latch.superlatch.count:
116
          enabled: true
117
        sqlserver.latch.superlatch.transition.rate:
118
          enabled: true
119
        sqlserver.latch.wait.rate:
120
          enabled: true
121
        sqlserver.latch.wait_time.avg:
122
          enabled: true
123
        sqlserver.latch.wait_time.total:
124
          enabled: true
125
        # Index
126
        sqlserver.index.search.rate:
127
          enabled: true
128
        # Resource Pool
129
        sqlserver.resource_pool.disk.operations:
130
          enabled: true
131
        sqlserver.resource_pool.disk.throttled.read.rate:
132
          enabled: true
133
        sqlserver.resource_pool.disk.throttled.write.rate:
134
          enabled: true
135
        # Replica / Always-On
136
        sqlserver.replica.data.rate:
137
          enabled: true
138
        sqlserver.failover_cluster.ag.cluster_type:
139
          enabled: true
140
        sqlserver.failover_cluster.ag.failure_condition_level:
141
          enabled: true
142
        sqlserver.failover_cluster.ag.health_check_timeout:
143
          enabled: true
144
        sqlserver.failover_cluster.ag.required_sync_secondaries:
145
          enabled: true
146
        sqlserver.failover_cluster.replica.database.queue_size:
147
          enabled: true
148
        sqlserver.failover_cluster.replica.database.redo.rate:
149
          enabled: true
150
        sqlserver.failover_cluster.replica.flow_control_time:
151
          enabled: true
152
        sqlserver.failover_cluster.replica.role:
153
          enabled: true
154
        sqlserver.failover_cluster.replica.synchronization_health:
155
          enabled: true
156
        # Server Properties
157
        sqlserver.computer.uptime:
158
          enabled: true
159
        sqlserver.cpu.count:
160
          enabled: true
161
        # Tables
162
        sqlserver.table.count:
163
          enabled: true
164

165
      # Enable query sample, top query, query plan, and top procedure log collection
166
      events:
167
        db.server.query_sample:
168
          enabled: true
169
        db.server.top_query:
170
          enabled: true
171
        db.server.query_plan:
172
          enabled: true
173
        db.server.top_procedure:
174
          enabled: true
175

176
      # Top query collection configuration
177
      top_query_collection:
178
        lookback_time: 60s
179
        max_query_sample_count: 1000
180
        top_query_count: 250
181
        collection_interval: 60s
182
        collect_full_query_text: true
183
        allowed_comment_keys:
184
          - nr_service_guid
185

186
      # Query sample collection configuration
187
      query_sample_collection:
188
        max_rows_per_query: 100
189
        collect_full_query_text: true
190
        allowed_comment_keys:
191
          - nr_service_guid
192

193
      # Top stored procedure collection configuration
194
      top_procedure_collection:
195
        max_procedure_sample_count: 1000
196
        top_procedure_count: 250
197
        collection_interval: 60s
198

199
      resource_attributes:
200
        db.system.version:
201
          enabled: true
202
        sqlserver.db.edition:
203
          enabled: true
204

205
processors:
206
    memory_limiter:
207
      check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
208
      limit_mib: ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
209
      spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}
210

211
exporters:
212
    otlp:
213
      endpoint: https://otlp.nr-data.net:4318
214
      headers:
215
        api-key: YOUR_LICENSE_KEY
216
      tls:
217
        insecure: false
218
      compression: gzip
219

220
      sending_queue:
221
        enabled: true
222
        sizer: bytes
223
        queue_size: 100_000_000
224
        num_consumers: 10
225
        batch:
226
          sizer: bytes
227
          max_size: 1_000_000
228
          min_size: 0
229
          flush_timeout: 5s
230

231
service:
232
    telemetry:
233
      metrics:
234
        level: none
235

236
    pipelines:
237
      metrics:
238
        receivers: [nrsqlserver]
239
        processors: [memory_limiter]
240
        exporters: [otlp]
241

242
      logs:
243
        receivers: [nrsqlserver]
244
        processors: [memory_limiter]
245
        exporters: [otlp]

Once you've downloaded or pasted the full configuration into your mssql-config.yaml file, follow the Windows RDS guide to complete the setup using Windows authentication.

This configuration provides comprehensive database monitoring for Windows environments connecting to AWS RDS SQL Server instances using Group Managed Service Account (gMSA) authentication with integrated security.

RDS Endpoint

RDS Port

New Relic OTLP Endpoint with port number

New Relic License Key

mssql-config.yaml

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
        # Database
9
        sqlserver.database.count:
10
          enabled: true
11
        sqlserver.database.file.size:
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.transactions.active:
20
          enabled: true
21
        sqlserver.database.backup_or_restore.rate:
22
          enabled: true
23
        sqlserver.database.full_scan.rate:
24
          enabled: true
25
        sqlserver.database.tempdb.space:
26
          enabled: true
27
        sqlserver.database.tempdb.version_store.size:
28
          enabled: true
29
        # Locks
30
        sqlserver.lock.timeout.rate:
31
          enabled: true
32
        sqlserver.lock.wait.count:
33
          enabled: true
34
        sqlserver.deadlock.rate:
35
          enabled: true
36
        # Transactions
37
        sqlserver.transaction.delay:
38
          enabled: true
39
        sqlserver.transaction.longest_running_time:
40
          enabled: true
41
        sqlserver.transaction.version_cleanup.rate:
42
          enabled: true
43
        sqlserver.transaction.version_generation.rate:
44
          enabled: true
45
        # Memory
46
        sqlserver.memory.area:
47
          enabled: true
48
        sqlserver.memory.cache.object.count:
49
          enabled: true
50
        sqlserver.memory.grants.pending.count:
51
          enabled: true
52
        sqlserver.memory.page.count:
53
          enabled: true
54
        sqlserver.memory.usage:
55
          enabled: true
56
        # OS
57
        sqlserver.os.memory.usage:
58
          enabled: true
59
        sqlserver.os.memory.utilization:
60
          enabled: true
61
        sqlserver.os.scheduler.runnable_tasks.count:
62
          enabled: true
63
        sqlserver.os.wait.duration:
64
          enabled: true
65
        sqlserver.os.wait.tasks.count:
66
          enabled: true
67
        # Pages / Buffer
68
        sqlserver.page.buffer_cache.free_list.stalls.rate:
69
          enabled: true
70
        sqlserver.page.lookup.rate:
71
          enabled: true
72
        # Batch / Compilation
73
        sqlserver.batch.compilation.utilization:
74
          enabled: true
75
        sqlserver.batch.page_split.utilization:
76
          enabled: true
77
        sqlserver.recompilation.ratio:
78
          enabled: true
79
        sqlserver.parameterization.rate:
80
          enabled: true
81
        sqlserver.plan.execution.rate:
82
          enabled: true
83
        sqlserver.attention.rate:
84
          enabled: true
85
        # Processes / Connections
86
        sqlserver.process.count:
87
          enabled: true
88
        sqlserver.processes.blocked:
89
          enabled: true
90
        sqlserver.login.rate:
91
          enabled: true
92
        sqlserver.logout.rate:
93
          enabled: true
94
        # Thread Pool
95
        sqlserver.thread_pool.tasks.count:
96
          enabled: true
97
        sqlserver.thread_pool.workers.count:
98
          enabled: true
99
        sqlserver.thread_pool.workers.max:
100
          enabled: true
101
        sqlserver.thread_pool.workers.utilization:
102
          enabled: true
103
        # TempDB
104
        sqlserver.tempdb.allocation.wait_time.total:
105
          enabled: true
106
        sqlserver.tempdb.contention.waiters.count:
107
          enabled: true
108
        sqlserver.tempdb.data_files.count:
109
          enabled: true
110
        sqlserver.tempdb.file.size:
111
          enabled: true
112
        sqlserver.tempdb.space.usage:
113
          enabled: true
114
        # Latch
115
        sqlserver.latch.superlatch.count:
116
          enabled: true
117
        sqlserver.latch.superlatch.transition.rate:
118
          enabled: true
119
        sqlserver.latch.wait.rate:
120
          enabled: true
121
        sqlserver.latch.wait_time.avg:
122
          enabled: true
123
        sqlserver.latch.wait_time.total:
124
          enabled: true
125
        # Index
126
        sqlserver.index.search.rate:
127
          enabled: true
128
        # Resource Pool
129
        sqlserver.resource_pool.disk.operations:
130
          enabled: true
131
        sqlserver.resource_pool.disk.throttled.read.rate:
132
          enabled: true
133
        sqlserver.resource_pool.disk.throttled.write.rate:
134
          enabled: true
135
        # Replica / Always-On
136
        sqlserver.replica.data.rate:
137
          enabled: true
138
        sqlserver.failover_cluster.ag.cluster_type:
139
          enabled: true
140
        sqlserver.failover_cluster.ag.failure_condition_level:
141
          enabled: true
142
        sqlserver.failover_cluster.ag.health_check_timeout:
143
          enabled: true
144
        sqlserver.failover_cluster.ag.required_sync_secondaries:
145
          enabled: true
146
        sqlserver.failover_cluster.replica.database.queue_size:
147
          enabled: true
148
        sqlserver.failover_cluster.replica.database.redo.rate:
149
          enabled: true
150
        sqlserver.failover_cluster.replica.flow_control_time:
151
          enabled: true
152
        sqlserver.failover_cluster.replica.role:
153
          enabled: true
154
        sqlserver.failover_cluster.replica.synchronization_health:
155
          enabled: true
156
        # Server Properties
157
        sqlserver.computer.uptime:
158
          enabled: true
159
        sqlserver.cpu.count:
160
          enabled: true
161
        # Tables
162
        sqlserver.table.count:
163
          enabled: true
164

165
      # Enable query sample, top query, query plan, and top procedure log collection
166
      events:
167
        db.server.query_sample:
168
          enabled: true
169
        db.server.top_query:
170
          enabled: true
171
        db.server.query_plan:
172
          enabled: true
173
        db.server.top_procedure:
174
          enabled: true
175

176
      # Top query collection configuration
177
      top_query_collection:
178
        lookback_time: 60s
179
        max_query_sample_count: 1000
180
        top_query_count: 250
181
        collection_interval: 60s
182
        collect_full_query_text: true
183
        allowed_comment_keys:
184
          - nr_service_guid
185

186
      # Query sample collection configuration
187
      query_sample_collection:
188
        max_rows_per_query: 100
189
        collect_full_query_text: true
190
        allowed_comment_keys:
191
          - nr_service_guid
192

193
      # Top stored procedure collection configuration
194
      top_procedure_collection:
195
        max_procedure_sample_count: 1000
196
        top_procedure_count: 250
197
        collection_interval: 60s
198

199
      resource_attributes:
200
        db.system.version:
201
          enabled: true
202
        sqlserver.db.edition:
203
          enabled: true
204

205
processors:
206
    memory_limiter:
207
      check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
208
      limit_mib: ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
209
      spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}
210

211
exporters:
212
    otlp:
213
      endpoint: https://otlp.nr-data.net:4318
214
      headers:
215
        api-key: YOUR_LICENSE_KEY
216
      tls:
217
        insecure: false
218
      compression: gzip
219

220
      sending_queue:
221
        enabled: true
222
        sizer: bytes
223
        queue_size: 100_000_000
224
        num_consumers: 10
225
        batch:
226
          sizer: bytes
227
          max_size: 1_000_000
228
          min_size: 0
229
          flush_timeout: 5s
230

231
service:
232
    telemetry:
233
      metrics:
234
        level: none
235

236
    pipelines:
237
      metrics:
238
        receivers: [nrsqlserver]
239
        processors: [memory_limiter]
240
        exporters: [otlp]
241

242
      logs:
243
        receivers: [nrsqlserver]
244
        processors: [memory_limiter]
245
        exporters: [otlp]

Once you've downloaded or pasted the full configuration into your mssql-config.yaml file, follow the Windows RDS guide to complete the setup using gMSA authentication.

Configure the receiver

You can use max_concurrent_queries to control how many metric queries the receiver executes in parallel against SQL Server during each scrape cycle. The default value is 4 if omitted or set to 0.

receivers:
  nrsqlserver:
    max_concurrent_queries: 4  # default is 4 if omitted or set to 0

Set up APM-database correlation

Learn how to correlate your application performance with database operations in New Relic.

Metrics reference

Learn about the available metrics collected by the NRDOT Collector.

Troubleshooting

Learn how to troubleshoot your MSSQL monitoring setup in New Relic.

Configuration reference for Microsoft SQL Server monitoring with NRDOT

Important

For Linux

For Linux self-hosted

For Linux RDS

For Windows

For Windows self-hosted - SQL Server authentication

For Windows self-hosted - Windows domain authentication

For Windows self-hosted - gMSA authentication

For Windows RDS - SQL Server authentication

For Windows RDS - Windows domain authentication

For Windows RDS - gMSA authentication

Configure the receiver

Set up APM-database correlation

Metrics reference

Troubleshooting

Configuration reference for Microsoft SQL Server monitoring with NRDOT

Important

For Linux .css-21sua1{background:none;border:none;width:0;padding:0;}

For Linux RDS

For Windows

For Windows self-hosted - SQL Server authentication

For Windows self-hosted - Windows domain authentication

For Windows self-hosted - gMSA authentication

For Windows RDS - SQL Server authentication

For Windows RDS - Windows domain authentication

For Windows RDS - gMSA authentication

Configure the receiver

Related documentation

Set up APM-database correlation

Metrics reference

Troubleshooting

For Linux