Postgresql discovery config - add OTel native receiver

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - (Splunk) Update splunk-otel-js to [v2.6.0](https://github.com/signalfx/splunk-otel-js/releases/tag/v2.6.0) ([#4064](https://github.com/signalfx/splunk-otel-collector/pull/4064))
 
+### 🛑 Breaking changes 🛑
+
+- `postgresql` discovery now uses the OpenTelemetry Collector Contrib receiver by default instead of the smartagent receiver.
+
 ## v0.91.0
 
 This Splunk OpenTelemetry Collector release includes changes from the [opentelemetry-collector v0.91.0](https://github.com/open-telemetry/opentelemetry-collector/releases/tag/v0.91.0) and the [opentelemetry-collector-contrib v0.91.0](https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/tag/v0.91.0) releases where appropriate.

cmd/otelcol/config/collector/config.d.linux/properties.discovery.yaml.example

@@ -11,9 +11,11 @@ splunk.discovery:
     k8s_observer:
       enabled: true
   receivers:
+    postgresql:
+      enabled: true
     smartagent/collectd/mysql:
       enabled: true
     smartagent/collectd/nginx:
       enabled: true
     smartagent/postgresql:
-      enabled: true
+      enabled: false

cmd/otelcol/config/collector/config.d.linux/receivers/postgresql.discovery.yaml

@@ -0,0 +1,83 @@
+#####################################################################################
+# This file is generated by the Splunk Distribution of the OpenTelemetry Collector. #
+#                                                                                   #
+# It reflects the default configuration bundled in the Collector executable for use #
+# in discovery mode (--discovery) and is provided for reference or customization.   #
+# Please note that any changes made to this file will need to be reconciled during  #
+# upgrades of the Collector.                                                        #
+#####################################################################################
+# postgresql:
+#   enabled: true
+#   rule:
+#     docker_observer: type == "container" and any([name, image, command], {# matches "(?i)postgres"}) and not (command matches "splunk.discovery")
+#     host_observer: type == "hostport" and command matches "(?i)postgres" and not (command matches "splunk.discovery")
+#     k8s_observer: type == "port" and pod.name matches "(?i)postgres"
+#   config:
+#     default:
+#         username: splunk.discovery.default
+#         password: splunk.discovery.default
+#   status:
+#     metrics:
+#       successful:
+#         - strict: postgresql.commits
+#           first_only: true
+#           log_record:
+#             severity_text: info
+#             body: PostgreSQL receiver is working!
+#     statements:
+#       failed:
+#         - regexp: 'connect: network is unreachable'
+#           first_only: true
+#           log_record:
+#             severity_text: info
+#             append_pattern: true
+#             body: The container cannot be reached by the Collector. Make sure they're in the same network.
+#         - regexp: 'connect: connection refused'
+#           first_only: true
+#           log_record:
+#             severity_text: info
+#             append_pattern: true
+#             body: The container is refusing PostgreSQL connections.
+#       partial:
+#         - regexp: 'pq: password authentication failed for user'
+#           first_only: true
+#           log_record:
+#             severity_text: info
+#             append_pattern: true
+#             body: >-
+#               Please ensure your user credentials are correctly specified with
+#               `--set splunk.discovery.receivers.postgresql.config.username="<username>"` and
+#               `--set splunk.discovery.receivers.postgresql.config.password="<password>"` or
+#               `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_username="<username>"` and
+#               `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_password="<password>"` environment variables.
+#         - regexp: 'pq: database .* does not exist'
+#           first_only: true
+#           log_record:
+#             severity_text: info
+#             append_pattern: true
+#             body: >-
+#               Make sure the target database is correctly specified using the
+#               `--set splunk.discovery.receivers.postgresql.config.databases="[<db>]"` command or the
+#               `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_databases="[<db>]"` environment variable.
+#         - regexp: 'pq: SSL is not enabled on the server'
+#           first_only: true
+#           log_record:
+#             severity_text: info
+#             append_pattern: true
+#             body: >-
+#               Make sure the target database has SSL enabled or set insecure using the
+#               `--set splunk.discovery.receivers.postgresql.config.tls::insecure="<boolean>"` command or the
+#               `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_tls_x3a__x3a_insecure="<boolean>"` environment variable.
+#         - regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'
+#           first_only: true
+#           log_record:
+#             severity_text: info
+#             append_pattern: true
+#             body: >-
+#               Make sure your PostgreSQL database has
+#               `shared_preload_libraries = 'pg_stat_statements'`
+#               in the postgresql.conf file and that
+#               `CREATE EXTENSION IF NOT EXISTS pg_stat_statements;`
+#               has been run for each database you would like to monitor.
+#               For example:
+#               `psql --dbname "<db-name>" -c "CREATE EXTENSION pg_stat_statements;"`

cmd/otelcol/config/collector/config.d.linux/receivers/smartagent-postgresql.discovery.yaml

@@ -7,7 +7,7 @@
 # upgrades of the Collector.                                                        #
 #####################################################################################
 # smartagent/postgresql:
-#   enabled: true
+#   enabled: false
 #   rule:
 #     docker_observer: type == "container" and any([name, image, command], {# matches "(?i)postgres"}) and not (command matches "splunk.discovery")
 #     host_observer: type == "hostport" and command matches "(?i)postgres" and not (command matches "splunk.discovery")
@@ -86,4 +86,4 @@
 #               `CREATE EXTENSION IF NOT EXISTS pg_stat_statements;`
 #               has been run for each database you would like to monitor.
 #               For example:
-#               `psql --dbname "<db-name>" -c "CREATE EXTENSION pg_stat_statements;"`
+#               `psql --dbname "<db-name>" -c "CREATE EXTENSION pg_stat_statements;"`

internal/confmapprovider/discovery/README.md

@@ -137,6 +137,7 @@ The following components have bundled discovery configurations in the last Splun
 
 I. Receivers
 * `oracledb` ([Linux and Windows](./bundle/bundle.d/receivers/oracledb.discovery.yaml))
+* `postgresql` ([Linux and Windows](./bundle/bundle.d/receivers/postgresql.discovery.yaml))
 * `redis` ([Linux and Windows](./bundle/bundle.d/receivers/redis.discovery.yaml))
 * `smartagent` with `collectd/mysql` monitor type ([Linux](./bundle/bundle.d/receivers/smartagent-collectd-mysql.discovery.yaml))
 * `smartagent` with `collectd/nginx` monitor type ([Linux](./bundle/bundle.d/receivers/smartagent-collectd-nginx.discovery.yaml))

internal/confmapprovider/discovery/bundle/bundle.d/receivers/postgresql.discovery.yaml

@@ -0,0 +1,79 @@
+#####################################################################################
+#                               Do not edit manually!                               #
+# All changes must be made to associated .tmpl file before running 'make bundle.d'. #
+#####################################################################################
+postgresql:
+  enabled: true
+  rule:
+    docker_observer: type == "container" and any([name, image, command], {# matches "(?i)postgres"}) and not (command matches "splunk.discovery")
+    host_observer: type == "hostport" and command matches "(?i)postgres" and not (command matches "splunk.discovery")
+    k8s_observer: type == "port" and pod.name matches "(?i)postgres"
+  config:
+    default:
+        username: splunk.discovery.default
+        password: splunk.discovery.default
+  status:
+    metrics:
+      successful:
+        - strict: postgresql.commits
+          first_only: true
+          log_record:
+            severity_text: info
+            body: PostgreSQL receiver is working!
+    statements:
+      failed:
+        - regexp: 'connect: network is unreachable'
+          first_only: true
+          log_record:
+            severity_text: info
+            append_pattern: true
+            body: The container cannot be reached by the Collector. Make sure they're in the same network.
+        - regexp: 'connect: connection refused'
+          first_only: true
+          log_record:
+            severity_text: info
+            append_pattern: true
+            body: The container is refusing PostgreSQL connections.
+      partial:
+        - regexp: 'pq: password authentication failed for user'
+          first_only: true
+          log_record:
+            severity_text: info
+            append_pattern: true
+            body: >-
+              Please ensure your user credentials are correctly specified with
+              `--set splunk.discovery.receivers.postgresql.config.username="<username>"` and
+              `--set splunk.discovery.receivers.postgresql.config.password="<password>"` or
+              `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_username="<username>"` and
+              `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_password="<password>"` environment variables.
+        - regexp: 'pq: database .* does not exist'
+          first_only: true
+          log_record:
+            severity_text: info
+            append_pattern: true
+            body: >-
+              Make sure the target database is correctly specified using the
+              `--set splunk.discovery.receivers.postgresql.config.databases="[<db>]"` command or the
+              `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_databases="[<db>]"` environment variable.
+        - regexp: 'pq: SSL is not enabled on the server'
+          first_only: true
+          log_record:
+            severity_text: info
+            append_pattern: true
+            body: >-
+              Make sure the target database has SSL enabled or set insecure using the
+              `--set splunk.discovery.receivers.postgresql.config.tls::insecure="<boolean>"` command or the
+              `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_tls_x3a__x3a_insecure="<boolean>"` environment variable.
+        - regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'
+          first_only: true
+          log_record:
+            severity_text: info
+            append_pattern: true
+            body: >-
+              Make sure your PostgreSQL database has
+              `shared_preload_libraries = 'pg_stat_statements'`
+              in the postgresql.conf file and that
+              `CREATE EXTENSION IF NOT EXISTS pg_stat_statements;`
+              has been run for each database you would like to monitor.
+              For example:
+              `psql --dbname "<db-name>" -c "CREATE EXTENSION pg_stat_statements;"`

internal/confmapprovider/discovery/bundle/bundle.d/receivers/postgresql.discovery.yaml.tmpl

@@ -0,0 +1,75 @@
+{{ receiver "postgresql" }}:
+  enabled: true
+  rule:
+    docker_observer: type == "container" and any([name, image, command], {# matches "(?i)postgres"}) and not (command matches "splunk.discovery")
+    host_observer: type == "hostport" and command matches "(?i)postgres" and not (command matches "splunk.discovery")
+    k8s_observer: type == "port" and pod.name matches "(?i)postgres"
+  config:
+    default:
+        username: {{ defaultValue }}
+        password: {{ defaultValue }}
+  status:
+    metrics:
+      successful:
+        - strict: postgresql.commits
+          first_only: true
+          log_record:
+            severity_text: info
+            body: PostgreSQL receiver is working!
+    statements:
+      failed:
+        - regexp: 'connect: network is unreachable'
+          first_only: true
+          log_record:
+            severity_text: info
+            append_pattern: true
+            body: The container cannot be reached by the Collector. Make sure they're in the same network.
+        - regexp: 'connect: connection refused'
+          first_only: true
+          log_record:
+            severity_text: info
+            append_pattern: true
+            body: The container is refusing PostgreSQL connections.
+      partial:
+        - regexp: 'pq: password authentication failed for user'
+          first_only: true
+          log_record:
+            severity_text: info
+            append_pattern: true
+            body: >-
+              Please ensure your user credentials are correctly specified with
+              `--set {{ configProperty "username" "<username>" }}` and
+              `--set {{ configProperty "password" "<password>" }}` or
+              `{{ configPropertyEnvVar "username" "<username>" }}` and
+              `{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
+        - regexp: 'pq: database .* does not exist'
+          first_only: true
+          log_record:
+            severity_text: info
+            append_pattern: true
+            body: >-
+              Make sure the target database is correctly specified using the
+              `--set {{ configProperty "databases" "[<db>]" }}` command or the
+              `{{ configPropertyEnvVar "databases" "[<db>]" }}` environment variable.
+        - regexp: 'pq: SSL is not enabled on the server'
+          first_only: true
+          log_record:
+            severity_text: info
+            append_pattern: true
+            body: >-
+              Make sure the target database has SSL enabled or set insecure using the
+              `--set {{ configProperty "tls::insecure" "<boolean>" }}` command or the
+              `{{ configPropertyEnvVar "tls::insecure" "<boolean>" }}` environment variable.
+        - regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'
+          first_only: true
+          log_record:
+            severity_text: info
+            append_pattern: true
+            body: >-
+              Make sure your PostgreSQL database has
+              `shared_preload_libraries = 'pg_stat_statements'`
+              in the postgresql.conf file and that
+              `CREATE EXTENSION IF NOT EXISTS pg_stat_statements;`
+              has been run for each database you would like to monitor.
+              For example:
+              `psql --dbname "<db-name>" -c "CREATE EXTENSION pg_stat_statements;"`

internal/confmapprovider/discovery/bundle/bundle.d/receivers/smartagent-postgresql.discovery.yaml

@@ -3,7 +3,7 @@
 # All changes must be made to associated .tmpl file before running 'make bundle.d'. #
 #####################################################################################
 smartagent/postgresql:
-  enabled: true
+  enabled: false
   rule:
     docker_observer: type == "container" and any([name, image, command], {# matches "(?i)postgres"}) and not (command matches "splunk.discovery")
     host_observer: type == "hostport" and command matches "(?i)postgres" and not (command matches "splunk.discovery")
@@ -82,4 +82,4 @@ smartagent/postgresql:
               `CREATE EXTENSION IF NOT EXISTS pg_stat_statements;`
               has been run for each database you would like to monitor.
               For example:
-              `psql --dbname "<db-name>" -c "CREATE EXTENSION pg_stat_statements;"`
+              `psql --dbname "<db-name>" -c "CREATE EXTENSION pg_stat_statements;"`

internal/confmapprovider/discovery/bundle/bundle.d/receivers/smartagent-postgresql.discovery.yaml.tmpl

@@ -1,5 +1,5 @@
 {{ receiver "smartagent/postgresql" }}:
-  enabled: true
+  enabled: false
   rule:
     docker_observer: type == "container" and any([name, image, command], {# matches "(?i)postgres"}) and not (command matches "splunk.discovery")
     host_observer: type == "hostport" and command matches "(?i)postgres" and not (command matches "splunk.discovery")
@@ -78,4 +78,4 @@
               `CREATE EXTENSION IF NOT EXISTS pg_stat_statements;`
               has been run for each database you would like to monitor.
               For example:
-              `psql --dbname "<db-name>" -c "CREATE EXTENSION pg_stat_statements;"`
+              `psql --dbname "<db-name>" -c "CREATE EXTENSION pg_stat_statements;"`

internal/confmapprovider/discovery/bundle/bundle_gen.go

@@ -25,6 +25,8 @@
 
 //go:generate discoverybundler -r -t bundle.d/receivers/oracledb.discovery.yaml.tmpl
 //go:generate discoverybundler -r -c -d ../../../../cmd/otelcol/config/collector/config.d.linux/receivers -t bundle.d/receivers/oracledb.discovery.yaml.tmpl
+//go:generate discoverybundler -r -t bundle.d/receivers/postgresql.discovery.yaml.tmpl
+//go:generate discoverybundler -r -c -d ../../../../cmd/otelcol/config/collector/config.d.linux/receivers -t bundle.d/receivers/postgresql.discovery.yaml.tmpl
 //go:generate discoverybundler -r -t bundle.d/receivers/redis.discovery.yaml.tmpl
 //go:generate discoverybundler -r -c -d ../../../../cmd/otelcol/config/collector/config.d.linux/receivers -t bundle.d/receivers/redis.discovery.yaml.tmpl
 //go:generate discoverybundler -r -t bundle.d/receivers/smartagent-collectd-mysql.discovery.yaml.tmpl

internal/confmapprovider/discovery/bundle/bundledfs_other_test.go

@@ -28,6 +28,7 @@ func TestBundleDir(t *testing.T) {
 	require.NoError(t, err)
 	require.Equal(t, []string{
 		"bundle.d/receivers/oracledb.discovery.yaml",
+		"bundle.d/receivers/postgresql.discovery.yaml",
 		"bundle.d/receivers/redis.discovery.yaml",
 		"bundle.d/receivers/smartagent-collectd-mysql.discovery.yaml",
 		"bundle.d/receivers/smartagent-collectd-nginx.discovery.yaml",

internal/confmapprovider/discovery/bundle/bundledfs_others.go

@@ -26,6 +26,7 @@ import (
 //go:embed bundle.d/extensions/host-observer.discovery.yaml
 //go:embed bundle.d/extensions/k8s-observer.discovery.yaml
 //go:embed bundle.d/receivers/oracledb.discovery.yaml
+//go:embed bundle.d/receivers/postgresql.discovery.yaml
 //go:embed bundle.d/receivers/redis.discovery.yaml
 //go:embed bundle.d/receivers/smartagent-collectd-mysql.discovery.yaml
 //go:embed bundle.d/receivers/smartagent-collectd-nginx.discovery.yaml

internal/confmapprovider/discovery/bundle/bundledfs_windows.go

@@ -26,6 +26,7 @@ import (
 //go:embed bundle.d/extensions/host-observer.discovery.yaml
 //go:embed bundle.d/extensions/k8s-observer.discovery.yaml
 //go:embed bundle.d/receivers/oracledb.discovery.yaml
+//go:embed bundle.d/receivers/postgresql.discovery.yaml
 //go:embed bundle.d/receivers/redis.discovery.yaml
 //go:embed bundle.d/receivers/smartagent-postgresql.discovery.yaml
 var BundledFS embed.FS

internal/confmapprovider/discovery/bundle/bundledfs_windows_test.go

@@ -28,6 +28,7 @@ func TestBundleDir(t *testing.T) {
 	require.NoError(t, err)
 	require.Equal(t, []string{
 		"bundle.d/receivers/oracledb.discovery.yaml",
+		"bundle.d/receivers/postgresql.discovery.yaml",
 		"bundle.d/receivers/redis.discovery.yaml",
 		"bundle.d/receivers/smartagent-postgresql.discovery.yaml",
 	}, receivers)

internal/confmapprovider/discovery/bundle/components.go

@@ -32,6 +32,7 @@ var (
 	// in Components.Linux. If desired in windows BundledFS, ensure they are included in Components.Windows.
 	receivers = []string{
 		"oracledb",
+		"postgresql",
 		"redis",
 		"smartagent-collectd-mysql",
 		"smartagent-collectd-nginx",
@@ -60,6 +61,7 @@ var (
 		Windows: func() map[string]struct{} {
 			windows := map[string]struct{}{
 				"oracledb":              {},
+				"postgresql":            {},
 				"redis":                 {},
 				"smartagent-postgresql": {},
 			}