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 includes both infrastructure host metrics and database monitoring for comprehensive visibility in Linux self-hosted environments.

Database Username

Database Password

SQL Server Hostname/IP

SQL Server Port

New Relic OTLP Endpoint

New Relic License Key

mssql-config.yaml

1
extensions:
2
    health_check:
3

4
receivers:
5
    otlp:
6
      protocols:
7
        grpc:
8
        http:
9

10
    host_metrics:
11
      collection_interval: 30s
12
      scrapers:
13
        cpu:
14
          metrics:
15
            system.cpu.time:
16
              enabled: false
17
            system.cpu.utilization:
18
              enabled: true
19
        load:
20
        memory:
21
          metrics:
22
            system.memory.utilization:
23
              enabled: true
24
        paging:
25
          metrics:
26
            system.paging.utilization:
27
              enabled: false
28
            system.paging.faults:
29
              enabled: false
30
        disk:
31
          metrics:
32
            system.disk.merged:
33
              enabled: false
34
            system.disk.pending_operations:
35
              enabled: false
36
            system.disk.weighted_io_time:
37
              enabled: false
38
        network:
39
          metrics:
40
            system.network.connections:
41
              enabled: false
42
        processes:
43
        process:
44
          mute_process_name_error: true
45
          mute_process_exe_error: true
46
          mute_process_user_error: true
47
          mute_process_io_error: true
48
          metrics:
49
            process.cpu.utilization:
50
              enabled: true
51
            process.memory.utilization:
52
              enabled: true
53

54
    nrsqlserver:
55
      collection_interval: 30s
56
      username: newrelic
57
      password: YOUR_PASSWORD
58
      server: sqlserver.example.com
59
      port: 1433
60

61
      # Enable comprehensive database metrics
62
      metrics:
63
        # Database
64
        sqlserver.database.count:
65
          enabled: true
66
        sqlserver.database.file.size:
67
          enabled: true 
68
        sqlserver.database.io:
69
          enabled: true
70
        sqlserver.database.latency:
71
          enabled: true
72
        sqlserver.database.operations:
73
          enabled: true
74
        sqlserver.database.transactions.active:
75
          enabled: true
76
        sqlserver.database.backup_or_restore.rate:
77
          enabled: true
78
        sqlserver.database.execution.errors:
79
          enabled: true
80
        sqlserver.database.full_scan.rate:
81
          enabled: true
82
        sqlserver.database.tempdb.space:
83
          enabled: true
84
        sqlserver.database.tempdb.version_store.size:
85
          enabled: true
86
        # Locks
87
        sqlserver.lock.timeout.rate:
88
          enabled: true
89
        sqlserver.lock.wait.count:
90
          enabled: true
91
        sqlserver.deadlock.rate:
92
          enabled: true
93
        # Transactions
94
        sqlserver.transaction.delay:
95
          enabled: true
96
        sqlserver.transaction.longest_running_time:
97
          enabled: true
98
        sqlserver.transaction.version_cleanup.rate:
99
          enabled: true
100
        sqlserver.transaction.version_generation.rate:
101
          enabled: true
102
        # Memory
103
        sqlserver.memory.area:
104
          enabled: true
105
        sqlserver.memory.cache.object.count:
106
          enabled: true
107
        sqlserver.memory.grants.pending.count:
108
          enabled: true
109
        sqlserver.memory.page.count:
110
          enabled: true
111
        sqlserver.memory.usage:
112
          enabled: true
113
        # OS
114
        sqlserver.os.memory.usage:
115
          enabled: true
116
        sqlserver.os.memory.utilization:
117
          enabled: true
118
        sqlserver.os.scheduler.runnable_tasks.count:
119
          enabled: true
120
        sqlserver.os.wait.duration:
121
          enabled: true
122
        sqlserver.os.wait.tasks.count:
123
          enabled: true
124
        # Pages / Buffer
125
        sqlserver.page.buffer_cache.free_list.stalls.rate:
126
          enabled: true
127
        sqlserver.page.lookup.rate:
128
          enabled: true
129
        # Batch / Compilation
130
        sqlserver.batch.compilation.utilization:
131
          enabled: true
132
        sqlserver.batch.page_split.utilization:
133
          enabled: true
134
        sqlserver.recompilation.ratio:
135
          enabled: true
136
        sqlserver.parameterization.rate:
137
          enabled: true
138
        sqlserver.plan.execution.rate:
139
          enabled: true
140
        sqlserver.attention.rate:
141
          enabled: true
142
        # Processes / Connections
143
        sqlserver.process.count:
144
          enabled: true
145
        sqlserver.processes.blocked:
146
          enabled: true
147
        sqlserver.login.rate:
148
          enabled: true
149
        sqlserver.logout.rate:
150
          enabled: true
151
        # Thread Pool
152
        sqlserver.thread_pool.tasks.count:
153
          enabled: true
154
        sqlserver.thread_pool.workers.count:
155
          enabled: true
156
        sqlserver.thread_pool.workers.max:
157
          enabled: true
158
        sqlserver.thread_pool.workers.utilization:
159
          enabled: true
160
        # TempDB
161
        sqlserver.tempdb.allocation.wait_time.total:
162
          enabled: true
163
        sqlserver.tempdb.contention.waiters.count:
164
          enabled: true
165
        sqlserver.tempdb.data_files.count:
166
          enabled: true
167
        sqlserver.tempdb.file.size:
168
          enabled: true
169
        sqlserver.tempdb.space.usage:
170
          enabled: true
171
        # Latch
172
        sqlserver.latch.superlatch.count:
173
          enabled: true
174
        sqlserver.latch.superlatch.transition.rate:
175
          enabled: true
176
        sqlserver.latch.wait.rate:
177
          enabled: true
178
        sqlserver.latch.wait_time.avg:
179
          enabled: true
180
        sqlserver.latch.wait_time.total:
181
          enabled: true
182
        # Index
183
        sqlserver.index.search.rate:
184
          enabled: true
185
        # Resource Pool
186
        sqlserver.resource_pool.disk.operations:
187
          enabled: true
188
        sqlserver.resource_pool.disk.throttled.read.rate:
189
          enabled: true
190
        sqlserver.resource_pool.disk.throttled.write.rate:
191
          enabled: true
192
        # Replica / Always-On
193
        sqlserver.replica.data.rate:
194
          enabled: true
195
        sqlserver.failover_cluster.ag.cluster_type:
196
          enabled: true
197
        sqlserver.failover_cluster.ag.failure_condition_level:
198
          enabled: true
199
        sqlserver.failover_cluster.ag.health_check_timeout:
200
          enabled: true
201
        sqlserver.failover_cluster.ag.required_sync_secondaries:
202
          enabled: true
203
        sqlserver.failover_cluster.replica.database.queue_size:
204
          enabled: true
205
        sqlserver.failover_cluster.replica.database.redo.rate:
206
          enabled: true
207
        sqlserver.failover_cluster.replica.flow_control_time:
208
          enabled: true
209
        sqlserver.failover_cluster.replica.role:
210
          enabled: true
211
        sqlserver.failover_cluster.replica.synchronization_health:
212
          enabled: true
213
        # Server Properties
214
        sqlserver.computer.uptime:
215
          enabled: true
216
        sqlserver.cpu.count:
217
          enabled: true
218
        # Tables
219
        sqlserver.table.count:
220
          enabled: true
221

222
      # Enable top query and query sample log collection
223
      events:
224
        db.server.query_sample:
225
          enabled: true
226
        db.server.top_query:
227
          enabled: true
228

229
      # Top query collection configuration
230
      top_query_collection:
231
        lookback_time: 45s
232
        max_query_sample_count: 100
233
        top_query_count: 30
234
        collection_interval: 30s
235

236
      collect_full_query_text: true
237
      allowed_comment_keys:
238
        - nr_service_guid
239

240
      # Query sample collection configuration
241
      query_sample_collection:
242
        max_rows_per_query: 50
243

244
processors:
245
    metrics_transform:
246
      transforms:
247
        - include: system.cpu.utilization
248
          action: update
249
          operations:
250
            - action: aggregate_labels
251
              label_set: [state]
252
              aggregation_type: mean
253
        - include: system.paging.operations
254
          action: update
255
          operations:
256
            - action: aggregate_labels
257
              label_set: [direction]
258
              aggregation_type: sum
259

260
    filter/exclude_cpu_utilization:
261
      metrics:
262
        datapoint:
263
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "interrupt"'
264
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "nice"'
265
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "softirq"'
266

267
    filter/exclude_memory_utilization:
268
      metrics:
269
        datapoint:
270
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_unreclaimable"'
271
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "inactive"'
272
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "cached"'
273
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "buffered"'
274
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_reclaimable"'
275

276
    filter/exclude_memory_usage:
277
      metrics:
278
        datapoint:
279
          - 'metric.name == "system.memory.usage" and attributes["state"] == "slab_unreclaimable"'
280
          - 'metric.name == "system.memory.usage" and attributes["state"] == "inactive"'
281

282
    filter/exclude_filesystem_utilization:
283
      metrics:
284
        datapoint:
285
          - 'metric.name == "system.filesystem.utilization" and attributes["type"] == "squashfs"'
286

287
    filter/exclude_filesystem_usage:
288
      metrics:
289
        datapoint:
290
          - 'metric.name == "system.filesystem.usage" and attributes["type"] == "squashfs"'
291
          - 'metric.name == "system.filesystem.usage" and attributes["state"] == "reserved"'
292

293
    filter/exclude_filesystem_inodes_usage:
294
      metrics:
295
        datapoint:
296
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["type"] == "squashfs"'
297
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["state"] == "reserved"'
298

299
    filter/exclude_system_disk:
300
      metrics:
301
        datapoint:
302
          - 'metric.name == "system.disk.operations" and IsMatch(attributes["device"], "^loop.*") == true'
303
          - 'metric.name == "system.disk.merged" and IsMatch(attributes["device"], "^loop.*") == true'
304
          - 'metric.name == "system.disk.io" and IsMatch(attributes["device"], "^loop.*") == true'
305
          - 'metric.name == "system.disk.io_time" and IsMatch(attributes["device"], "^loop.*") == true'
306
          - 'metric.name == "system.disk.operation_time" and IsMatch(attributes["device"], "^loop.*") == true'
307

308
    filter/exclude_network:
309
      metrics:
310
        datapoint:
311
          - 'IsMatch(metric.name, "^system.network.*") == true and attributes["device"] == "lo"'
312

313
    attributes/exclude_system_paging:
314
      include:
315
        match_type: strict
316
        metric_names:
317
          - system.paging.operations
318
      actions:
319
        - key: type
320
          action: delete
321

322
    cumulative_to_delta:
323

324
    transform/host:
325
      metric_statements:
326
        - context: metric
327
          statements:
328
            - set(metric.description, "")
329
            - set(metric.unit, "")
330

331
    batch:
332

333
    batch/logs:
334
      send_batch_size: 15          # flush target: ~15 records per request
335
      send_batch_max_size: 15      # HARD cap: never emit more than 15 records/request
336
      timeout: 5s
337

338
    resource_detection:
339
      detectors: ["system"]
340
      system:
341
        hostname_sources: ["os"]
342
        resource_attributes:
343
          host.id:
344
            enabled: true
345

346
    resource_detection/cloud:
347
      detectors: ["gcp", "ec2", "azure"]
348
      timeout: 2s
349
      override: true
350

351
    resource_detection/env:
352
      detectors: ["env"]
353
      timeout: 2s
354
      override: true
355

356
exporters:
357
    otlp:
358
      endpoint: https://otlp.nr-data.net:4318
359
      headers:
360
        api-key: YOUR_LICENSE_KEY
361
      tls:
362
        insecure: false
363
      compression: gzip
364

365
service:
366
    telemetry:
367
      metrics:
368
        level: none
369

370
    extensions: [health_check]
371

372
    pipelines:
373
      metrics/host:
374
        receivers: [host_metrics, nrsqlserver]
375
        processors:
376
          - metrics_transform
377
          - filter/exclude_cpu_utilization
378
          - filter/exclude_memory_utilization
379
          - filter/exclude_memory_usage
380
          - filter/exclude_filesystem_utilization
381
          - filter/exclude_filesystem_usage
382
          - filter/exclude_filesystem_inodes_usage
383
          - filter/exclude_system_disk
384
          - filter/exclude_network
385
          - attributes/exclude_system_paging
386
          - transform/host
387
          - resource_detection
388
          - resource_detection/cloud
389
          - resource_detection/env
390
          - cumulative_to_delta
391
          - batch
392
        exporters: [otlp]
393

394
      logs/host:
395
        receivers: [nrsqlserver]
396
        processors:
397
          - resource_detection
398
          - resource_detection/cloud
399
          - resource_detection/env
400
          - batch/logs
401
        exporters: [otlp]
402

403
      traces:
404
        receivers: [otlp]
405
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
406
        exporters: [otlp]
407

408
      metrics:
409
        receivers: [otlp]
410
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
411
        exporters: [otlp]
412

413
      logs:
414
        receivers: [otlp]
415
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
416
        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

New Relic License Key

mssql-config.yaml

1
extensions:
2
    health_check:
3

4
receivers:
5
    otlp:
6
      protocols:
7
        grpc:
8
        http:
9

10
    host_metrics:
11
      collection_interval: 30s
12
      scrapers:
13
        cpu:
14
          metrics:
15
            system.cpu.time:
16
              enabled: false
17
            system.cpu.utilization:
18
              enabled: true
19
        load:
20
        memory:
21
          metrics:
22
            system.memory.utilization:
23
              enabled: true
24
        paging:
25
          metrics:
26
            system.paging.utilization:
27
              enabled: false
28
            system.paging.faults:
29
              enabled: false
30
        disk:
31
          metrics:
32
            system.disk.merged:
33
              enabled: false
34
            system.disk.pending_operations:
35
              enabled: false
36
            system.disk.weighted_io_time:
37
              enabled: false
38
        network:
39
          metrics:
40
            system.network.connections:
41
              enabled: false
42
        processes:
43
        process:
44
          mute_process_name_error: true
45
          mute_process_exe_error: true
46
          mute_process_user_error: true
47
          mute_process_io_error: true
48
          metrics:
49
            process.cpu.utilization:
50
              enabled: true
51
            process.memory.utilization:
52
              enabled: true
53

54
    nrsqlserver:
55
      collection_interval: 30s
56
      username: newrelic
57
      password: YOUR_PASSWORD
58
      server: mydb-instance.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com
59
      port: 1433
60

61
      # Enable comprehensive database metrics
62
      metrics:
63
        # Database
64
        sqlserver.database.count:
65
          enabled: true
66
        sqlserver.database.file.size:
67
          enabled: true 
68
        sqlserver.database.io:
69
          enabled: true
70
        sqlserver.database.latency:
71
          enabled: true
72
        sqlserver.database.operations:
73
          enabled: true
74
        sqlserver.database.transactions.active:
75
          enabled: true
76
        sqlserver.database.backup_or_restore.rate:
77
          enabled: true
78
        sqlserver.database.full_scan.rate:
79
          enabled: true
80
        sqlserver.database.tempdb.space:
81
          enabled: true
82
        sqlserver.database.tempdb.version_store.size:
83
          enabled: true
84
        # Locks
85
        sqlserver.lock.timeout.rate:
86
          enabled: true
87
        sqlserver.lock.wait.count:
88
          enabled: true
89
        sqlserver.deadlock.rate:
90
          enabled: true
91
        # Transactions
92
        sqlserver.transaction.delay:
93
          enabled: true
94
        sqlserver.transaction.longest_running_time:
95
          enabled: true
96
        sqlserver.transaction.version_cleanup.rate:
97
          enabled: true
98
        sqlserver.transaction.version_generation.rate:
99
          enabled: true
100
        # Memory
101
        sqlserver.memory.area:
102
          enabled: true
103
        sqlserver.memory.cache.object.count:
104
          enabled: true
105
        sqlserver.memory.grants.pending.count:
106
          enabled: true
107
        sqlserver.memory.page.count:
108
          enabled: true
109
        sqlserver.memory.usage:
110
          enabled: true
111
        # OS
112
        sqlserver.os.memory.usage:
113
          enabled: true
114
        sqlserver.os.memory.utilization:
115
          enabled: true
116
        sqlserver.os.scheduler.runnable_tasks.count:
117
          enabled: true
118
        sqlserver.os.wait.duration:
119
          enabled: true
120
        sqlserver.os.wait.tasks.count:
121
          enabled: true
122
        # Pages / Buffer
123
        sqlserver.page.buffer_cache.free_list.stalls.rate:
124
          enabled: true
125
        sqlserver.page.lookup.rate:
126
          enabled: true
127
        # Batch / Compilation
128
        sqlserver.batch.compilation.utilization:
129
          enabled: true
130
        sqlserver.batch.page_split.utilization:
131
          enabled: true
132
        sqlserver.recompilation.ratio:
133
          enabled: true
134
        sqlserver.parameterization.rate:
135
          enabled: true
136
        sqlserver.plan.execution.rate:
137
          enabled: true
138
        sqlserver.attention.rate:
139
          enabled: true
140
        # Processes / Connections
141
        sqlserver.process.count:
142
          enabled: true
143
        sqlserver.processes.blocked:
144
          enabled: true
145
        sqlserver.login.rate:
146
          enabled: true
147
        sqlserver.logout.rate:
148
          enabled: true
149
        # Thread Pool
150
        sqlserver.thread_pool.tasks.count:
151
          enabled: true
152
        sqlserver.thread_pool.workers.count:
153
          enabled: true
154
        sqlserver.thread_pool.workers.max:
155
          enabled: true
156
        sqlserver.thread_pool.workers.utilization:
157
          enabled: true
158
        # TempDB
159
        sqlserver.tempdb.allocation.wait_time.total:
160
          enabled: true
161
        sqlserver.tempdb.contention.waiters.count:
162
          enabled: true
163
        sqlserver.tempdb.data_files.count:
164
          enabled: true
165
        sqlserver.tempdb.file.size:
166
          enabled: true
167
        sqlserver.tempdb.space.usage:
168
          enabled: true
169
        # Latch
170
        sqlserver.latch.superlatch.count:
171
          enabled: true
172
        sqlserver.latch.superlatch.transition.rate:
173
          enabled: true
174
        sqlserver.latch.wait.rate:
175
          enabled: true
176
        sqlserver.latch.wait_time.avg:
177
          enabled: true
178
        sqlserver.latch.wait_time.total:
179
          enabled: true
180
        # Index
181
        sqlserver.index.search.rate:
182
          enabled: true
183
        # Resource Pool
184
        sqlserver.resource_pool.disk.operations:
185
          enabled: true
186
        sqlserver.resource_pool.disk.throttled.read.rate:
187
          enabled: true
188
        sqlserver.resource_pool.disk.throttled.write.rate:
189
          enabled: true
190
        # Replica / Always-On
191
        sqlserver.replica.data.rate:
192
          enabled: true
193
        sqlserver.failover_cluster.ag.cluster_type:
194
          enabled: true
195
        sqlserver.failover_cluster.ag.failure_condition_level:
196
          enabled: true
197
        sqlserver.failover_cluster.ag.health_check_timeout:
198
          enabled: true
199
        sqlserver.failover_cluster.ag.required_sync_secondaries:
200
          enabled: true
201
        sqlserver.failover_cluster.replica.database.queue_size:
202
          enabled: true
203
        sqlserver.failover_cluster.replica.database.redo.rate:
204
          enabled: true
205
        sqlserver.failover_cluster.replica.flow_control_time:
206
          enabled: true
207
        sqlserver.failover_cluster.replica.role:
208
          enabled: true
209
        sqlserver.failover_cluster.replica.synchronization_health:
210
          enabled: true
211
        # Server Properties
212
        sqlserver.computer.uptime:
213
          enabled: true
214
        sqlserver.cpu.count:
215
          enabled: true
216
        # Tables
217
        sqlserver.table.count:
218
          enabled: true
219
      # Enable top query and query sample log collection
220
      events:
221
        db.server.query_sample:
222
          enabled: true
223
        db.server.top_query:
224
          enabled: true
225
      # Top query collection configuration
226
      top_query_collection:
227
        lookback_time: 45s
228
        max_query_sample_count: 100
229
        top_query_count: 30
230
        collection_interval: 30s
231
      collect_full_query_text: true
232
      allowed_comment_keys:
233
        - nr_service_guid
234
      # Query sample collection configuration
235
      query_sample_collection:
236
        max_rows_per_query: 50
237
processors:
238
    metrics_transform:
239
      transforms:
240
        - include: system.cpu.utilization
241
          action: update
242
          operations:
243
            - action: aggregate_labels
244
              label_set: [state]
245
              aggregation_type: mean
246
        - include: system.paging.operations
247
          action: update
248
          operations:
249
            - action: aggregate_labels
250
              label_set: [direction]
251
              aggregation_type: sum
252
    filter/exclude_cpu_utilization:
253
      metrics:
254
        datapoint:
255
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "interrupt"'
256
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "nice"'
257
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "softirq"'
258
    filter/exclude_memory_utilization:
259
      metrics:
260
        datapoint:
261
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_unreclaimable"'
262
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "inactive"'
263
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "cached"'
264
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "buffered"'
265
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_reclaimable"'
266
    filter/exclude_memory_usage:
267
      metrics:
268
        datapoint:
269
          - 'metric.name == "system.memory.usage" and attributes["state"] == "slab_unreclaimable"'
270
          - 'metric.name == "system.memory.usage" and attributes["state"] == "inactive"'
271
    filter/exclude_filesystem_utilization:
272
      metrics:
273
        datapoint:
274
          - 'metric.name == "system.filesystem.utilization" and attributes["type"] == "squashfs"'
275
    filter/exclude_filesystem_usage:
276
      metrics:
277
        datapoint:
278
          - 'metric.name == "system.filesystem.usage" and attributes["type"] == "squashfs"'
279
          - 'metric.name == "system.filesystem.usage" and attributes["state"] == "reserved"'
280
    filter/exclude_filesystem_inodes_usage:
281
      metrics:
282
        datapoint:
283
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["type"] == "squashfs"'
284
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["state"] == "reserved"'
285
    filter/exclude_system_disk:
286
      metrics:
287
        datapoint:
288
          - 'metric.name == "system.disk.operations" and IsMatch(attributes["device"], "^loop.*") == true'
289
          - 'metric.name == "system.disk.merged" and IsMatch(attributes["device"], "^loop.*") == true'
290
          - 'metric.name == "system.disk.io" and IsMatch(attributes["device"], "^loop.*") == true'
291
          - 'metric.name == "system.disk.io_time" and IsMatch(attributes["device"], "^loop.*") == true'
292
          - 'metric.name == "system.disk.operation_time" and IsMatch(attributes["device"], "^loop.*") == true'
293
    filter/exclude_network:
294
      metrics:
295
        datapoint:
296
          - 'IsMatch(metric.name, "^system.network.*") == true and attributes["device"] == "lo"'
297
    attributes/exclude_system_paging:
298
      include:
299
        match_type: strict
300
        metric_names:
301
          - system.paging.operations
302
      actions:
303
        - key: type
304
          action: delete
305
    cumulative_to_delta:
306
    transform/host:
307
      metric_statements:
308
        - context: metric
309
          statements:
310
            - set(metric.description, "")
311
            - set(metric.unit, "")
312
    batch:
313

314
    batch/logs:
315
      send_batch_size: 15          # flush target: ~15 records per request
316
      send_batch_max_size: 15      # HARD cap: never emit more than 15 records/request
317
      timeout: 5s
318

319
    resource_detection:
320
      detectors: ["system"]
321
      system:
322
        hostname_sources: ["os"]
323
        resource_attributes:
324
          host.id:
325
            enabled: true
326
    resource_detection/cloud:
327
      detectors: ["gcp", "ec2", "azure"]
328
      timeout: 2s
329
      override: true
330
    resource_detection/env:
331
      detectors: ["env"]
332
      timeout: 2s
333
      override: true
334
exporters:
335
    otlp:
336
      endpoint: https://otlp.nr-data.net:4318
337
      headers:
338
        api-key: YOUR_LICENSE_KEY
339
      tls:
340
        insecure: false
341
      compression: gzip
342
service:
343
    telemetry:
344
      metrics:
345
        level: none
346
    extensions: [health_check]
347
    pipelines:
348
      metrics/host:
349
        receivers: [host_metrics, nrsqlserver]
350
        processors:
351
          - metrics_transform
352
          - filter/exclude_cpu_utilization
353
          - filter/exclude_memory_utilization
354
          - filter/exclude_memory_usage
355
          - filter/exclude_filesystem_utilization
356
          - filter/exclude_filesystem_usage
357
          - filter/exclude_filesystem_inodes_usage
358
          - filter/exclude_system_disk
359
          - filter/exclude_network
360
          - attributes/exclude_system_paging
361
          - transform/host
362
          - resource_detection
363
          - resource_detection/cloud
364
          - resource_detection/env
365
          - cumulative_to_delta
366
          - batch
367
        exporters: [otlp]
368
      logs/host:
369
        receivers: [nrsqlserver]
370
        processors:
371
          - resource_detection
372
          - resource_detection/cloud
373
          - resource_detection/env
374
          - batch/logs
375
        exporters: [otlp]
376
      traces:
377
        receivers: [otlp]
378
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
379
        exporters: [otlp]
380
      metrics:
381
        receivers: [otlp]
382
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
383
        exporters: [otlp]
384
      logs:
385
        receivers: [otlp]
386
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
387
        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 monitoring for Windows self-hosted environments using SQL server authentication, including both infrastructure host metrics and database monitoring.

SQL Server Username

SQL Server Password

Server Hostname/IP

Server Port

New Relic OTLP Endpoint

New Relic License Key

mssql-config.yaml

1
extensions:
2
    health_check:
3

4
receivers:
5
    otlp:
6
      protocols:
7
        grpc:
8
        http:
9

10
    host_metrics:
11
      collection_interval: 30s
12
      scrapers:
13
        cpu:
14
          metrics:
15
            system.cpu.time:
16
              enabled: false
17
            system.cpu.utilization:
18
              enabled: true
19
        load:
20
        memory:
21
          metrics:
22
            system.memory.utilization:
23
              enabled: true
24
        paging:
25
          metrics:
26
            system.paging.utilization:
27
              enabled: false
28
            system.paging.faults:
29
              enabled: false
30
        disk:
31
          metrics:
32
            system.disk.merged:
33
              enabled: false
34
            system.disk.pending_operations:
35
              enabled: false
36
            system.disk.weighted_io_time:
37
              enabled: false
38
        network:
39
          metrics:
40
            system.network.connections:
41
              enabled: false
42
        processes:
43
        process:
44
          mute_process_name_error: true
45
          mute_process_exe_error: true
46
          mute_process_user_error: true
47
          mute_process_io_error: true
48
          metrics:
49
            process.cpu.utilization:
50
              enabled: true
51
            process.memory.utilization:
52
              enabled: true
53

54
    nrsqlserver:
55
      collection_interval: 30s
56
      username: newrelic
57
      password: YOUR_PASSWORD
58
      server: sqlserver.example.com
59
      port: 1433
60

61
      # Enable comprehensive database metrics
62
      metrics:
63
        # Database
64
        sqlserver.database.count:
65
          enabled: true
66
        sqlserver.database.file.size:
67
          enabled: true 
68
        sqlserver.database.io:
69
          enabled: true
70
        sqlserver.database.latency:
71
          enabled: true
72
        sqlserver.database.operations:
73
          enabled: true
74
        sqlserver.database.transactions.active:
75
          enabled: true
76
        sqlserver.database.backup_or_restore.rate:
77
          enabled: true
78
        sqlserver.database.execution.errors:
79
          enabled: true
80
        sqlserver.database.full_scan.rate:
81
          enabled: true
82
        sqlserver.database.tempdb.space:
83
          enabled: true
84
        sqlserver.database.tempdb.version_store.size:
85
          enabled: true
86
        # Locks
87
        sqlserver.lock.timeout.rate:
88
          enabled: true
89
        sqlserver.lock.wait.count:
90
          enabled: true
91
        sqlserver.deadlock.rate:
92
          enabled: true
93
        # Transactions
94
        sqlserver.transaction.delay:
95
          enabled: true
96
        sqlserver.transaction.longest_running_time:
97
          enabled: true
98
        sqlserver.transaction.version_cleanup.rate:
99
          enabled: true
100
        sqlserver.transaction.version_generation.rate:
101
          enabled: true
102
        # Memory
103
        sqlserver.memory.area:
104
          enabled: true
105
        sqlserver.memory.cache.object.count:
106
          enabled: true
107
        sqlserver.memory.grants.pending.count:
108
          enabled: true
109
        sqlserver.memory.page.count:
110
          enabled: true
111
        sqlserver.memory.usage:
112
          enabled: true
113
        # OS
114
        sqlserver.os.memory.usage:
115
          enabled: true
116
        sqlserver.os.memory.utilization:
117
          enabled: true
118
        sqlserver.os.scheduler.runnable_tasks.count:
119
          enabled: true
120
        sqlserver.os.wait.duration:
121
          enabled: true
122
        sqlserver.os.wait.tasks.count:
123
          enabled: true
124
        # Pages / Buffer
125
        sqlserver.page.buffer_cache.free_list.stalls.rate:
126
          enabled: true
127
        sqlserver.page.lookup.rate:
128
          enabled: true
129
        # Batch / Compilation
130
        sqlserver.batch.compilation.utilization:
131
          enabled: true
132
        sqlserver.batch.page_split.utilization:
133
          enabled: true
134
        sqlserver.recompilation.ratio:
135
          enabled: true
136
        sqlserver.parameterization.rate:
137
          enabled: true
138
        sqlserver.plan.execution.rate:
139
          enabled: true
140
        sqlserver.attention.rate:
141
          enabled: true
142
        # Processes / Connections
143
        sqlserver.process.count:
144
          enabled: true
145
        sqlserver.processes.blocked:
146
          enabled: true
147
        sqlserver.login.rate:
148
          enabled: true
149
        sqlserver.logout.rate:
150
          enabled: true
151
        # Thread Pool
152
        sqlserver.thread_pool.tasks.count:
153
          enabled: true
154
        sqlserver.thread_pool.workers.count:
155
          enabled: true
156
        sqlserver.thread_pool.workers.max:
157
          enabled: true
158
        sqlserver.thread_pool.workers.utilization:
159
          enabled: true
160
        # TempDB
161
        sqlserver.tempdb.allocation.wait_time.total:
162
          enabled: true
163
        sqlserver.tempdb.contention.waiters.count:
164
          enabled: true
165
        sqlserver.tempdb.data_files.count:
166
          enabled: true
167
        sqlserver.tempdb.file.size:
168
          enabled: true
169
        sqlserver.tempdb.space.usage:
170
          enabled: true
171
        # Latch
172
        sqlserver.latch.superlatch.count:
173
          enabled: true
174
        sqlserver.latch.superlatch.transition.rate:
175
          enabled: true
176
        sqlserver.latch.wait.rate:
177
          enabled: true
178
        sqlserver.latch.wait_time.avg:
179
          enabled: true
180
        sqlserver.latch.wait_time.total:
181
          enabled: true
182
        # Index
183
        sqlserver.index.search.rate:
184
          enabled: true
185
        # Resource Pool
186
        sqlserver.resource_pool.disk.operations:
187
          enabled: true
188
        sqlserver.resource_pool.disk.throttled.read.rate:
189
          enabled: true
190
        sqlserver.resource_pool.disk.throttled.write.rate:
191
          enabled: true
192
        # Replica / Always-On
193
        sqlserver.replica.data.rate:
194
          enabled: true
195
        sqlserver.failover_cluster.ag.cluster_type:
196
          enabled: true
197
        sqlserver.failover_cluster.ag.failure_condition_level:
198
          enabled: true
199
        sqlserver.failover_cluster.ag.health_check_timeout:
200
          enabled: true
201
        sqlserver.failover_cluster.ag.required_sync_secondaries:
202
          enabled: true
203
        sqlserver.failover_cluster.replica.database.queue_size:
204
          enabled: true
205
        sqlserver.failover_cluster.replica.database.redo.rate:
206
          enabled: true
207
        sqlserver.failover_cluster.replica.flow_control_time:
208
          enabled: true
209
        sqlserver.failover_cluster.replica.role:
210
          enabled: true
211
        sqlserver.failover_cluster.replica.synchronization_health:
212
          enabled: true
213
        # Server Properties
214
        sqlserver.computer.uptime:
215
          enabled: true
216
        sqlserver.cpu.count:
217
          enabled: true
218
        # Tables
219
        sqlserver.table.count:
220
          enabled: true
221

222
      # Enable top query and query sample log collection
223
      events:
224
        db.server.query_sample:
225
          enabled: true
226
        db.server.top_query:
227
          enabled: true
228

229
      # Top query collection configuration
230
      top_query_collection:
231
        lookback_time: 45s
232
        max_query_sample_count: 100
233
        top_query_count: 30
234
        collection_interval: 30s
235

236
      collect_full_query_text: true
237
      allowed_comment_keys:
238
        - nr_service_guid
239

240
      # Query sample collection configuration
241
      query_sample_collection:
242
        max_rows_per_query: 50
243

244
processors:
245
    metrics_transform:
246
      transforms:
247
        - include: system.cpu.utilization
248
          action: update
249
          operations:
250
            - action: aggregate_labels
251
              label_set: [state]
252
              aggregation_type: mean
253
        - include: system.paging.operations
254
          action: update
255
          operations:
256
            - action: aggregate_labels
257
              label_set: [direction]
258
              aggregation_type: sum
259

260
    filter/exclude_cpu_utilization:
261
      metrics:
262
        datapoint:
263
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "interrupt"'
264
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "nice"'
265
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "softirq"'
266

267
    filter/exclude_memory_utilization:
268
      metrics:
269
        datapoint:
270
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_unreclaimable"'
271
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "inactive"'
272
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "cached"'
273
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "buffered"'
274
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_reclaimable"'
275

276
    filter/exclude_memory_usage:
277
      metrics:
278
        datapoint:
279
          - 'metric.name == "system.memory.usage" and attributes["state"] == "slab_unreclaimable"'
280
          - 'metric.name == "system.memory.usage" and attributes["state"] == "inactive"'
281

282
    filter/exclude_filesystem_utilization:
283
      metrics:
284
        datapoint:
285
          - 'metric.name == "system.filesystem.utilization" and attributes["type"] == "squashfs"'
286

287
    filter/exclude_filesystem_usage:
288
      metrics:
289
        datapoint:
290
          - 'metric.name == "system.filesystem.usage" and attributes["type"] == "squashfs"'
291
          - 'metric.name == "system.filesystem.usage" and attributes["state"] == "reserved"'
292

293
    filter/exclude_filesystem_inodes_usage:
294
      metrics:
295
        datapoint:
296
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["type"] == "squashfs"'
297
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["state"] == "reserved"'
298

299
    filter/exclude_system_disk:
300
      metrics:
301
        datapoint:
302
          - 'metric.name == "system.disk.operations" and IsMatch(attributes["device"], "^loop.*") == true'
303
          - 'metric.name == "system.disk.merged" and IsMatch(attributes["device"], "^loop.*") == true'
304
          - 'metric.name == "system.disk.io" and IsMatch(attributes["device"], "^loop.*") == true'
305
          - 'metric.name == "system.disk.io_time" and IsMatch(attributes["device"], "^loop.*") == true'
306
          - 'metric.name == "system.disk.operation_time" and IsMatch(attributes["device"], "^loop.*") == true'
307

308
    filter/exclude_network:
309
      metrics:
310
        datapoint:
311
          - 'IsMatch(metric.name, "^system.network.*") == true and attributes["device"] == "lo"'
312

313
    attributes/exclude_system_paging:
314
      include:
315
        match_type: strict
316
        metric_names:
317
          - system.paging.operations
318
      actions:
319
        - key: type
320
          action: delete
321

322
    cumulative_to_delta:
323

324
    transform/host:
325
      metric_statements:
326
        - context: metric
327
          statements:
328
            - set(metric.description, "")
329
            - set(metric.unit, "")
330

331
    batch:
332

333
    batch/logs:
334
      send_batch_size: 15          # flush target: ~15 records per request
335
      send_batch_max_size: 15      # HARD cap: never emit more than 15 records/request
336
      timeout: 5s
337

338
    resource_detection:
339
      detectors: ["system"]
340
      system:
341
        hostname_sources: ["os"]
342
        resource_attributes:
343
          host.id:
344
            enabled: true
345

346
    resource_detection/cloud:
347
      detectors: ["gcp", "ec2", "azure"]
348
      timeout: 2s
349
      override: true
350

351
    resource_detection/env:
352
      detectors: ["env"]
353
      timeout: 2s
354
      override: true
355

356
exporters:
357
    otlp:
358
      endpoint: https://otlp.nr-data.net:4318
359
      headers:
360
        api-key: YOUR_LICENSE_KEY
361
      tls:
362
        insecure: false
363
      compression: gzip
364

365
service:
366
    telemetry:
367
      metrics:
368
        level: none
369

370
    extensions: [health_check]
371

372
    pipelines:
373
      metrics/host:
374
        receivers: [host_metrics, nrsqlserver]
375
        processors:
376
          - metrics_transform
377
          - filter/exclude_cpu_utilization
378
          - filter/exclude_memory_utilization
379
          - filter/exclude_memory_usage
380
          - filter/exclude_filesystem_utilization
381
          - filter/exclude_filesystem_usage
382
          - filter/exclude_filesystem_inodes_usage
383
          - filter/exclude_system_disk
384
          - filter/exclude_network
385
          - attributes/exclude_system_paging
386
          - transform/host
387
          - resource_detection
388
          - resource_detection/cloud
389
          - resource_detection/env
390
          - cumulative_to_delta
391
          - batch
392
        exporters: [otlp]
393

394
      logs/host:
395
        receivers: [nrsqlserver]
396
        processors:
397
          - resource_detection
398
          - resource_detection/cloud
399
          - resource_detection/env
400
          - batch/logs
401
        exporters: [otlp]
402

403
      traces:
404
        receivers: [otlp]
405
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
406
        exporters: [otlp]
407

408
      metrics:
409
        receivers: [otlp]
410
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
411
        exporters: [otlp]
412

413
      logs:
414
        receivers: [otlp]
415
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
416
        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 method.

This configuration provides comprehensive infrastructure host metrics and database monitoring for Windows self-hosted environments using Windows Domain Authentication (integrated security).

Enter your values below and see the configuration update in real-time:

SQL Server Hostname/IP

SQL Server Port

New Relic OTLP Endpoint

New Relic License Key

mssql-config.yaml

1
extensions:
2
    health_check:
3

4
receivers:
5
    otlp:
6
      protocols:
7
        grpc:
8
        http:
9

10
    host_metrics:
11
      collection_interval: 30s
12
      scrapers:
13
        cpu:
14
          metrics:
15
            system.cpu.time:
16
              enabled: false
17
            system.cpu.utilization:
18
              enabled: true
19
        load:
20
        memory:
21
          metrics:
22
            system.memory.utilization:
23
              enabled: true
24
        paging:
25
          metrics:
26
            system.paging.utilization:
27
              enabled: false
28
            system.paging.faults:
29
              enabled: false
30
        disk:
31
          metrics:
32
            system.disk.merged:
33
              enabled: false
34
            system.disk.pending_operations:
35
              enabled: false
36
            system.disk.weighted_io_time:
37
              enabled: false
38
        network:
39
          metrics:
40
            system.network.connections:
41
              enabled: false
42
        processes:
43
        process:
44
          mute_process_name_error: true
45
          mute_process_exe_error: true
46
          mute_process_user_error: true
47
          mute_process_io_error: true
48
          metrics:
49
            process.cpu.utilization:
50
              enabled: true
51
            process.memory.utilization:
52
              enabled: true
53

54
    nrsqlserver:
55
      collection_interval: 30s
56
      datasource: "server=sqlserver.example.com;port=1433;integrated security=true;encrypt=true;TrustServerCertificate=true;"
57

58
      # Enable comprehensive database metrics
59
      metrics:
60
        # Database
61
        sqlserver.database.count:
62
          enabled: true
63
        sqlserver.database.file.size:
64
          enabled: true 
65
        sqlserver.database.io:
66
          enabled: true
67
        sqlserver.database.latency:
68
          enabled: true
69
        sqlserver.database.operations:
70
          enabled: true
71
        sqlserver.database.transactions.active:
72
          enabled: true
73
        sqlserver.database.backup_or_restore.rate:
74
          enabled: true
75
        sqlserver.database.execution.errors:
76
          enabled: true
77
        sqlserver.database.full_scan.rate:
78
          enabled: true
79
        sqlserver.database.tempdb.space:
80
          enabled: true
81
        sqlserver.database.tempdb.version_store.size:
82
          enabled: true
83
        # Locks
84
        sqlserver.lock.timeout.rate:
85
          enabled: true
86
        sqlserver.lock.wait.count:
87
          enabled: true
88
        sqlserver.deadlock.rate:
89
          enabled: true
90
        # Transactions
91
        sqlserver.transaction.delay:
92
          enabled: true
93
        sqlserver.transaction.longest_running_time:
94
          enabled: true
95
        sqlserver.transaction.version_cleanup.rate:
96
          enabled: true
97
        sqlserver.transaction.version_generation.rate:
98
          enabled: true
99
        # Memory
100
        sqlserver.memory.area:
101
          enabled: true
102
        sqlserver.memory.cache.object.count:
103
          enabled: true
104
        sqlserver.memory.grants.pending.count:
105
          enabled: true
106
        sqlserver.memory.page.count:
107
          enabled: true
108
        sqlserver.memory.usage:
109
          enabled: true
110
        # OS
111
        sqlserver.os.memory.usage:
112
          enabled: true
113
        sqlserver.os.memory.utilization:
114
          enabled: true
115
        sqlserver.os.scheduler.runnable_tasks.count:
116
          enabled: true
117
        sqlserver.os.wait.duration:
118
          enabled: true
119
        sqlserver.os.wait.tasks.count:
120
          enabled: true
121
        # Pages / Buffer
122
        sqlserver.page.buffer_cache.free_list.stalls.rate:
123
          enabled: true
124
        sqlserver.page.lookup.rate:
125
          enabled: true
126
        # Batch / Compilation
127
        sqlserver.batch.compilation.utilization:
128
          enabled: true
129
        sqlserver.batch.page_split.utilization:
130
          enabled: true
131
        sqlserver.recompilation.ratio:
132
          enabled: true
133
        sqlserver.parameterization.rate:
134
          enabled: true
135
        sqlserver.plan.execution.rate:
136
          enabled: true
137
        sqlserver.attention.rate:
138
          enabled: true
139
        # Processes / Connections
140
        sqlserver.process.count:
141
          enabled: true
142
        sqlserver.processes.blocked:
143
          enabled: true
144
        sqlserver.login.rate:
145
          enabled: true
146
        sqlserver.logout.rate:
147
          enabled: true
148
        # Thread Pool
149
        sqlserver.thread_pool.tasks.count:
150
          enabled: true
151
        sqlserver.thread_pool.workers.count:
152
          enabled: true
153
        sqlserver.thread_pool.workers.max:
154
          enabled: true
155
        sqlserver.thread_pool.workers.utilization:
156
          enabled: true
157
        # TempDB
158
        sqlserver.tempdb.allocation.wait_time.total:
159
          enabled: true
160
        sqlserver.tempdb.contention.waiters.count:
161
          enabled: true
162
        sqlserver.tempdb.data_files.count:
163
          enabled: true
164
        sqlserver.tempdb.file.size:
165
          enabled: true
166
        sqlserver.tempdb.space.usage:
167
          enabled: true
168
        # Latch
169
        sqlserver.latch.superlatch.count:
170
          enabled: true
171
        sqlserver.latch.superlatch.transition.rate:
172
          enabled: true
173
        sqlserver.latch.wait.rate:
174
          enabled: true
175
        sqlserver.latch.wait_time.avg:
176
          enabled: true
177
        sqlserver.latch.wait_time.total:
178
          enabled: true
179
        # Index
180
        sqlserver.index.search.rate:
181
          enabled: true
182
        # Resource Pool
183
        sqlserver.resource_pool.disk.operations:
184
          enabled: true
185
        sqlserver.resource_pool.disk.throttled.read.rate:
186
          enabled: true
187
        sqlserver.resource_pool.disk.throttled.write.rate:
188
          enabled: true
189
        # Replica / Always-On
190
        sqlserver.replica.data.rate:
191
          enabled: true
192
        sqlserver.failover_cluster.ag.cluster_type:
193
          enabled: true
194
        sqlserver.failover_cluster.ag.failure_condition_level:
195
          enabled: true
196
        sqlserver.failover_cluster.ag.health_check_timeout:
197
          enabled: true
198
        sqlserver.failover_cluster.ag.required_sync_secondaries:
199
          enabled: true
200
        sqlserver.failover_cluster.replica.database.queue_size:
201
          enabled: true
202
        sqlserver.failover_cluster.replica.database.redo.rate:
203
          enabled: true
204
        sqlserver.failover_cluster.replica.flow_control_time:
205
          enabled: true
206
        sqlserver.failover_cluster.replica.role:
207
          enabled: true
208
        sqlserver.failover_cluster.replica.synchronization_health:
209
          enabled: true
210
        # Server Properties
211
        sqlserver.computer.uptime:
212
          enabled: true
213
        sqlserver.cpu.count:
214
          enabled: true
215
        # Tables
216
        sqlserver.table.count:
217
          enabled: true
218
      # Enable top query and query sample log collection
219
      events:
220
        db.server.query_sample:
221
          enabled: true
222
        db.server.top_query:
223
          enabled: true
224

225
      # Top query collection configuration
226
      top_query_collection:
227
        lookback_time: 45s
228
        max_query_sample_count: 100
229
        top_query_count: 30
230
        collection_interval: 30s
231

232
      collect_full_query_text: true
233
      allowed_comment_keys:
234
        - nr_service_guid
235

236
      # Query sample collection configuration
237
      query_sample_collection:
238
        max_rows_per_query: 50
239

240
processors:
241
    metrics_transform:
242
      transforms:
243
        - include: system.cpu.utilization
244
          action: update
245
          operations:
246
            - action: aggregate_labels
247
              label_set: [state]
248
              aggregation_type: mean
249
        - include: system.paging.operations
250
          action: update
251
          operations:
252
            - action: aggregate_labels
253
              label_set: [direction]
254
              aggregation_type: sum
255

256
    filter/exclude_cpu_utilization:
257
      metrics:
258
        datapoint:
259
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "interrupt"'
260
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "nice"'
261
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "softirq"'
262

263
    filter/exclude_memory_utilization:
264
      metrics:
265
        datapoint:
266
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_unreclaimable"'
267
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "inactive"'
268
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "cached"'
269
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "buffered"'
270
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_reclaimable"'
271

272
    filter/exclude_memory_usage:
273
      metrics:
274
        datapoint:
275
          - 'metric.name == "system.memory.usage" and attributes["state"] == "slab_unreclaimable"'
276
          - 'metric.name == "system.memory.usage" and attributes["state"] == "inactive"'
277

278
    filter/exclude_filesystem_utilization:
279
      metrics:
280
        datapoint:
281
          - 'metric.name == "system.filesystem.utilization" and attributes["type"] == "squashfs"'
282

283
    filter/exclude_filesystem_usage:
284
      metrics:
285
        datapoint:
286
          - 'metric.name == "system.filesystem.usage" and attributes["type"] == "squashfs"'
287
          - 'metric.name == "system.filesystem.usage" and attributes["state"] == "reserved"'
288

289
    filter/exclude_filesystem_inodes_usage:
290
      metrics:
291
        datapoint:
292
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["type"] == "squashfs"'
293
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["state"] == "reserved"'
294

295
    filter/exclude_system_disk:
296
      metrics:
297
        datapoint:
298
          - 'metric.name == "system.disk.operations" and IsMatch(attributes["device"], "^loop.*") == true'
299
          - 'metric.name == "system.disk.merged" and IsMatch(attributes["device"], "^loop.*") == true'
300
          - 'metric.name == "system.disk.io" and IsMatch(attributes["device"], "^loop.*") == true'
301
          - 'metric.name == "system.disk.io_time" and IsMatch(attributes["device"], "^loop.*") == true'
302
          - 'metric.name == "system.disk.operation_time" and IsMatch(attributes["device"], "^loop.*") == true'
303

304
    filter/exclude_network:
305
      metrics:
306
        datapoint:
307
          - 'IsMatch(metric.name, "^system.network.*") == true and attributes["device"] == "lo"'
308

309
    attributes/exclude_system_paging:
310
      include:
311
        match_type: strict
312
        metric_names:
313
          - system.paging.operations
314
      actions:
315
        - key: type
316
          action: delete
317

318
    cumulative_to_delta:
319

320
    transform/host:
321
      metric_statements:
322
        - context: metric
323
          statements:
324
            - set(metric.description, "")
325
            - set(metric.unit, "")
326

327
    batch:
328

329
    batch/logs:
330
      send_batch_size: 15          # flush target: ~15 records per request
331
      send_batch_max_size: 15      # HARD cap: never emit more than 15 records/request
332
      timeout: 5s
333

334
    resource_detection:
335
      detectors: ["system"]
336
      system:
337
        hostname_sources: ["os"]
338
        resource_attributes:
339
          host.id:
340
            enabled: true
341

342
    resource_detection/cloud:
343
      detectors: ["gcp", "ec2", "azure"]
344
      timeout: 2s
345
      override: true
346

347
    resource_detection/env:
348
      detectors: ["env"]
349
      timeout: 2s
350
      override: true
351

352
exporters:
353
    otlp:
354
      endpoint: https://otlp.nr-data.net:4318
355
      headers:
356
        api-key: YOUR_LICENSE_KEY
357
      tls:
358
        insecure: false
359
      compression: gzip
360

361
service:
362
    telemetry:
363
      metrics:
364
        level: none
365

366
    extensions: [health_check]
367

368
    pipelines:
369
      metrics/host:
370
        receivers: [host_metrics, nrsqlserver]
371
        processors:
372
          - metrics_transform
373
          - filter/exclude_cpu_utilization
374
          - filter/exclude_memory_utilization
375
          - filter/exclude_memory_usage
376
          - filter/exclude_filesystem_utilization
377
          - filter/exclude_filesystem_usage
378
          - filter/exclude_filesystem_inodes_usage
379
          - filter/exclude_system_disk
380
          - filter/exclude_network
381
          - attributes/exclude_system_paging
382
          - transform/host
383
          - resource_detection
384
          - resource_detection/cloud
385
          - resource_detection/env
386
          - cumulative_to_delta
387
          - batch
388
        exporters: [otlp]
389

390
      logs/host:
391
        receivers: [nrsqlserver]
392
        processors:
393
          - resource_detection
394
          - resource_detection/cloud
395
          - resource_detection/env
396
          - batch/logs
397
        exporters: [otlp]
398

399
      traces:
400
        receivers: [otlp]
401
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
402
        exporters: [otlp]
403

404
      metrics:
405
        receivers: [otlp]
406
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
407
        exporters: [otlp]
408

409
      logs:
410
        receivers: [otlp]
411
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
412
        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 method.

This configuration includes database monitoring using gMSA authentication.

Enter your values below and see the configuration update in real-time:

SQL Server Hostname/IP

SQL Server Port

New Relic OTLP Endpoint

New Relic License Key

mssql-config.yaml

1
extensions:
2
    health_check:
3

4
receivers:
5
    otlp:
6
      protocols:
7
        grpc:
8
        http:
9

10
    host_metrics:
11
      collection_interval: 30s
12
      scrapers:
13
        cpu:
14
          metrics:
15
            system.cpu.time:
16
              enabled: false
17
            system.cpu.utilization:
18
              enabled: true
19
        load:
20
        memory:
21
          metrics:
22
            system.memory.utilization:
23
              enabled: true
24
        paging:
25
          metrics:
26
            system.paging.utilization:
27
              enabled: false
28
            system.paging.faults:
29
              enabled: false
30
        disk:
31
          metrics:
32
            system.disk.merged:
33
              enabled: false
34
            system.disk.pending_operations:
35
              enabled: false
36
            system.disk.weighted_io_time:
37
              enabled: false
38
        network:
39
          metrics:
40
            system.network.connections:
41
              enabled: false
42
        processes:
43
        process:
44
          mute_process_name_error: true
45
          mute_process_exe_error: true
46
          mute_process_user_error: true
47
          mute_process_io_error: true
48
          metrics:
49
            process.cpu.utilization:
50
              enabled: true
51
            process.memory.utilization:
52
              enabled: true
53

54
    nrsqlserver:
55
      collection_interval: 30s
56
      datasource: "server=sqlserver.example.com;port=1433;integrated security=true;encrypt=true;TrustServerCertificate=true;"
57

58
      # Enable comprehensive database metrics
59
      metrics:
60
        # Database
61
        sqlserver.database.count:
62
          enabled: true
63
        sqlserver.database.file.size:
64
          enabled: true 
65
        sqlserver.database.io:
66
          enabled: true
67
        sqlserver.database.latency:
68
          enabled: true
69
        sqlserver.database.operations:
70
          enabled: true
71
        sqlserver.database.transactions.active:
72
          enabled: true
73
        sqlserver.database.backup_or_restore.rate:
74
          enabled: true
75
        sqlserver.database.execution.errors:
76
          enabled: true
77
        sqlserver.database.full_scan.rate:
78
          enabled: true
79
        sqlserver.database.tempdb.space:
80
          enabled: true
81
        sqlserver.database.tempdb.version_store.size:
82
          enabled: true
83
        # Locks
84
        sqlserver.lock.timeout.rate:
85
          enabled: true
86
        sqlserver.lock.wait.count:
87
          enabled: true
88
        sqlserver.deadlock.rate:
89
          enabled: true
90
        # Transactions
91
        sqlserver.transaction.delay:
92
          enabled: true
93
        sqlserver.transaction.longest_running_time:
94
          enabled: true
95
        sqlserver.transaction.version_cleanup.rate:
96
          enabled: true
97
        sqlserver.transaction.version_generation.rate:
98
          enabled: true
99
        # Memory
100
        sqlserver.memory.area:
101
          enabled: true
102
        sqlserver.memory.cache.object.count:
103
          enabled: true
104
        sqlserver.memory.grants.pending.count:
105
          enabled: true
106
        sqlserver.memory.page.count:
107
          enabled: true
108
        sqlserver.memory.usage:
109
          enabled: true
110
        # OS
111
        sqlserver.os.memory.usage:
112
          enabled: true
113
        sqlserver.os.memory.utilization:
114
          enabled: true
115
        sqlserver.os.scheduler.runnable_tasks.count:
116
          enabled: true
117
        sqlserver.os.wait.duration:
118
          enabled: true
119
        sqlserver.os.wait.tasks.count:
120
          enabled: true
121
        # Pages / Buffer
122
        sqlserver.page.buffer_cache.free_list.stalls.rate:
123
          enabled: true
124
        sqlserver.page.lookup.rate:
125
          enabled: true
126
        # Batch / Compilation
127
        sqlserver.batch.compilation.utilization:
128
          enabled: true
129
        sqlserver.batch.page_split.utilization:
130
          enabled: true
131
        sqlserver.recompilation.ratio:
132
          enabled: true
133
        sqlserver.parameterization.rate:
134
          enabled: true
135
        sqlserver.plan.execution.rate:
136
          enabled: true
137
        sqlserver.attention.rate:
138
          enabled: true
139
        # Processes / Connections
140
        sqlserver.process.count:
141
          enabled: true
142
        sqlserver.processes.blocked:
143
          enabled: true
144
        sqlserver.login.rate:
145
          enabled: true
146
        sqlserver.logout.rate:
147
          enabled: true
148
        # Thread Pool
149
        sqlserver.thread_pool.tasks.count:
150
          enabled: true
151
        sqlserver.thread_pool.workers.count:
152
          enabled: true
153
        sqlserver.thread_pool.workers.max:
154
          enabled: true
155
        sqlserver.thread_pool.workers.utilization:
156
          enabled: true
157
        # TempDB
158
        sqlserver.tempdb.allocation.wait_time.total:
159
          enabled: true
160
        sqlserver.tempdb.contention.waiters.count:
161
          enabled: true
162
        sqlserver.tempdb.data_files.count:
163
          enabled: true
164
        sqlserver.tempdb.file.size:
165
          enabled: true
166
        sqlserver.tempdb.space.usage:
167
          enabled: true
168
        # Latch
169
        sqlserver.latch.superlatch.count:
170
          enabled: true
171
        sqlserver.latch.superlatch.transition.rate:
172
          enabled: true
173
        sqlserver.latch.wait.rate:
174
          enabled: true
175
        sqlserver.latch.wait_time.avg:
176
          enabled: true
177
        sqlserver.latch.wait_time.total:
178
          enabled: true
179
        # Index
180
        sqlserver.index.search.rate:
181
          enabled: true
182
        # Resource Pool
183
        sqlserver.resource_pool.disk.operations:
184
          enabled: true
185
        sqlserver.resource_pool.disk.throttled.read.rate:
186
          enabled: true
187
        sqlserver.resource_pool.disk.throttled.write.rate:
188
          enabled: true
189
        # Replica / Always-On
190
        sqlserver.replica.data.rate:
191
          enabled: true
192
        sqlserver.failover_cluster.ag.cluster_type:
193
          enabled: true
194
        sqlserver.failover_cluster.ag.failure_condition_level:
195
          enabled: true
196
        sqlserver.failover_cluster.ag.health_check_timeout:
197
          enabled: true
198
        sqlserver.failover_cluster.ag.required_sync_secondaries:
199
          enabled: true
200
        sqlserver.failover_cluster.replica.database.queue_size:
201
          enabled: true
202
        sqlserver.failover_cluster.replica.database.redo.rate:
203
          enabled: true
204
        sqlserver.failover_cluster.replica.flow_control_time:
205
          enabled: true
206
        sqlserver.failover_cluster.replica.role:
207
          enabled: true
208
        sqlserver.failover_cluster.replica.synchronization_health:
209
          enabled: true
210
        # Server Properties
211
        sqlserver.computer.uptime:
212
          enabled: true
213
        sqlserver.cpu.count:
214
          enabled: true
215
        # Tables
216
        sqlserver.table.count:
217
          enabled: true
218

219
      # Enable top query and query sample log collection
220
      events:
221
        db.server.query_sample:
222
          enabled: true
223
        db.server.top_query:
224
          enabled: true
225

226
      # Top query collection configuration
227
      top_query_collection:
228
        lookback_time: 45s
229
        max_query_sample_count: 100
230
        top_query_count: 30
231
        collection_interval: 30s
232

233
      collect_full_query_text: true
234
      allowed_comment_keys:
235
        - nr_service_guid
236

237
      # Query sample collection configuration
238
      query_sample_collection:
239
        max_rows_per_query: 50
240

241
processors:
242
    metrics_transform:
243
      transforms:
244
        - include: system.cpu.utilization
245
          action: update
246
          operations:
247
            - action: aggregate_labels
248
              label_set: [state]
249
              aggregation_type: mean
250
        - include: system.paging.operations
251
          action: update
252
          operations:
253
            - action: aggregate_labels
254
              label_set: [direction]
255
              aggregation_type: sum
256

257
    filter/exclude_cpu_utilization:
258
      metrics:
259
        datapoint:
260
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "interrupt"'
261
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "nice"'
262
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "softirq"'
263

264
    filter/exclude_memory_utilization:
265
      metrics:
266
        datapoint:
267
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_unreclaimable"'
268
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "inactive"'
269
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "cached"'
270
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "buffered"'
271
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_reclaimable"'
272

273
    filter/exclude_memory_usage:
274
      metrics:
275
        datapoint:
276
          - 'metric.name == "system.memory.usage" and attributes["state"] == "slab_unreclaimable"'
277
          - 'metric.name == "system.memory.usage" and attributes["state"] == "inactive"'
278

279
    filter/exclude_filesystem_utilization:
280
      metrics:
281
        datapoint:
282
          - 'metric.name == "system.filesystem.utilization" and attributes["type"] == "squashfs"'
283

284
    filter/exclude_filesystem_usage:
285
      metrics:
286
        datapoint:
287
          - 'metric.name == "system.filesystem.usage" and attributes["type"] == "squashfs"'
288
          - 'metric.name == "system.filesystem.usage" and attributes["state"] == "reserved"'
289

290
    filter/exclude_filesystem_inodes_usage:
291
      metrics:
292
        datapoint:
293
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["type"] == "squashfs"'
294
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["state"] == "reserved"'
295

296
    filter/exclude_system_disk:
297
      metrics:
298
        datapoint:
299
          - 'metric.name == "system.disk.operations" and IsMatch(attributes["device"], "^loop.*") == true'
300
          - 'metric.name == "system.disk.merged" and IsMatch(attributes["device"], "^loop.*") == true'
301
          - 'metric.name == "system.disk.io" and IsMatch(attributes["device"], "^loop.*") == true'
302
          - 'metric.name == "system.disk.io_time" and IsMatch(attributes["device"], "^loop.*") == true'
303
          - 'metric.name == "system.disk.operation_time" and IsMatch(attributes["device"], "^loop.*") == true'
304

305
    filter/exclude_network:
306
      metrics:
307
        datapoint:
308
          - 'IsMatch(metric.name, "^system.network.*") == true and attributes["device"] == "lo"'
309

310
    attributes/exclude_system_paging:
311
      include:
312
        match_type: strict
313
        metric_names:
314
          - system.paging.operations
315
      actions:
316
        - key: type
317
          action: delete
318

319
    cumulative_to_delta:
320

321
    transform/host:
322
      metric_statements:
323
        - context: metric
324
          statements:
325
            - set(metric.description, "")
326
            - set(metric.unit, "")
327

328
    batch:
329

330
    batch/logs:
331
      send_batch_size: 15          # flush target: ~15 records per request
332
      send_batch_max_size: 15      # HARD cap: never emit more than 15 records/request
333
      timeout: 5s
334

335
    resource_detection:
336
      detectors: ["system"]
337
      system:
338
        hostname_sources: ["os"]
339
        resource_attributes:
340
          host.id:
341
            enabled: true
342

343
    resource_detection/cloud:
344
      detectors: ["gcp", "ec2", "azure"]
345
      timeout: 2s
346
      override: true
347

348
    resource_detection/env:
349
      detectors: ["env"]
350
      timeout: 2s
351
      override: true
352

353
exporters:
354
    otlp:
355
      endpoint: https://otlp.nr-data.net:4318
356
      headers:
357
        api-key: YOUR_LICENSE_KEY
358
      tls:
359
        insecure: false
360
      compression: gzip
361

362
service:
363
    telemetry:
364
      metrics:
365
        level: none
366

367
    extensions: [health_check]
368

369
    pipelines:
370
      metrics/host:
371
        receivers: [host_metrics, nrsqlserver]
372
        processors:
373
          - metrics_transform
374
          - filter/exclude_cpu_utilization
375
          - filter/exclude_memory_utilization
376
          - filter/exclude_memory_usage
377
          - filter/exclude_filesystem_utilization
378
          - filter/exclude_filesystem_usage
379
          - filter/exclude_filesystem_inodes_usage
380
          - filter/exclude_system_disk
381
          - filter/exclude_network
382
          - attributes/exclude_system_paging
383
          - transform/host
384
          - resource_detection
385
          - resource_detection/cloud
386
          - resource_detection/env
387
          - cumulative_to_delta
388
          - batch
389
        exporters: [otlp]
390

391
      logs/host:
392
        receivers: [nrsqlserver]
393
        processors:
394
          - resource_detection
395
          - resource_detection/cloud
396
          - resource_detection/env
397
          - batch/logs
398
        exporters: [otlp]
399

400
      traces:
401
        receivers: [otlp]
402
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
403
        exporters: [otlp]
404

405
      metrics:
406
        receivers: [otlp]
407
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
408
        exporters: [otlp]
409

410
      logs:
411
        receivers: [otlp]
412
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
413
        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 method.

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

Enter your values below and see the configuration update in real-time:

SQL Server Username

SQL Server Password

RDS Endpoint

Server Port

New Relic OTLP Endpoint

New Relic License Key

mssql-config.yaml

1
extensions:
2
    health_check:
3

4
receivers:
5
    otlp:
6
      protocols:
7
        grpc:
8
        http:
9

10
    host_metrics:
11
      collection_interval: 30s
12
      scrapers:
13
        cpu:
14
          metrics:
15
            system.cpu.time:
16
              enabled: false
17
            system.cpu.utilization:
18
              enabled: true
19
        load:
20
        memory:
21
          metrics:
22
            system.memory.utilization:
23
              enabled: true
24
        paging:
25
          metrics:
26
            system.paging.utilization:
27
              enabled: false
28
            system.paging.faults:
29
              enabled: false
30
        disk:
31
          metrics:
32
            system.disk.merged:
33
              enabled: false
34
            system.disk.pending_operations:
35
              enabled: false
36
            system.disk.weighted_io_time:
37
              enabled: false
38
        network:
39
          metrics:
40
            system.network.connections:
41
              enabled: false
42
        processes:
43
        process:
44
          mute_process_name_error: true
45
          mute_process_exe_error: true
46
          mute_process_user_error: true
47
          mute_process_io_error: true
48
          metrics:
49
            process.cpu.utilization:
50
              enabled: true
51
            process.memory.utilization:
52
              enabled: true
53

54
    nrsqlserver:
55
      collection_interval: 30s
56
      username: newrelic
57
      password: YOUR_PASSWORD
58
      server: mydb-instance.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com
59
      port: 1433
60

61
      # Enable comprehensive database metrics
62
      metrics:
63
        # Database
64
        sqlserver.database.count:
65
          enabled: true
66
        sqlserver.database.file.size:
67
          enabled: true 
68
        sqlserver.database.io:
69
          enabled: true
70
        sqlserver.database.latency:
71
          enabled: true
72
        sqlserver.database.operations:
73
          enabled: true
74
        sqlserver.database.transactions.active:
75
          enabled: true
76
        sqlserver.database.backup_or_restore.rate:
77
          enabled: true
78
        sqlserver.database.full_scan.rate:
79
          enabled: true
80
        sqlserver.database.tempdb.space:
81
          enabled: true
82
        sqlserver.database.tempdb.version_store.size:
83
          enabled: true
84
        # Locks
85
        sqlserver.lock.timeout.rate:
86
          enabled: true
87
        sqlserver.lock.wait.count:
88
          enabled: true
89
        sqlserver.deadlock.rate:
90
          enabled: true
91
        # Transactions
92
        sqlserver.transaction.delay:
93
          enabled: true
94
        sqlserver.transaction.longest_running_time:
95
          enabled: true
96
        sqlserver.transaction.version_cleanup.rate:
97
          enabled: true
98
        sqlserver.transaction.version_generation.rate:
99
          enabled: true
100
        # Memory
101
        sqlserver.memory.area:
102
          enabled: true
103
        sqlserver.memory.cache.object.count:
104
          enabled: true
105
        sqlserver.memory.grants.pending.count:
106
          enabled: true
107
        sqlserver.memory.page.count:
108
          enabled: true
109
        sqlserver.memory.usage:
110
          enabled: true
111
        # OS
112
        sqlserver.os.memory.usage:
113
          enabled: true
114
        sqlserver.os.memory.utilization:
115
          enabled: true
116
        sqlserver.os.scheduler.runnable_tasks.count:
117
          enabled: true
118
        sqlserver.os.wait.duration:
119
          enabled: true
120
        sqlserver.os.wait.tasks.count:
121
          enabled: true
122
        # Pages / Buffer
123
        sqlserver.page.buffer_cache.free_list.stalls.rate:
124
          enabled: true
125
        sqlserver.page.lookup.rate:
126
          enabled: true
127
        # Batch / Compilation
128
        sqlserver.batch.compilation.utilization:
129
          enabled: true
130
        sqlserver.batch.page_split.utilization:
131
          enabled: true
132
        sqlserver.recompilation.ratio:
133
          enabled: true
134
        sqlserver.parameterization.rate:
135
          enabled: true
136
        sqlserver.plan.execution.rate:
137
          enabled: true
138
        sqlserver.attention.rate:
139
          enabled: true
140
        # Processes / Connections
141
        sqlserver.process.count:
142
          enabled: true
143
        sqlserver.processes.blocked:
144
          enabled: true
145
        sqlserver.login.rate:
146
          enabled: true
147
        sqlserver.logout.rate:
148
          enabled: true
149
        # Thread Pool
150
        sqlserver.thread_pool.tasks.count:
151
          enabled: true
152
        sqlserver.thread_pool.workers.count:
153
          enabled: true
154
        sqlserver.thread_pool.workers.max:
155
          enabled: true
156
        sqlserver.thread_pool.workers.utilization:
157
          enabled: true
158
        # TempDB
159
        sqlserver.tempdb.allocation.wait_time.total:
160
          enabled: true
161
        sqlserver.tempdb.contention.waiters.count:
162
          enabled: true
163
        sqlserver.tempdb.data_files.count:
164
          enabled: true
165
        sqlserver.tempdb.file.size:
166
          enabled: true
167
        sqlserver.tempdb.space.usage:
168
          enabled: true
169
        # Latch
170
        sqlserver.latch.superlatch.count:
171
          enabled: true
172
        sqlserver.latch.superlatch.transition.rate:
173
          enabled: true
174
        sqlserver.latch.wait.rate:
175
          enabled: true
176
        sqlserver.latch.wait_time.avg:
177
          enabled: true
178
        sqlserver.latch.wait_time.total:
179
          enabled: true
180
        # Index
181
        sqlserver.index.search.rate:
182
          enabled: true
183
        # Resource Pool
184
        sqlserver.resource_pool.disk.operations:
185
          enabled: true
186
        sqlserver.resource_pool.disk.throttled.read.rate:
187
          enabled: true
188
        sqlserver.resource_pool.disk.throttled.write.rate:
189
          enabled: true
190
        # Replica / Always-On
191
        sqlserver.replica.data.rate:
192
          enabled: true
193
        sqlserver.failover_cluster.ag.cluster_type:
194
          enabled: true
195
        sqlserver.failover_cluster.ag.failure_condition_level:
196
          enabled: true
197
        sqlserver.failover_cluster.ag.health_check_timeout:
198
          enabled: true
199
        sqlserver.failover_cluster.ag.required_sync_secondaries:
200
          enabled: true
201
        sqlserver.failover_cluster.replica.database.queue_size:
202
          enabled: true
203
        sqlserver.failover_cluster.replica.database.redo.rate:
204
          enabled: true
205
        sqlserver.failover_cluster.replica.flow_control_time:
206
          enabled: true
207
        sqlserver.failover_cluster.replica.role:
208
          enabled: true
209
        sqlserver.failover_cluster.replica.synchronization_health:
210
          enabled: true
211
      # Server Properties
212
        sqlserver.computer.uptime:
213
          enabled: true
214
        sqlserver.cpu.count:
215
          enabled: true
216
        # Tables
217
        sqlserver.table.count:
218
          enabled: true
219
      # Enable top query and query sample log collection
220
      events:
221
        db.server.query_sample:
222
          enabled: true
223
        db.server.top_query:
224
          enabled: true
225
      # Top query collection configuration
226
      top_query_collection:
227
        lookback_time: 45s
228
        max_query_sample_count: 100
229
        top_query_count: 30
230
        collection_interval: 30s
231
      collect_full_query_text: true
232
      allowed_comment_keys:
233
        - nr_service_guid
234
      # Query sample collection configuration
235
      query_sample_collection:
236
        max_rows_per_query: 50
237
processors:
238
    metrics_transform:
239
      transforms:
240
        - include: system.cpu.utilization
241
          action: update
242
          operations:
243
            - action: aggregate_labels
244
              label_set: [state]
245
              aggregation_type: mean
246
        - include: system.paging.operations
247
          action: update
248
          operations:
249
            - action: aggregate_labels
250
              label_set: [direction]
251
              aggregation_type: sum
252
    filter/exclude_cpu_utilization:
253
      metrics:
254
        datapoint:
255
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "interrupt"'
256
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "nice"'
257
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "softirq"'
258
    filter/exclude_memory_utilization:
259
      metrics:
260
        datapoint:
261
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_unreclaimable"'
262
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "inactive"'
263
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "cached"'
264
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "buffered"'
265
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_reclaimable"'
266
    filter/exclude_memory_usage:
267
      metrics:
268
        datapoint:
269
          - 'metric.name == "system.memory.usage" and attributes["state"] == "slab_unreclaimable"'
270
          - 'metric.name == "system.memory.usage" and attributes["state"] == "inactive"'
271
    filter/exclude_filesystem_utilization:
272
      metrics:
273
        datapoint:
274
          - 'metric.name == "system.filesystem.utilization" and attributes["type"] == "squashfs"'
275
    filter/exclude_filesystem_usage:
276
      metrics:
277
        datapoint:
278
          - 'metric.name == "system.filesystem.usage" and attributes["type"] == "squashfs"'
279
          - 'metric.name == "system.filesystem.usage" and attributes["state"] == "reserved"'
280
    filter/exclude_filesystem_inodes_usage:
281
      metrics:
282
        datapoint:
283
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["type"] == "squashfs"'
284
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["state"] == "reserved"'
285
    filter/exclude_system_disk:
286
      metrics:
287
        datapoint:
288
          - 'metric.name == "system.disk.operations" and IsMatch(attributes["device"], "^loop.*") == true'
289
          - 'metric.name == "system.disk.merged" and IsMatch(attributes["device"], "^loop.*") == true'
290
          - 'metric.name == "system.disk.io" and IsMatch(attributes["device"], "^loop.*") == true'
291
          - 'metric.name == "system.disk.io_time" and IsMatch(attributes["device"], "^loop.*") == true'
292
          - 'metric.name == "system.disk.operation_time" and IsMatch(attributes["device"], "^loop.*") == true'
293
    filter/exclude_network:
294
      metrics:
295
        datapoint:
296
          - 'IsMatch(metric.name, "^system.network.*") == true and attributes["device"] == "lo"'
297
    attributes/exclude_system_paging:
298
      include:
299
        match_type: strict
300
        metric_names:
301
          - system.paging.operations
302
      actions:
303
        - key: type
304
          action: delete
305
    cumulative_to_delta:
306
    transform/host:
307
      metric_statements:
308
        - context: metric
309
          statements:
310
            - set(metric.description, "")
311
            - set(metric.unit, "")
312
    batch:
313

314
    batch/logs:
315
      send_batch_size: 15          # flush target: ~15 records per request
316
      send_batch_max_size: 15      # HARD cap: never emit more than 15 records/request
317
      timeout: 5s
318

319
    resource_detection:
320
      detectors: ["system"]
321
      system:
322
        hostname_sources: ["os"]
323
        resource_attributes:
324
          host.id:
325
            enabled: true
326
    resource_detection/cloud:
327
      detectors: ["gcp", "ec2", "azure"]
328
      timeout: 2s
329
      override: true
330
    resource_detection/env:
331
      detectors: ["env"]
332
      timeout: 2s
333
      override: true
334
exporters:
335
    otlp:
336
      endpoint: https://otlp.nr-data.net:4318
337
      headers:
338
        api-key: YOUR_LICENSE_KEY
339
      tls:
340
        insecure: false
341
      compression: gzip
342
service:
343
    telemetry:
344
      metrics:
345
        level: none
346
    extensions: [health_check]
347
    pipelines:
348
      metrics/host:
349
        receivers: [host_metrics, nrsqlserver]
350
        processors:
351
          - metrics_transform
352
          - filter/exclude_cpu_utilization
353
          - filter/exclude_memory_utilization
354
          - filter/exclude_memory_usage
355
          - filter/exclude_filesystem_utilization
356
          - filter/exclude_filesystem_usage
357
          - filter/exclude_filesystem_inodes_usage
358
          - filter/exclude_system_disk
359
          - filter/exclude_network
360
          - attributes/exclude_system_paging
361
          - transform/host
362
          - resource_detection
363
          - resource_detection/cloud
364
          - resource_detection/env
365
          - cumulative_to_delta
366
          - batch
367
        exporters: [otlp]
368
      logs/host:
369
        receivers: [nrsqlserver]
370
        processors:
371
          - resource_detection
372
          - resource_detection/cloud
373
          - resource_detection/env
374
          - batch/logs
375
        exporters: [otlp]
376
      traces:
377
        receivers: [otlp]
378
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
379
        exporters: [otlp]
380
      metrics:
381
        receivers: [otlp]
382
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
383
        exporters: [otlp]
384
      logs:
385
        receivers: [otlp]
386
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
387
        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 method.

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

Enter your values below and see the configuration update in real-time:

RDS Endpoint

RDS Port

New Relic OTLP Endpoint

New Relic License Key

mssql-config.yaml

1
extensions:
2
    health_check:
3

4
receivers:
5
    otlp:
6
      protocols:
7
        grpc:
8
        http:
9

10
    host_metrics:
11
      collection_interval: 30s
12
      scrapers:
13
        cpu:
14
          metrics:
15
            system.cpu.time:
16
              enabled: false
17
            system.cpu.utilization:
18
              enabled: true
19
        load:
20
        memory:
21
          metrics:
22
            system.memory.utilization:
23
              enabled: true
24
        paging:
25
          metrics:
26
            system.paging.utilization:
27
              enabled: false
28
            system.paging.faults:
29
              enabled: false
30
        disk:
31
          metrics:
32
            system.disk.merged:
33
              enabled: false
34
            system.disk.pending_operations:
35
              enabled: false
36
            system.disk.weighted_io_time:
37
              enabled: false
38
        network:
39
          metrics:
40
            system.network.connections:
41
              enabled: false
42
        processes:
43
        process:
44
          mute_process_name_error: true
45
          mute_process_exe_error: true
46
          mute_process_user_error: true
47
          mute_process_io_error: true
48
          metrics:
49
            process.cpu.utilization:
50
              enabled: true
51
            process.memory.utilization:
52
              enabled: true
53

54
    nrsqlserver:
55
      collection_interval: 30s
56
      datasource: "server=mydb-instance.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com;port=1433;integrated security=true;encrypt=true;TrustServerCertificate=true;"
57

58
      # Enable comprehensive database metrics
59
      metrics:
60
        # Database
61
        sqlserver.database.count:
62
          enabled: true
63
        sqlserver.database.file.size:
64
          enabled: true 
65
        sqlserver.database.io:
66
          enabled: true
67
        sqlserver.database.latency:
68
          enabled: true
69
        sqlserver.database.operations:
70
          enabled: true
71
        sqlserver.database.transactions.active:
72
          enabled: true
73
        sqlserver.database.backup_or_restore.rate:
74
          enabled: true
75
        sqlserver.database.full_scan.rate:
76
          enabled: true
77
        sqlserver.database.tempdb.space:
78
          enabled: true
79
        sqlserver.database.tempdb.version_store.size:
80
          enabled: true
81
        # Locks
82
        sqlserver.lock.timeout.rate:
83
          enabled: true
84
        sqlserver.lock.wait.count:
85
          enabled: true
86
        sqlserver.deadlock.rate:
87
          enabled: true
88
        # Transactions
89
        sqlserver.transaction.delay:
90
          enabled: true
91
        sqlserver.transaction.longest_running_time:
92
          enabled: true
93
        sqlserver.transaction.version_cleanup.rate:
94
          enabled: true
95
        sqlserver.transaction.version_generation.rate:
96
          enabled: true
97
        # Memory
98
        sqlserver.memory.area:
99
          enabled: true
100
        sqlserver.memory.cache.object.count:
101
          enabled: true
102
        sqlserver.memory.grants.pending.count:
103
          enabled: true
104
        sqlserver.memory.page.count:
105
          enabled: true
106
        sqlserver.memory.usage:
107
          enabled: true
108
        # OS
109
        sqlserver.os.memory.usage:
110
          enabled: true
111
        sqlserver.os.memory.utilization:
112
          enabled: true
113
        sqlserver.os.scheduler.runnable_tasks.count:
114
          enabled: true
115
        sqlserver.os.wait.duration:
116
          enabled: true
117
        sqlserver.os.wait.tasks.count:
118
          enabled: true
119
        # Pages / Buffer
120
        sqlserver.page.buffer_cache.free_list.stalls.rate:
121
          enabled: true
122
        sqlserver.page.lookup.rate:
123
          enabled: true
124
        # Batch / Compilation
125
        sqlserver.batch.compilation.utilization:
126
          enabled: true
127
        sqlserver.batch.page_split.utilization:
128
          enabled: true
129
        sqlserver.recompilation.ratio:
130
          enabled: true
131
        sqlserver.parameterization.rate:
132
          enabled: true
133
        sqlserver.plan.execution.rate:
134
          enabled: true
135
        sqlserver.attention.rate:
136
          enabled: true
137
        # Processes / Connections
138
        sqlserver.process.count:
139
          enabled: true
140
        sqlserver.processes.blocked:
141
          enabled: true
142
        sqlserver.login.rate:
143
          enabled: true
144
        sqlserver.logout.rate:
145
          enabled: true
146
        # Thread Pool
147
        sqlserver.thread_pool.tasks.count:
148
          enabled: true
149
        sqlserver.thread_pool.workers.count:
150
          enabled: true
151
        sqlserver.thread_pool.workers.max:
152
          enabled: true
153
        sqlserver.thread_pool.workers.utilization:
154
          enabled: true
155
        # TempDB
156
        sqlserver.tempdb.allocation.wait_time.total:
157
          enabled: true
158
        sqlserver.tempdb.contention.waiters.count:
159
          enabled: true
160
        sqlserver.tempdb.data_files.count:
161
          enabled: true
162
        sqlserver.tempdb.file.size:
163
          enabled: true
164
        sqlserver.tempdb.space.usage:
165
          enabled: true
166
        # Latch
167
        sqlserver.latch.superlatch.count:
168
          enabled: true
169
        sqlserver.latch.superlatch.transition.rate:
170
          enabled: true
171
        sqlserver.latch.wait.rate:
172
          enabled: true
173
        sqlserver.latch.wait_time.avg:
174
          enabled: true
175
        sqlserver.latch.wait_time.total:
176
          enabled: true
177
        # Index
178
        sqlserver.index.search.rate:
179
          enabled: true
180
        # Resource Pool
181
        sqlserver.resource_pool.disk.operations:
182
          enabled: true
183
        sqlserver.resource_pool.disk.throttled.read.rate:
184
          enabled: true
185
        sqlserver.resource_pool.disk.throttled.write.rate:
186
          enabled: true
187
        # Replica / Always-On
188
        sqlserver.replica.data.rate:
189
          enabled: true
190
        sqlserver.failover_cluster.ag.cluster_type:
191
          enabled: true
192
        sqlserver.failover_cluster.ag.failure_condition_level:
193
          enabled: true
194
        sqlserver.failover_cluster.ag.health_check_timeout:
195
          enabled: true
196
        sqlserver.failover_cluster.ag.required_sync_secondaries:
197
          enabled: true
198
        sqlserver.failover_cluster.replica.database.queue_size:
199
          enabled: true
200
        sqlserver.failover_cluster.replica.database.redo.rate:
201
          enabled: true
202
        sqlserver.failover_cluster.replica.flow_control_time:
203
          enabled: true
204
        sqlserver.failover_cluster.replica.role:
205
          enabled: true
206
        sqlserver.failover_cluster.replica.synchronization_health:
207
          enabled: true
208
        # Server Properties
209
        sqlserver.computer.uptime:
210
          enabled: true
211
        sqlserver.cpu.count:
212
          enabled: true
213
        # Tables
214
        sqlserver.table.count:
215
          enabled: true
216
      # Enable top query and query sample log collection
217
      events:
218
        db.server.query_sample:
219
          enabled: true
220
        db.server.top_query:
221
          enabled: true
222
      # Top query collection configuration
223
      top_query_collection:
224
        lookback_time: 45s
225
        max_query_sample_count: 100
226
        top_query_count: 30
227
        collection_interval: 30s
228
      collect_full_query_text: true
229
      allowed_comment_keys:
230
        - nr_service_guid
231
      # Query sample collection configuration
232
      query_sample_collection:
233
        max_rows_per_query: 50
234
processors:
235
    metrics_transform:
236
      transforms:
237
        - include: system.cpu.utilization
238
          action: update
239
          operations:
240
            - action: aggregate_labels
241
              label_set: [state]
242
              aggregation_type: mean
243
        - include: system.paging.operations
244
          action: update
245
          operations:
246
            - action: aggregate_labels
247
              label_set: [direction]
248
              aggregation_type: sum
249
    filter/exclude_cpu_utilization:
250
      metrics:
251
        datapoint:
252
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "interrupt"'
253
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "nice"'
254
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "softirq"'
255
    filter/exclude_memory_utilization:
256
      metrics:
257
        datapoint:
258
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_unreclaimable"'
259
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "inactive"'
260
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "cached"'
261
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "buffered"'
262
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_reclaimable"'
263
    filter/exclude_memory_usage:
264
      metrics:
265
        datapoint:
266
          - 'metric.name == "system.memory.usage" and attributes["state"] == "slab_unreclaimable"'
267
          - 'metric.name == "system.memory.usage" and attributes["state"] == "inactive"'
268
    filter/exclude_filesystem_utilization:
269
      metrics:
270
        datapoint:
271
          - 'metric.name == "system.filesystem.utilization" and attributes["type"] == "squashfs"'
272
    filter/exclude_filesystem_usage:
273
      metrics:
274
        datapoint:
275
          - 'metric.name == "system.filesystem.usage" and attributes["type"] == "squashfs"'
276
          - 'metric.name == "system.filesystem.usage" and attributes["state"] == "reserved"'
277
    filter/exclude_filesystem_inodes_usage:
278
      metrics:
279
        datapoint:
280
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["type"] == "squashfs"'
281
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["state"] == "reserved"'
282
    filter/exclude_system_disk:
283
      metrics:
284
        datapoint:
285
          - 'metric.name == "system.disk.operations" and IsMatch(attributes["device"], "^loop.*") == true'
286
          - 'metric.name == "system.disk.merged" and IsMatch(attributes["device"], "^loop.*") == true'
287
          - 'metric.name == "system.disk.io" and IsMatch(attributes["device"], "^loop.*") == true'
288
          - 'metric.name == "system.disk.io_time" and IsMatch(attributes["device"], "^loop.*") == true'
289
          - 'metric.name == "system.disk.operation_time" and IsMatch(attributes["device"], "^loop.*") == true'
290
    filter/exclude_network:
291
      metrics:
292
        datapoint:
293
          - 'IsMatch(metric.name, "^system.network.*") == true and attributes["device"] == "lo"'
294
    attributes/exclude_system_paging:
295
      include:
296
        match_type: strict
297
        metric_names:
298
          - system.paging.operations
299
      actions:
300
        - key: type
301
          action: delete
302
    cumulative_to_delta:
303
    transform/host:
304
      metric_statements:
305
        - context: metric
306
          statements:
307
            - set(metric.description, "")
308
            - set(metric.unit, "")
309
    batch:
310

311
    batch/logs:
312
      send_batch_size: 15          # flush target: ~15 records per request
313
      send_batch_max_size: 15      # HARD cap: never emit more than 15 records/request
314
      timeout: 5s
315

316
    resource_detection:
317
      detectors: ["system"]
318
      system:
319
        hostname_sources: ["os"]
320
        resource_attributes:
321
          host.id:
322
            enabled: true
323
    resource_detection/cloud:
324
      detectors: ["gcp", "ec2", "azure"]
325
      timeout: 2s
326
      override: true
327
    resource_detection/env:
328
      detectors: ["env"]
329
      timeout: 2s
330
      override: true
331
exporters:
332
    otlp:
333
      endpoint: https://otlp.nr-data.net:4318
334
      headers:
335
        api-key: YOUR_LICENSE_KEY
336
      tls:
337
        insecure: false
338
      compression: gzip
339
service:
340
    telemetry:
341
      metrics:
342
        level: none
343
    extensions: [health_check]
344
    pipelines:
345
      metrics/host:
346
        receivers: [host_metrics, nrsqlserver]
347
        processors:
348
          - metrics_transform
349
          - filter/exclude_cpu_utilization
350
          - filter/exclude_memory_utilization
351
          - filter/exclude_memory_usage
352
          - filter/exclude_filesystem_utilization
353
          - filter/exclude_filesystem_usage
354
          - filter/exclude_filesystem_inodes_usage
355
          - filter/exclude_system_disk
356
          - filter/exclude_network
357
          - attributes/exclude_system_paging
358
          - transform/host
359
          - resource_detection
360
          - resource_detection/cloud
361
          - resource_detection/env
362
          - cumulative_to_delta
363
          - batch
364
        exporters: [otlp]
365
      logs/host:
366
        receivers: [nrsqlserver]
367
        processors:
368
          - resource_detection
369
          - resource_detection/cloud
370
          - resource_detection/env
371
          - batch/logs
372
        exporters: [otlp]
373
      traces:
374
        receivers: [otlp]
375
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
376
        exporters: [otlp]
377
      metrics:
378
        receivers: [otlp]
379
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
380
        exporters: [otlp]
381
      logs:
382
        receivers: [otlp]
383
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
384
        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 method.

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.

Enter your values below and see the configuration update in real-time:

RDS Endpoint

RDS Port

New Relic OTLP Endpoint

New Relic License Key

mssql-config.yaml

1
extensions:
2
    health_check:
3

4
receivers:
5
    otlp:
6
      protocols:
7
        grpc:
8
        http:
9

10
    host_metrics:
11
      collection_interval: 30s
12
      scrapers:
13
        cpu:
14
          metrics:
15
            system.cpu.time:
16
              enabled: false
17
            system.cpu.utilization:
18
              enabled: true
19
        load:
20
        memory:
21
          metrics:
22
            system.memory.utilization:
23
              enabled: true
24
        paging:
25
          metrics:
26
            system.paging.utilization:
27
              enabled: false
28
            system.paging.faults:
29
              enabled: false
30
        disk:
31
          metrics:
32
            system.disk.merged:
33
              enabled: false
34
            system.disk.pending_operations:
35
              enabled: false
36
            system.disk.weighted_io_time:
37
              enabled: false
38
        network:
39
          metrics:
40
            system.network.connections:
41
              enabled: false
42
        processes:
43
        process:
44
          mute_process_name_error: true
45
          mute_process_exe_error: true
46
          mute_process_user_error: true
47
          mute_process_io_error: true
48
          metrics:
49
            process.cpu.utilization:
50
              enabled: true
51
            process.memory.utilization:
52
              enabled: true
53

54
    nrsqlserver:
55
      collection_interval: 30s
56
      datasource: "server=mydb-instance.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com;port=1433;integrated security=true;encrypt=true;TrustServerCertificate=true;"
57

58
      # Enable comprehensive database metrics
59
      metrics:
60
        # Database
61
        sqlserver.database.count:
62
          enabled: true
63
        sqlserver.database.file.size:
64
          enabled: true 
65
        sqlserver.database.io:
66
          enabled: true
67
        sqlserver.database.latency:
68
          enabled: true
69
        sqlserver.database.operations:
70
          enabled: true
71
        sqlserver.database.transactions.active:
72
          enabled: true
73
        sqlserver.database.backup_or_restore.rate:
74
          enabled: true
75
        sqlserver.database.full_scan.rate:
76
          enabled: true
77
        sqlserver.database.tempdb.space:
78
          enabled: true
79
        sqlserver.database.tempdb.version_store.size:
80
          enabled: true
81
        # Locks
82
        sqlserver.lock.timeout.rate:
83
          enabled: true
84
        sqlserver.lock.wait.count:
85
          enabled: true
86
        sqlserver.deadlock.rate:
87
          enabled: true
88
        # Transactions
89
        sqlserver.transaction.delay:
90
          enabled: true
91
        sqlserver.transaction.longest_running_time:
92
          enabled: true
93
        sqlserver.transaction.version_cleanup.rate:
94
          enabled: true
95
        sqlserver.transaction.version_generation.rate:
96
          enabled: true
97
        # Memory
98
        sqlserver.memory.area:
99
          enabled: true
100
        sqlserver.memory.cache.object.count:
101
          enabled: true
102
        sqlserver.memory.grants.pending.count:
103
          enabled: true
104
        sqlserver.memory.page.count:
105
          enabled: true
106
        sqlserver.memory.usage:
107
          enabled: true
108
        # OS
109
        sqlserver.os.memory.usage:
110
          enabled: true
111
        sqlserver.os.memory.utilization:
112
          enabled: true
113
        sqlserver.os.scheduler.runnable_tasks.count:
114
          enabled: true
115
        sqlserver.os.wait.duration:
116
          enabled: true
117
        sqlserver.os.wait.tasks.count:
118
          enabled: true
119
        # Pages / Buffer
120
        sqlserver.page.buffer_cache.free_list.stalls.rate:
121
          enabled: true
122
        sqlserver.page.lookup.rate:
123
          enabled: true
124
        # Batch / Compilation
125
        sqlserver.batch.compilation.utilization:
126
          enabled: true
127
        sqlserver.batch.page_split.utilization:
128
          enabled: true
129
        sqlserver.recompilation.ratio:
130
          enabled: true
131
        sqlserver.parameterization.rate:
132
          enabled: true
133
        sqlserver.plan.execution.rate:
134
          enabled: true
135
        sqlserver.attention.rate:
136
          enabled: true
137
        # Processes / Connections
138
        sqlserver.process.count:
139
          enabled: true
140
        sqlserver.processes.blocked:
141
          enabled: true
142
        sqlserver.login.rate:
143
          enabled: true
144
        sqlserver.logout.rate:
145
          enabled: true
146
        # Thread Pool
147
        sqlserver.thread_pool.tasks.count:
148
          enabled: true
149
        sqlserver.thread_pool.workers.count:
150
          enabled: true
151
        sqlserver.thread_pool.workers.max:
152
          enabled: true
153
        sqlserver.thread_pool.workers.utilization:
154
          enabled: true
155
        # TempDB
156
        sqlserver.tempdb.allocation.wait_time.total:
157
          enabled: true
158
        sqlserver.tempdb.contention.waiters.count:
159
          enabled: true
160
        sqlserver.tempdb.data_files.count:
161
          enabled: true
162
        sqlserver.tempdb.file.size:
163
          enabled: true
164
        sqlserver.tempdb.space.usage:
165
          enabled: true
166
        # Latch
167
        sqlserver.latch.superlatch.count:
168
          enabled: true
169
        sqlserver.latch.superlatch.transition.rate:
170
          enabled: true
171
        sqlserver.latch.wait.rate:
172
          enabled: true
173
        sqlserver.latch.wait_time.avg:
174
          enabled: true
175
        sqlserver.latch.wait_time.total:
176
          enabled: true
177
        # Index
178
        sqlserver.index.search.rate:
179
          enabled: true
180
        # Resource Pool
181
        sqlserver.resource_pool.disk.operations:
182
          enabled: true
183
        sqlserver.resource_pool.disk.throttled.read.rate:
184
          enabled: true
185
        sqlserver.resource_pool.disk.throttled.write.rate:
186
          enabled: true
187
        # Replica / Always-On
188
        sqlserver.replica.data.rate:
189
          enabled: true
190
        sqlserver.failover_cluster.ag.cluster_type:
191
          enabled: true
192
        sqlserver.failover_cluster.ag.failure_condition_level:
193
          enabled: true
194
        sqlserver.failover_cluster.ag.health_check_timeout:
195
          enabled: true
196
        sqlserver.failover_cluster.ag.required_sync_secondaries:
197
          enabled: true
198
        sqlserver.failover_cluster.replica.database.queue_size:
199
          enabled: true
200
        sqlserver.failover_cluster.replica.database.redo.rate:
201
          enabled: true
202
        sqlserver.failover_cluster.replica.flow_control_time:
203
          enabled: true
204
        sqlserver.failover_cluster.replica.role:
205
          enabled: true
206
        sqlserver.failover_cluster.replica.synchronization_health:
207
          enabled: true
208
        # Server Properties
209
        sqlserver.computer.uptime:
210
          enabled: true
211
        sqlserver.cpu.count:
212
          enabled: true
213
        # Tables
214
        sqlserver.table.count:
215
          enabled: true
216
      # Enable top query and query sample log collection
217
      events:
218
        db.server.query_sample:
219
          enabled: true
220
        db.server.top_query:
221
          enabled: true
222
      # Top query collection configuration
223
      top_query_collection:
224
        lookback_time: 45s
225
        max_query_sample_count: 100
226
        top_query_count: 30
227
        collection_interval: 30s
228
      collect_full_query_text: true
229
      allowed_comment_keys:
230
        - nr_service_guid
231
      # Query sample collection configuration
232
      query_sample_collection:
233
        max_rows_per_query: 50
234
processors:
235
    metrics_transform:
236
      transforms:
237
        - include: system.cpu.utilization
238
          action: update
239
          operations:
240
            - action: aggregate_labels
241
              label_set: [state]
242
              aggregation_type: mean
243
        - include: system.paging.operations
244
          action: update
245
          operations:
246
            - action: aggregate_labels
247
              label_set: [direction]
248
              aggregation_type: sum
249
    filter/exclude_cpu_utilization:
250
      metrics:
251
        datapoint:
252
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "interrupt"'
253
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "nice"'
254
          - 'metric.name == "system.cpu.utilization" and attributes["state"] == "softirq"'
255
    filter/exclude_memory_utilization:
256
      metrics:
257
        datapoint:
258
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_unreclaimable"'
259
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "inactive"'
260
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "cached"'
261
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "buffered"'
262
          - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_reclaimable"'
263
    filter/exclude_memory_usage:
264
      metrics:
265
        datapoint:
266
          - 'metric.name == "system.memory.usage" and attributes["state"] == "slab_unreclaimable"'
267
          - 'metric.name == "system.memory.usage" and attributes["state"] == "inactive"'
268
    filter/exclude_filesystem_utilization:
269
      metrics:
270
        datapoint:
271
          - 'metric.name == "system.filesystem.utilization" and attributes["type"] == "squashfs"'
272
    filter/exclude_filesystem_usage:
273
      metrics:
274
        datapoint:
275
          - 'metric.name == "system.filesystem.usage" and attributes["type"] == "squashfs"'
276
          - 'metric.name == "system.filesystem.usage" and attributes["state"] == "reserved"'
277
    filter/exclude_filesystem_inodes_usage:
278
      metrics:
279
        datapoint:
280
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["type"] == "squashfs"'
281
          - 'metric.name == "system.filesystem.inodes.usage" and attributes["state"] == "reserved"'
282
    filter/exclude_system_disk:
283
      metrics:
284
        datapoint:
285
          - 'metric.name == "system.disk.operations" and IsMatch(attributes["device"], "^loop.*") == true'
286
          - 'metric.name == "system.disk.merged" and IsMatch(attributes["device"], "^loop.*") == true'
287
          - 'metric.name == "system.disk.io" and IsMatch(attributes["device"], "^loop.*") == true'
288
          - 'metric.name == "system.disk.io_time" and IsMatch(attributes["device"], "^loop.*") == true'
289
          - 'metric.name == "system.disk.operation_time" and IsMatch(attributes["device"], "^loop.*") == true'
290
    filter/exclude_network:
291
      metrics:
292
        datapoint:
293
          - 'IsMatch(metric.name, "^system.network.*") == true and attributes["device"] == "lo"'
294
    attributes/exclude_system_paging:
295
      include:
296
        match_type: strict
297
        metric_names:
298
          - system.paging.operations
299
      actions:
300
        - key: type
301
          action: delete
302
    cumulative_to_delta:
303
    transform/host:
304
      metric_statements:
305
        - context: metric
306
          statements:
307
            - set(metric.description, "")
308
            - set(metric.unit, "")
309
    batch:
310

311
    batch/logs:
312
      send_batch_size: 15          # flush target: ~15 records per request
313
      send_batch_max_size: 15      # HARD cap: never emit more than 15 records/request
314
      timeout: 5s
315

316
    resource_detection:
317
      detectors: ["system"]
318
      system:
319
        hostname_sources: ["os"]
320
        resource_attributes:
321
          host.id:
322
            enabled: true
323
    resource_detection/cloud:
324
      detectors: ["gcp", "ec2", "azure"]
325
      timeout: 2s
326
      override: true
327
    resource_detection/env:
328
      detectors: ["env"]
329
      timeout: 2s
330
      override: true
331
exporters:
332
    otlp:
333
      endpoint: https://otlp.nr-data.net:4318
334
      headers:
335
        api-key: YOUR_LICENSE_KEY
336
      tls:
337
        insecure: false
338
      compression: gzip
339
service:
340
    telemetry:
341
      metrics:
342
        level: none
343
    extensions: [health_check]
344
    pipelines:
345
      metrics/host:
346
        receivers: [host_metrics, nrsqlserver]
347
        processors:
348
          - metrics_transform
349
          - filter/exclude_cpu_utilization
350
          - filter/exclude_memory_utilization
351
          - filter/exclude_memory_usage
352
          - filter/exclude_filesystem_utilization
353
          - filter/exclude_filesystem_usage
354
          - filter/exclude_filesystem_inodes_usage
355
          - filter/exclude_system_disk
356
          - filter/exclude_network
357
          - attributes/exclude_system_paging
358
          - transform/host
359
          - resource_detection
360
          - resource_detection/cloud
361
          - resource_detection/env
362
          - cumulative_to_delta
363
          - batch
364
        exporters: [otlp]
365
      logs/host:
366
        receivers: [nrsqlserver]
367
        processors:
368
          - resource_detection
369
          - resource_detection/cloud
370
          - resource_detection/env
371
          - batch/logs
372
        exporters: [otlp]
373
      traces:
374
        receivers: [otlp]
375
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
376
        exporters: [otlp]
377
      metrics:
378
        receivers: [otlp]
379
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
380
        exporters: [otlp]
381
      logs:
382
        receivers: [otlp]
383
        processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
384
        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 method.

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

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

Windows RDS - SQL Server authentication

For Windows RDS - Windows domain authentication

For Windows RDS - gMSA authentication

Configure the receiver

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

Windows RDS - SQL Server authentication

For Windows RDS - Windows domain authentication

For Windows RDS - gMSA authentication

Configure the receiver

For Linux