[discovery] update instructions for partial discovery

The new format was suggested by the UI team
signalfx · Sep 24, 2024 · 3258d11 · 3258d11
1 parent 7a7a149
commit 3258d11
Show file tree

Hide file tree

Showing 25 changed files with 256 additions and 129 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### 💡 Enhancements 💡
+
+- (Splunk) Update instruction for partial discovery ([#5402](https://github.com/signalfx/splunk-otel-collector/pull/5402))
+
 ## v0.109.0
 
 ### 🛑 Breaking changes 🛑

diff --git a/cmd/otelcol/config/collector/config.d.linux/receivers/mongodb.discovery.yaml b/cmd/otelcol/config/collector/config.d.linux/receivers/mongodb.discovery.yaml
@@ -37,9 +37,11 @@
 #       - status: partial
 #         regexp: '.* unable to authenticate using mechanism .*'
 #         message: >-
-#           Please ensure your user credentials are correctly specified with
-#           `SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_username="<username>"` and
-#           `SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_password="<password>"` environment variables.
+#           Make sure your user credentials are correctly specified as environment variables.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_username="<username>"
+#           SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_password="<password>"
+#           ```
 #       - status: partial
 #         regexp: '.* failed to fetch index stats metrics: (Unauthorized) not authorized on admin to execute command .*'
 #         message: >-

diff --git a/cmd/otelcol/config/collector/config.d.linux/receivers/mysql.discovery.yaml b/cmd/otelcol/config/collector/config.d.linux/receivers/mysql.discovery.yaml
@@ -28,6 +28,8 @@
 #       - status: partial
 #         regexp: 'Access denied for user'
 #         message: >-
-#           Make sure your user credentials are correctly specified using the
-#           `SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_username="<username>"` and
-#           `SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_password="<password>"` environment variables.
+#           Make sure your user credentials are correctly specified as environment variables.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_username="<username>"
+#           SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_password="<password>"
+#           ```
diff --git a/cmd/otelcol/config/collector/config.d.linux/receivers/oracledb.discovery.yaml b/cmd/otelcol/config/collector/config.d.linux/receivers/oracledb.discovery.yaml
@@ -38,11 +38,15 @@
 #       - status: partial
 #         regexp: "listener does not currently know of service requested"
 #         message: >-
-#           Make sure your oracledb service is correctly specified using the
-#           `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_service="<service>"` environment variable.
+#           Make sure your oracledb service is correctly specified using an environment variable.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_service="<service>"
+#           ```
 #       - status: partial
 #         regexp: 'invalid username/password'
 #         message: >-
-#           Make sure your user credentials are correctly specified using the
-#           `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_username="<username>"` and
-#           `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_password="<password>"` environment variables.
+#           Make sure your user credentials are correctly specified as environment variables.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_username="<username>"
+#           SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_password="<password>"
+#           ```
diff --git a/cmd/otelcol/config/collector/config.d.linux/receivers/postgresql.discovery.yaml b/cmd/otelcol/config/collector/config.d.linux/receivers/postgresql.discovery.yaml
@@ -31,19 +31,25 @@
 #       - status: partial
 #         regexp: 'pq: password authentication failed for user'
 #         message: >-
-#           Please ensure your user credentials are correctly specified with
-#           `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_username="<username>"` and
-#           `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_password="<password>"` environment variables.
+#           Make sure your user credentials are correctly specified as environment variables.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_username="<username>"
+#           SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_password="<password>"
+#           ```
 #       - status: partial
 #         regexp: 'pq: database .* does not exist'
 #         message: >-
-#           Make sure the target database is correctly specified using the
-#           `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_databases="[<db>]"` environment variable.
+#           Make sure the target database is correctly specified as an environment variable.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_databases="[<db>]"
+#           ```
 #       - status: partial
 #         regexp: 'pq: SSL is not enabled on the server'
 #         message: >-
-#           Make sure the target database has SSL enabled or set insecure using the
-#           `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_tls_x3a__x3a_insecure="<boolean>"` environment variable.
+#           Make sure the target database has SSL enabled or set insecure as an environment variable.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_tls_x3a__x3a_insecure="<boolean>"
+#           ```
 #       - status: partial
 #         regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'
 #         message: >-
@@ -53,4 +59,6 @@
 #           `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;"
+#           ```
diff --git a/cmd/otelcol/config/collector/config.d.linux/receivers/redis.discovery.yaml b/cmd/otelcol/config/collector/config.d.linux/receivers/redis.discovery.yaml
@@ -32,15 +32,21 @@
 #       - status: partial
 #         regexp: 'NOAUTH Authentication required.'
 #         message: >-
-#           Make sure your user credentials are correctly specified using the
-#           `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variable.
+#           Make sure your user credentials are correctly specified as an environment variable.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"
+#           ```
 #       - status: partial
 #         regexp: 'called without any password configured for the default user'
 #         message: >-
-#           Make sure your user credentials are correctly specified using the
-#           `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variable.
+#           Make sure your user credentials are correctly specified as an environment variable.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"
+#           ```
 #       - status: partial
 #         regexp: 'WRONGPASS invalid username-password pair or user is disabled'
 #         message: >-
-#           Make sure your user credentials are correctly specified using the
-#           `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variable.
+#           Make sure your user credentials are correctly specified as an environment variable.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"
+#           ```
diff --git a/...telcol/config/collector/config.d.linux/receivers/smartagent-collectd-mysql.discovery.yaml b/...telcol/config/collector/config.d.linux/receivers/smartagent-collectd-mysql.discovery.yaml
@@ -32,16 +32,22 @@
 #       - status: partial
 #         regexp: 'mysql plugin: Failed to connect to database .* at server .* Access denied for user .* [(]using password: .*[)]'
 #         message: >-
-#           Make sure your user credentials are correctly specified using the
-#           `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_username="<username>"` and
-#           `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_password="<password>"` environment variables.
+#           Make sure your user credentials are correctly specified as environment variables.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_username="<username>"
+#           SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_password="<password>"
+#           ```
 #       - status: partial
 #         regexp: 'mysql plugin: Failed to connect to database .* at server .* Unknown database'
 #         message: >-
-#           Make sure your MySQL databases are correctly specified using the
-#           `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` environment variable.
+#           Make sure your MySQL databases are correctly specified using as an environment variable.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"
+#           ```
 #       - status: partial
 #         regexp: 'mysql plugin: Failed to connect to database .* at server .* Access denied for user .* to database'
 #         message: >-
-#           Make sure your MySQL databases and auth information are correctly specified using the
-#           `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` environment variable.
+#           Make sure your MySQL databases and auth information are correctly specified as environment variables.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"
+#           ```
diff --git a/cmd/otelcol/config/collector/config.d.linux/receivers/smartagent-postgresql.discovery.yaml b/cmd/otelcol/config/collector/config.d.linux/receivers/smartagent-postgresql.discovery.yaml
@@ -32,7 +32,9 @@
 #           `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 IF NOT EXISTS pg_stat_statements;"`
+#           ```
+#           psql --dbname "<db-name>" -c "CREATE EXTENSION IF NOT EXISTS pg_stat_statements;"
+#           ```
 #     statements:
 #       - status: failed
 #         regexp: 'connect: network is unreachable'
@@ -43,14 +45,18 @@
 #       - status: partial
 #         regexp: 'pq: password authentication failed for user'
 #         message: >-
-#           Please ensure your user credentials are correctly specified with
-#           `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.
+#           Please ensure your user credentials are correctly specified as environment variables.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_postgresql_CONFIG_params_x3a__x3a_username="<username>"
+#           SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_postgresql_CONFIG_params_x3a__x3a_password="<password>"
+#           ```
 #       - status: partial
 #         regexp: 'pq: database .* does not exist'
 #         message: >-
-#           Make sure the target database is correctly specified using the
-#           `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_postgresql_CONFIG_masterDBName="<db>"` environment variable.
+#           Make sure the target database is correctly specified as an environment variable.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_postgresql_CONFIG_masterDBName="<db>"
+#           ```
 #       - status: partial
 #         regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'
 #         message: >-
@@ -60,4 +66,6 @@
 #           `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;"
+#           ```
diff --git a/cmd/otelcol/config/collector/config.d.linux/receivers/sqlserver.discovery.yaml b/cmd/otelcol/config/collector/config.d.linux/receivers/sqlserver.discovery.yaml
@@ -94,11 +94,16 @@
 #       - status: partial
 #         regexp: "Login failed for user"
 #         message: >-
-#             Make sure your user credentials are correctly specified using the
-#             `SPLUNK_DISCOVERY_RECEIVERS_sqlserver_CONFIG_username="<username>"` and
-#             `SPLUNK_DISCOVERY_RECEIVERS_sqlserver_CONFIG_password="<password>"` environment variables.
+#             Make sure your user credentials are correctly specified as environment variables.
+#             ```
+#             SPLUNK_DISCOVERY_RECEIVERS_sqlserver_CONFIG_username="<username>"
+#             SPLUNK_DISCOVERY_RECEIVERS_sqlserver_CONFIG_password="<password>"
+#             ```
 #       - status: partial
 #         regexp: "The user does not have permission"
 #         message: >-
 #             Specified user does not have proper permissions. User must have view `SERVER STATE` permissions.
-#             This can be accomplished by: `GRANT VIEW SERVER STATE TO [username]`
+#             This can be accomplished by:
+#             ```
+#             GRANT VIEW SERVER STATE TO [username]
+#             ```
diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/mongodb.discovery.yaml b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/mongodb.discovery.yaml
@@ -33,9 +33,11 @@ mongodb:
       - status: partial
         regexp: '.* unable to authenticate using mechanism .*'
         message: >-
-          Please ensure your user credentials are correctly specified with
-          `SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_username="<username>"` and
-          `SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_password="<password>"` environment variables.
+          Make sure your user credentials are correctly specified as environment variables.
+          ```
+          SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_username="<username>"
+          SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_password="<password>"
+          ```
       - status: partial
         regexp: '.* failed to fetch index stats metrics: (Unauthorized) not authorized on admin to execute command .*'
         message: >-

diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/mongodb.discovery.yaml.tmpl b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/mongodb.discovery.yaml.tmpl
@@ -29,9 +29,11 @@
       - status: partial
         regexp: '.* unable to authenticate using mechanism .*'
         message: >-
-          Please ensure your user credentials are correctly specified with
-          `{{ configPropertyEnvVar "username" "<username>" }}` and
-          `{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
+          Make sure your user credentials are correctly specified as environment variables.
+          ```
+          {{ configPropertyEnvVar "username" "<username>" }}
+          {{ configPropertyEnvVar "password" "<password>" }}
+          ```
       - status: partial
         regexp: '.* failed to fetch index stats metrics: (Unauthorized) not authorized on admin to execute command .*'
         message: >-

diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/mysql.discovery.yaml b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/mysql.discovery.yaml
@@ -24,6 +24,8 @@ mysql:
       - status: partial
         regexp: 'Access denied for user'
         message: >-
-          Make sure your user credentials are correctly specified using the
-          `SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_username="<username>"` and
-          `SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_password="<password>"` environment variables.
+          Make sure your user credentials are correctly specified as environment variables.
+          ```
+          SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_username="<username>"
+          SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_password="<password>"
+          ```
diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/mysql.discovery.yaml.tmpl b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/mysql.discovery.yaml.tmpl
@@ -20,6 +20,8 @@
       - status: partial
         regexp: 'Access denied for user'
         message: >-
-          Make sure your user credentials are correctly specified using the
-          `{{ configPropertyEnvVar "username" "<username>" }}` and
-          `{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
+          Make sure your user credentials are correctly specified as environment variables.
+          ```
+          {{ configPropertyEnvVar "username" "<username>" }}
+          {{ configPropertyEnvVar "password" "<password>" }}
+          ```
diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/oracledb.discovery.yaml b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/oracledb.discovery.yaml
@@ -34,11 +34,15 @@ oracledb:
       - status: partial
         regexp: "listener does not currently know of service requested"
         message: >-
-          Make sure your oracledb service is correctly specified using the
-          `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_service="<service>"` environment variable.
+          Make sure your oracledb service is correctly specified using an environment variable.
+          ```
+          SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_service="<service>"
+          ```
       - status: partial
         regexp: 'invalid username/password'
         message: >-
-          Make sure your user credentials are correctly specified using the
-          `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_username="<username>"` and
-          `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_password="<password>"` environment variables.
+          Make sure your user credentials are correctly specified as environment variables.
+          ```
+          SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_username="<username>"
+          SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_password="<password>"
+          ```
diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/oracledb.discovery.yaml.tmpl b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/oracledb.discovery.yaml.tmpl
@@ -30,11 +30,15 @@
       - status: partial
         regexp: "listener does not currently know of service requested"
         message: >-
-          Make sure your oracledb service is correctly specified using the
-          `{{ configPropertyEnvVar "service" "<service>" }}` environment variable.
+          Make sure your oracledb service is correctly specified using an environment variable.
+          ```
+          {{ configPropertyEnvVar "service" "<service>" }}
+          ```
       - status: partial
         regexp: 'invalid username/password'
         message: >-
-          Make sure your user credentials are correctly specified using the
-          `{{ configPropertyEnvVar "username" "<username>" }}` and
-          `{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
+          Make sure your user credentials are correctly specified as environment variables.
+          ```
+          {{ configPropertyEnvVar "username" "<username>" }}
+          {{ configPropertyEnvVar "password" "<password>" }}
+          ```
diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/postgresql.discovery.yaml b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/postgresql.discovery.yaml
@@ -27,19 +27,25 @@ postgresql:
       - status: partial
         regexp: 'pq: password authentication failed for user'
         message: >-
-          Please ensure your user credentials are correctly specified with
-          `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_username="<username>"` and
-          `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_password="<password>"` environment variables.
+          Make sure your user credentials are correctly specified as environment variables.
+          ```
+          SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_username="<username>"
+          SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_password="<password>"
+          ```
       - status: partial
         regexp: 'pq: database .* does not exist'
         message: >-
-          Make sure the target database is correctly specified using the
-          `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_databases="[<db>]"` environment variable.
+          Make sure the target database is correctly specified as an environment variable.
+          ```
+          SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_databases="[<db>]"
+          ```
       - status: partial
         regexp: 'pq: SSL is not enabled on the server'
         message: >-
-          Make sure the target database has SSL enabled or set insecure using the
-          `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_tls_x3a__x3a_insecure="<boolean>"` environment variable.
+          Make sure the target database has SSL enabled or set insecure as an environment variable.
+          ```
+          SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_tls_x3a__x3a_insecure="<boolean>"
+          ```
       - status: partial
         regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'
         message: >-
@@ -49,4 +55,6 @@ 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;"
+          ```