Configuration reference for PostgreSQL monitoring with NRDOT

1
receivers:
2
    nrpostgresql:
3
      endpoint: "postgresql.example.com:5432"
4
      username: "newrelic"
5
      password: "YOUR_PASSWORD"
6
      databases:
7
        - YOUR_DATABASE_NAME
8
      collection_interval: 15s
9
      events:
10
        db.server.top_query:
11
          enabled: true
12
        db.server.query_sample:
13
          enabled: true
14
        db.server.query_plan:
15
          enabled: true
16
      top_query_collection:
17
        max_rows_per_query: 1000
18
        top_n_query: 200
19
        collection_interval: 60s
20
        allowed_comment_keys: [nr_service_guid]
21
      query_sample_collection:
22
        max_rows_per_query: 1000
23
        allowed_comment_keys: [nr_service_guid]
24

25
      resource_attributes:
26
        db.system.version:
27
          enabled: true
28
      # All metrics disabled by default in the receiver, enabled here for full dashboard coverage
29
      metrics:
30
        postgresql.blks_hit:
31
          enabled: true
32
        postgresql.blks_read:
33
          enabled: true
34
        postgresql.database.locks:
35
          enabled: true
36
        postgresql.deadlocks:
37
          enabled: true
38
        postgresql.function.calls:
39
          enabled: true
40
        postgresql.query.conflicts:
41
          enabled: true
42
        postgresql.query.execution.time:
43
          enabled: true
44
        postgresql.sequential_scans:
45
          enabled: true
46
        postgresql.temp.io:
47
          enabled: true
48
        postgresql.temp_files:
49
          enabled: true
50
        postgresql.tup_deleted:
51
          enabled: true
52
        postgresql.tup_fetched:
53
          enabled: true
54
        postgresql.tup_inserted:
55
          enabled: true
56
        postgresql.tup_returned:
57
          enabled: true
58
        postgresql.tup_updated:
59
          enabled: true
60
        postgresql.vector.insert.duration:
61
          enabled: true
62
        postgresql.vector.insert.rows:
63
          enabled: true
64
        postgresql.vector.search.calls:
65
          enabled: true
66
        postgresql.vector.search.duration:
67
          enabled: true
68
        postgresql.vector.search.rows_returned:
69
          enabled: true
70
        postgresql.wal.delay:
71
          enabled: true
72

73
processors:
74
    batch:
75
    batch/metrics:
76
      send_batch_size: 8192
77
      send_batch_max_size: 8192
78
      timeout: 10s
79

80
exporters:
81
    otlp/newrelic:
82
      endpoint: "https://otlp.nr-data.net:4318"
83
      headers:
84
        api-key: "YOUR_LICENSE_KEY"
85
      compression: gzip
86
      sending_queue:
87
        enabled: true
88
        sizer: bytes
89
        queue_size: 100_000_000
90
        num_consumers: 10
91
        batch:
92
          sizer: bytes
93
          max_size: 1_000_000
94
          min_size: 0
95
          flush_timeout: 5s
96
      retry_on_failure:
97
        enabled: true
98
        initial_interval: 5s
99
        max_interval: 30s
100
        max_elapsed_time: 300s
101

102
service:
103
    telemetry:
104
      metrics:
105
        level: none
106
    pipelines:
107
      metrics:
108
        receivers: [nrpostgresql]
109
        processors: [batch/metrics]
110
        exporters: [otlp/newrelic]
111
      logs:
112
        receivers: [nrpostgresql]
113
        processors: [batch]
114
        exporters: [otlp/newrelic]

1
receivers:
2
    nrpostgresql:
3
      endpoint: "mydb-instance.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com:5432"
4
      username: "newrelic"
5
      password: "YOUR_PASSWORD"
6
      databases:
7
        - YOUR_DATABASE_NAME
8
      # top_query/query_sample scan pg_stat_statements/pg_stat_activity cluster-wide
9
      # regardless of the databases list above; on RDS/Aurora, exclude reserved
10
      # databases the monitoring user can never reach.
11
      exclude_databases:
12
        - rdsadmin
13
      collection_interval: 15s
14
      events:
15
        db.server.top_query:
16
          enabled: true
17
        db.server.query_sample:
18
          enabled: true
19
        db.server.query_plan:
20
          enabled: true
21
      top_query_collection:
22
        max_rows_per_query: 1000
23
        top_n_query: 200
24
        collection_interval: 60s
25
        allowed_comment_keys: [nr_service_guid]
26
      query_sample_collection:
27
        max_rows_per_query: 1000
28
        allowed_comment_keys: [nr_service_guid]
29

30
      resource_attributes:
31
        db.system.version:
32
          enabled: true
33
      # All metrics disabled by default in the receiver, enabled here for full dashboard coverage
34
      metrics:
35
        postgresql.blks_hit:
36
          enabled: true
37
        postgresql.blks_read:
38
          enabled: true
39
        postgresql.database.locks:
40
          enabled: true
41
        postgresql.deadlocks:
42
          enabled: true
43
        postgresql.function.calls:
44
          enabled: true
45
        postgresql.query.conflicts:
46
          enabled: true
47
        postgresql.query.execution.time:
48
          enabled: true
49
        postgresql.sequential_scans:
50
          enabled: true
51
        postgresql.temp.io:
52
          enabled: true
53
        postgresql.temp_files:
54
          enabled: true
55
        postgresql.tup_deleted:
56
          enabled: true
57
        postgresql.tup_fetched:
58
          enabled: true
59
        postgresql.tup_inserted:
60
          enabled: true
61
        postgresql.tup_returned:
62
          enabled: true
63
        postgresql.tup_updated:
64
          enabled: true
65
        postgresql.vector.insert.duration:
66
          enabled: true
67
        postgresql.vector.insert.rows:
68
          enabled: true
69
        postgresql.vector.search.calls:
70
          enabled: true
71
        postgresql.vector.search.duration:
72
          enabled: true
73
        postgresql.vector.search.rows_returned:
74
          enabled: true
75
        postgresql.wal.delay:
76
          enabled: true
77

78
processors:
79
    batch:
80
    batch/metrics:
81
      send_batch_size: 8192
82
      send_batch_max_size: 8192
83
      timeout: 10s
84

85
exporters:
86
    otlp/newrelic:
87
      endpoint: "https://otlp.nr-data.net:4318"
88
      headers:
89
        api-key: "YOUR_LICENSE_KEY"
90
      compression: gzip
91
      sending_queue:
92
        enabled: true
93
        sizer: bytes
94
        queue_size: 100_000_000
95
        num_consumers: 10
96
        batch:
97
          sizer: bytes
98
          max_size: 1_000_000
99
          min_size: 0
100
          flush_timeout: 5s
101
      retry_on_failure:
102
        enabled: true
103
        initial_interval: 5s
104
        max_interval: 30s
105
        max_elapsed_time: 300s
106

107
service:
108
    telemetry:
109
      metrics:
110
        level: none
111
    pipelines:
112
      metrics:
113
        receivers: [nrpostgresql]
114
        processors: [batch/metrics]
115
        exporters: [otlp/newrelic]
116
      logs:
117
        receivers: [nrpostgresql]
118
        processors: [batch]
119
        exporters: [otlp/newrelic]