Multi-receiver configuration for MSSQL with NRDOT

The following example shows how to configure the NRDOT Collector to monitor two MSSQL instances using a multi-receiver configuration. The first instance, nrsqlserver/1, carries the complete configuration and acts as the anchor; the second instance, nrsqlserver/2, inherits every shared setting through the YAML merge key and overrides only its own connection details. You can add more receivers as needed for additional instances.

receivers:
  # Base SQL Server instance: defines the anchor all others inherit from.
  nrsqlserver/1: &nrsqlserver-common
    username: "<YOUR_DB1_USERNAME>"
    password: "<YOUR_DB1_PASSWORD>"
    server: "<YOUR_SERVER_1>"
    port: 1433
    collection_interval: 15s

    metrics:
      sqlserver.database.count:
        enabled: true
      sqlserver.database.io:
        enabled: true
      sqlserver.database.latency:
        enabled: true
      sqlserver.database.operations:
        enabled: true
      sqlserver.database.tempdb.space:
        enabled: true
      sqlserver.database.tempdb.version_store.size:
        enabled: true
      sqlserver.deadlock.rate:
        enabled: true
      sqlserver.os.wait.duration:
        enabled: true
      sqlserver.processes.blocked:
        enabled: true
      sqlserver.memory.grants.pending.count:
        enabled: true
      sqlserver.database.file.size:
        enabled: true
      sqlserver.memory.area:
        enabled: true

    events:
      db.server.query_sample:
        enabled: true
      db.server.top_query:
        enabled: true
      db.server.query_plan:
        enabled: true
      db.server.top_procedure:
        enabled: true

    top_query_collection:
      lookback_time: 60s
      max_query_sample_count: 1000
      top_query_count: 250
      collection_interval: 60s
      collect_full_query_text: true
      allowed_comment_keys:
        - nr_service_guid

    query_sample_collection:
      max_rows_per_query: 100
      collect_full_query_text: true
      allowed_comment_keys:
        - nr_service_guid

    top_procedure_collection:
      max_procedure_sample_count: 1000
      top_procedure_count: 250
      collection_interval: 60s

    resource_attributes:
      db.system.version:
        enabled: true
      sqlserver.db.edition:
        enabled: true

  # Second SQL Server instance: inherits all settings from nrsqlserver/1,
  # overrides only the connection-specific fields.
  # Additional SQL Server instances can be added here following the same pattern.
  nrsqlserver/2:
    <<: *nrsqlserver-common
    username: "<YOUR_DB2_USERNAME>"
    password: "<YOUR_DB2_PASSWORD>"
    server: "<YOUR_SERVER_2>"
    port: 1433

processors:
  memory_limiter:
    check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
    limit_mib: ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
    spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}

exporters:
  otlp:
    endpoint: https://otlp.nr-data.net:4318
    headers:
      api-key: <YOUR_LICENSE_KEY>
    tls:
      insecure: false
    compression: gzip
    sending_queue:
      enabled: true
      sizer: bytes
      queue_size: 100_000_000
      num_consumers: 10
      batch:
        sizer: bytes
        max_size: 1_000_000
        min_size: 0
        flush_timeout: 5s

service:
  telemetry:
    metrics:
      level: none

  # Metrics and logs pipelines for multiple SQL Server instances
  pipelines:
    metrics:
      receivers: [nrsqlserver/1, nrsqlserver/2]
      processors: [memory_limiter]
      exporters: [otlp]
    logs:
      receivers: [nrsqlserver/1, nrsqlserver/2]
      processors: [memory_limiter]
      exporters: [otlp]

The <<: *nrsqlserver-common merge key inherits all settings from nrsqlserver/1, including its metric catalog, events, query/procedure collection settings, and resource attributes. Any field you explicitly set after it, such as username, password, server, and port, overrides the inherited value for that specific receiver instance.

Azure SQL Database doesn't support cross-database queries, so each receiver connects to one database. To monitor several databases on the same server, define one receiver per database. The first receiver carries the full configuration and acts as the anchor; the others inherit it through the YAML merge key (<<) and override only datasource.

1. Create the monitoring user in every database you want to monitor, as described in Create monitoring user and grant permissions on Linux or Windows. The newrelic login in master is shared, so you create it only once.

2. Add the following configuration. Replace <YOUR_PASSWORD>, <YOUR-SERVER>, <YOUR_DATABASE_1>, <YOUR_DATABASE_2>, <YOUR_LICENSE_KEY>, and the OTLP endpoint with your values:

   receivers:
     # First database: defines the anchor that the others inherit from.
     nrsqlserver/db1: &nrsqlserver-common
       collection_interval: 15s
       # datasource replaces username, password, server, and port.
       datasource: "sqlserver://newrelic:<YOUR_PASSWORD>@<YOUR-SERVER>:1433?database=<YOUR_DATABASE_1>"
   
       metrics:
         sqlserver.database.io:
           enabled: true
         sqlserver.database.latency:
           enabled: true
         sqlserver.database.operations:
           enabled: true
         sqlserver.database.tempdb.space:
           enabled: true
         sqlserver.database.tempdb.version_store.size:
           enabled: true
         sqlserver.deadlock.rate:
           enabled: true
         sqlserver.os.wait.duration:
           enabled: true
         sqlserver.processes.blocked:
           enabled: true
         sqlserver.memory.grants.pending.count:
           enabled: true
         sqlserver.database.file.size:
           enabled: true
         sqlserver.memory.area:
           enabled: true
   
       events:
         db.server.query_sample:
           enabled: true
         db.server.top_query:
           enabled: true
         db.server.query_plan:
           enabled: true
         db.server.top_procedure:
           enabled: true
   
       top_query_collection:
         lookback_time: 60s
         max_query_sample_count: 1000
         top_query_count: 250
         collection_interval: 60s
         collect_full_query_text: true
         allowed_comment_keys:
           - nr_service_guid
   
       query_sample_collection:
         max_rows_per_query: 100
         collect_full_query_text: true
         allowed_comment_keys:
           - nr_service_guid
   
       top_procedure_collection:
         max_procedure_sample_count: 1000
         top_procedure_count: 250
         collection_interval: 60s
   
       resource_attributes:
         db.system.version:
           enabled: true
         sqlserver.db.edition:
           enabled: true
   
     # Second database: inherits every setting above and overrides only the database.
     # Add more databases the same way (nrsqlserver/db3, ...).
     nrsqlserver/db2:
       <<: *nrsqlserver-common
       datasource: "sqlserver://newrelic:<YOUR_PASSWORD>@<YOUR-SERVER>:1433?database=<YOUR_DATABASE_2>"
   
   processors:
     memory_limiter:
       check_interval: ${env:NR_MEM_LIMITER_CHECK_INTERVAL:-1s}
       limit_mib:       ${env:NR_MEM_LIMITER_LIMIT_MIB:-200}
       spike_limit_mib: ${env:NR_MEM_LIMITER_SPIKE_MIB:-50}
   
   exporters:
     otlp:
       endpoint: https://otlp.nr-data.net:4318
       headers:
         api-key: <YOUR_LICENSE_KEY>
       tls:
         insecure: false
       compression: gzip
       sending_queue:
         enabled: true
         sizer: bytes
         queue_size: 100_000_000
         num_consumers: 10
         batch:
           sizer: bytes
           max_size: 1_000_000
           min_size: 0
           flush_timeout: 5s
   
   service:
     telemetry:
       metrics:
         level: none
     pipelines:
       metrics:
         receivers: [nrsqlserver/db1, nrsqlserver/db2]
         processors: [memory_limiter]
         exporters: [otlp]
       logs:
         receivers: [nrsqlserver/db1, nrsqlserver/db2]
         processors: [memory_limiter]
         exporters: [otlp]

   Copy