Add bundled k8s smartagent/postgres discovery rules (open-telemetry#3023

) * add bundle.d/smartagent/postgres k8s rules * Apply suggestions from code review Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> * Update bundle.d and remove noop change --------- Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
hughesjj · Apr 26, 2023 · cb77e96 · cb77e96
1 parent 111bbd5
commit cb77e96
Show file tree

Hide file tree

Showing 7 changed files with 522 additions and 41 deletions.
diff --git a/.../confmapprovider/discovery/bundle/bundle.d/receivers/smartagent-postgresql.discovery.yaml b/.../confmapprovider/discovery/bundle/bundle.d/receivers/smartagent-postgresql.discovery.yaml
@@ -4,7 +4,8 @@
 smartagent/postgresql:
   rule:
     docker_observer: type == "container" and port == 5432
-    host_observer: type == "hostport" and command contains "pg" and port == 5432
+    host_observer: type == "hostport" and command contains "postgres" and port == 5432
+    k8s_observer: type == "port" and pod.name contains "postgres" and port == 5432
   config:
     default:
       type: postgresql
@@ -16,20 +17,20 @@ smartagent/postgresql:
   status:
     metrics:
       successful:
-        - strict: postgres_block_hit_ratio
+        - strict: postgres_query_count
           first_only: true
           log_record:
             severity_text: info
-            body: postgresql SA receiver working!
+            body: PostgreSQL receiver is working!
     statements:
       failed:
-        - regexp: '.* connect: connection refused'
+        - regexp: 'connect: connection refused'
           first_only: true
           log_record:
             severity_text: info
-            body: container appears to not be accepting postgres connections
+            body: The container is refusing PostgreSQL connections.
       partial:
-        - regexp: '.*pq: password authentication failed for user.*'
+        - regexp: 'pq: password authentication failed for user'
           first_only: true
           log_record:
             severity_text: info
@@ -39,11 +40,29 @@ smartagent/postgresql:
               `--set splunk.discovery.receivers.smartagent/postgresql.config.params::password="<password>"` or
               `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_postgresql_CONFIG_params_x3a__x3a_username="<username>"` and
               `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_postgresql_CONFIG_params_x3a__x3a_password="<password>"` environment variables.
-        - regexp: '.*pq: database ".*" does not exist.*'
+        - regexp: 'pq: database ".*" does not exist'
           first_only: true
           log_record:
             severity_text: info
             body: >-
-              Please ensure your target database is correctly specified with
-              `--set splunk.discovery.receivers.smartagent/postgresql.config.masterDBName="<db>"` or
+              Make sure the target database is correctly specified using the
+              `--set splunk.discovery.receivers.smartagent/postgresql.config.masterDBName="<db>"` command or the
               `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_postgresql_CONFIG_masterDBName="<db>"` environment variable.
+        - regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'
+          first_only: true
+          log_record:
+            severity_text: info
+            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.
+        - regexp: 'could not monitor postgresql server: failed to determine total_time column name'
+          first_only: true
+          log_record:
+            severity_text: info
+            body: >-
+              Make sure that `pg_stat_statements` is available for each database you
+              would like to monitor. For example:
+              `psql --dbname "<db-name>" -c "CREATE EXTENSION pg_stat_statements;"`
diff --git a/...mapprovider/discovery/bundle/bundle.d/receivers/smartagent-postgresql.discovery.yaml.tmpl b/...mapprovider/discovery/bundle/bundle.d/receivers/smartagent-postgresql.discovery.yaml.tmpl
@@ -1,7 +1,8 @@
 {{ receiver "smartagent/postgresql" }}:
   rule:
     docker_observer: type == "container" and port == 5432
-    host_observer: type == "hostport" and command contains "pg" and port == 5432
+    host_observer: type == "hostport" and command contains "postgres" and port == 5432
+    k8s_observer: type == "port" and pod.name contains "postgres" and port == 5432
   config:
     default:
       type: postgresql
@@ -13,20 +14,20 @@
   status:
     metrics:
       successful:
-        - strict: postgres_block_hit_ratio
+        - strict: postgres_query_count
           first_only: true
           log_record:
             severity_text: info
-            body: postgresql SA receiver working!
+            body: PostgreSQL receiver is working!
     statements:
       failed:
-        - regexp: '.* connect: connection refused'
+        - regexp: 'connect: connection refused'
           first_only: true
           log_record:
             severity_text: info
-            body: container appears to not be accepting postgres connections
+            body: The container is refusing PostgreSQL connections.
       partial:
-        - regexp: '.*pq: password authentication failed for user.*'
+        - regexp: 'pq: password authentication failed for user'
           first_only: true
           log_record:
             severity_text: info
@@ -36,11 +37,29 @@
               `--set {{ configProperty "params" "password" "<password>" }}` or
               `{{ configPropertyEnvVar "params" "username" "<username>" }}` and
               `{{ configPropertyEnvVar "params" "password" "<password>" }}` environment variables.
-        - regexp: '.*pq: database ".*" does not exist.*'
+        - regexp: 'pq: database ".*" does not exist'
           first_only: true
           log_record:
             severity_text: info
             body: >-
-              Please ensure your target database is correctly specified with
-              `--set {{ configProperty "masterDBName" "<db>" }}` or
+              Make sure the target database is correctly specified using the
+              `--set {{ configProperty "masterDBName" "<db>" }}` command or the
               `{{ configPropertyEnvVar "masterDBName" "<db>" }}` environment variable.
+        - regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'
+          first_only: true
+          log_record:
+            severity_text: info
+            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.
+        - regexp: 'could not monitor postgresql server: failed to determine total_time column name'
+          first_only: true
+          log_record:
+            severity_text: info
+            body: >-
+              Make sure that `pg_stat_statements` is available for each database you
+              would like to monitor. For example:
+              `psql --dbname "<db-name>" -c "CREATE EXTENSION pg_stat_statements;"`