[discovery] update instructions for partial discovery

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 🛑

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

@@ -36,12 +36,16 @@
 #         message: The container is refusing mongodb connections.
 #       - 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.
+#         message: |-
+#           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: >-
+#         message: |-
 #           Make sure the account used to access Mongodb has been given a clusterMonitor role in order to collect metrics.
-#           `db.grantRolesToUser('someUser', [{ role: 'clusterMonitor', db: 'admin' }])`
+#           ```
+#           db.grantRolesToUser('someUser', [{ role: 'clusterMonitor', db: 'admin' }])
+#           ```

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

@@ -27,7 +27,9 @@
 #         message:  The container cannot be reached by the Collector. The container is refusing MySQL connections.
 #       - 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.
+#         message: |-
+#           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>"
+#           ```

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

@@ -37,12 +37,16 @@
 #         message: Unable to execute select from oracledb. Verify endpoint and user permissions.
 #       - 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.
+#         message: |-
+#           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.
+#         message: |-
+#           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>"
+#           ```

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

@@ -30,27 +30,30 @@
 #         message: The container is refusing PostgreSQL connections.
 #       - 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.
+#         message: |-
+#           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.
+#         message: |-
+#           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.
+#         message: |-
+#           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: >-
-#           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;"`
+#         message: |-
+#           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/redis.discovery.yaml

@@ -31,16 +31,22 @@
 #         message: Unable to resolve redis tcp endpoint
 #       - 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.
+#         message: |-
+#           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.
+#         message: |-
+#           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.
+#         message: |-
+#           Make sure your user credentials are correctly specified as an environment variable.
+#           ```
+#           SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"
+#           ```

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

@@ -31,17 +31,23 @@
 #         message: The container is refusing MySQL connections.
 #       - 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.
+#         message: |-
+#           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.
+#         message: |-
+#           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.
+#         message: |-
+#           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>'}]"
+#           ```

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

@@ -27,12 +27,11 @@
 #         message: PostgreSQL receiver is working!
 #       - status: partial
 #         strict: postgres_rows_inserted
-#         message: >-
-#           Make sure 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 IF NOT EXISTS pg_stat_statements;"`
+#         message: |-
+#           Make sure 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 IF NOT EXISTS pg_stat_statements;"
+#           ```
 #     statements:
 #       - status: failed
 #         regexp: 'connect: network is unreachable'
@@ -42,22 +41,23 @@
 #         message: The container is refusing PostgreSQL connections.
 #       - 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.
+#         message: |-
+#           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.
+#         message: |-
+#           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: >-
-#           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;"`
+#         message: |-
+#           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/sqlserver.discovery.yaml

@@ -93,12 +93,16 @@
 #         message: Unable to resolve sql server tcp endpoint
 #       - 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.
+#         message: |-
+#             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]`
+#         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]
+#             ```

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

@@ -32,12 +32,16 @@ mongodb:
         message: The container is refusing mongodb connections.
       - 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.
+        message: |-
+          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: >-
+        message: |-
           Make sure the account used to access Mongodb has been given a clusterMonitor role in order to collect metrics.
-          `db.grantRolesToUser('someUser', [{ role: 'clusterMonitor', db: 'admin' }])`
+          ```
+          db.grantRolesToUser('someUser', [{ role: 'clusterMonitor', db: 'admin' }])
+          ```

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

@@ -28,12 +28,16 @@
         message: The container is refusing mongodb connections.
       - 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.
+        message: |-
+          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: >-
+        message: |-
           Make sure the account used to access Mongodb has been given a clusterMonitor role in order to collect metrics.
-          `db.grantRolesToUser('someUser', [{ role: 'clusterMonitor', db: 'admin' }])`
+          ```
+          db.grantRolesToUser('someUser', [{ role: 'clusterMonitor', db: 'admin' }])
+          ```

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

@@ -23,7 +23,9 @@ mysql:
         message:  The container cannot be reached by the Collector. The container is refusing MySQL connections.
       - 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.
+        message: |-
+          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>"
+          ```

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

@@ -19,7 +19,9 @@
         message:  The container cannot be reached by the Collector. The container is refusing MySQL connections.
       - 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.
+        message: |-
+          Make sure your user credentials are correctly specified as environment variables.
+          ```
+          {{ configPropertyEnvVar "username" "<username>" }}
+          {{ configPropertyEnvVar "password" "<password>" }}
+          ```