[discovery] Simplify the instructions for partial success (signalfx#4912

) We want to show the error messages in the UI. This change addresses the feedback from the UI team: provide specific instructions instead of options. So we keep the env variables approach as it's easily configurable in any environments and likely will be supported for longer.
shalper2 · May 31, 2024 · 2d91f06 · 2d91f06
1 parent 6faf85f
commit 2d91f06
Show file tree

Hide file tree

Showing 27 changed files with 1 addition and 79 deletions.
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
@@ -43,8 +43,6 @@
 #         log_record:
 #           body: >-
 #               Please ensure your user credentials are correctly specified with
-#               `--set splunk.discovery.receivers.mongodb.config.username="<username>"` and
-#               `--set splunk.discovery.receivers.mongodb.config.password="<password>"` or
 #               `SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_username="<username>"` and
 #               `SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_password="<password>"` environment variables.
 #       - status: partial

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
@@ -32,7 +32,5 @@
 #         log_record:
 #           body: >-
 #             Make sure your user credentials are correctly specified using the
-#             `--set splunk.discovery.receivers.mysql.config.username="<username>"` and
-#             `--set splunk.discovery.receivers.mysql.config.password="<password>"` command or the
 #             `SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_username="<username>"` and
 #             `SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_password="<password>"` environment variables.
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
@@ -45,14 +45,11 @@
 #         log_record:
 #           body: >-
 #             Make sure your oracledb service is correctly specified using the
-#             `--set splunk.discovery.receivers.oracledb.config.service="<service>"` command or the
 #             `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_service="<service>"` environment variable.
 #       - status: partial
 #         regexp: 'invalid username/password'
 #         log_record:
 #           body: >-
 #             Make sure your user credentials are correctly specified using the
-#             `--set splunk.discovery.receivers.oracledb.config.username="<username>"` and
-#             `--set splunk.discovery.receivers.oracledb.config.password="<password>"` command or the
 #             `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_username="<username>"` and
 #             `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_password="<password>"` environment variables.
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
@@ -36,23 +36,19 @@
 #         log_record:
 #           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.
 #       - status: partial
 #         regexp: 'pq: database .* does not exist'
 #         log_record:
 #           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.
 #       - status: partial
 #         regexp: 'pq: SSL is not enabled on the server'
 #         log_record:
 #           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.
 #       - status: partial
 #         regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'

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
@@ -38,23 +38,18 @@
 #         log_record:
 #           body: >-
 #             Make sure your user credentials are correctly specified using the
-#             `--set splunk.discovery.receivers.redis.config.password="<password>"` and
-#             `--set splunk.discovery.receivers.redis.config.username="<username>"` commands or the
 #             `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` and
 #             `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variables.
 #       - status: partial
 #         regexp: 'called without any password configured for the default user'
 #         log_record:
 #           body: >-
 #             Make sure your user credentials are correctly specified using the
-#             `--set splunk.discovery.receivers.redis.config.password="<password>"` command or the
 #             `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variables.
 #       - status: partial
 #         regexp: 'WRONGPASS invalid username-password pair or user is disabled'
 #         log_record:
 #           body: >-
 #             Make sure your user credentials are correctly specified using the
-#             `--set splunk.discovery.receivers.redis.config.password="<password>"` and
-#             `--set splunk.discovery.receivers.redis.config.username="<username>"` commands or the
 #             `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` and
 #             `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variables.
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
@@ -36,21 +36,17 @@
 #         log_record:
 #           body: >-
 #             Make sure your user credentials are correctly specified using the
-#             `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.username="<username>"` and
-#             `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.password="<password>"` command or 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.
 #       - status: partial
 #         regexp: 'mysql plugin: Failed to connect to database .* at server .* Unknown database'
 #         log_record:
 #           body: >-
 #             Make sure your MySQL databases are correctly specified using the
-#             `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` command or 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.
 #       - status: partial
 #         regexp: 'mysql plugin: Failed to connect to database .* at server .* Access denied for user .* to database'
 #         log_record:
 #           body: >-
 #             Make sure your MySQL databases and auth information are correctly specified using the
-#             `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` command or 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.
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
@@ -49,16 +49,13 @@
 #         log_record:
 #           body: >-
 #             Please ensure your user credentials are correctly specified with
-#             `--set splunk.discovery.receivers.smartagent/postgresql.config.params::username="<username>"` and
-#             `--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.
 #       - status: partial
 #         regexp: 'pq: database .* does not exist'
 #         log_record:
 #           body: >-
 #             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.
 #       - status: partial
 #         regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'

diff --git a/internal/confmapprovider/discovery/bundle/README.md b/internal/confmapprovider/discovery/bundle/README.md
@@ -32,7 +32,6 @@ Example `redis.discovery.yaml.tmpl`:
           log_record:
             body: >-
               Please ensure your redis password is correctly specified with
-              `--set {{ configProperty "password" "<password>" }}` or
               `{{ configPropertyEnvVar "password" "<username>" }}` environment variable.
 ```
 

diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/mongodb.discovery.yaml b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/mongodb.discovery.yaml
@@ -39,8 +39,6 @@ mongodb:
         log_record:
           body: >-
               Please ensure your user credentials are correctly specified with
-              `--set splunk.discovery.receivers.mongodb.config.username="<username>"` and
-              `--set splunk.discovery.receivers.mongodb.config.password="<password>"` or
               `SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_username="<username>"` and
               `SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_password="<password>"` environment variables.
       - status: partial

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
@@ -35,8 +35,6 @@
         log_record:
           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.
       - status: partial

diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/mysql.discovery.yaml b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/mysql.discovery.yaml
@@ -28,7 +28,5 @@ mysql:
         log_record:
           body: >-
             Make sure your user credentials are correctly specified using the
-            `--set splunk.discovery.receivers.mysql.config.username="<username>"` and
-            `--set splunk.discovery.receivers.mysql.config.password="<password>"` command or the
             `SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_username="<username>"` and
             `SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_password="<password>"` environment variables.
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
@@ -24,7 +24,5 @@
         log_record:
           body: >-
             Make sure your user credentials are correctly specified using the
-            `--set {{ configProperty "username" "<username>" }}` and
-            `--set {{ configProperty "password" "<password>" }}` command or the
             `{{ configPropertyEnvVar "username" "<username>" }}` and
             `{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/oracledb.discovery.yaml b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/oracledb.discovery.yaml
@@ -41,14 +41,11 @@ oracledb:
         log_record:
           body: >-
             Make sure your oracledb service is correctly specified using the
-            `--set splunk.discovery.receivers.oracledb.config.service="<service>"` command or the
             `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_service="<service>"` environment variable.
       - status: partial
         regexp: 'invalid username/password'
         log_record:
           body: >-
             Make sure your user credentials are correctly specified using the
-            `--set splunk.discovery.receivers.oracledb.config.username="<username>"` and
-            `--set splunk.discovery.receivers.oracledb.config.password="<password>"` command or the
             `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_username="<username>"` and
             `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_password="<password>"` environment variables.
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
@@ -37,14 +37,11 @@
         log_record:
           body: >-
             Make sure your oracledb service is correctly specified using the
-            `--set {{ configProperty "service" "<service>" }}` command or the
             `{{ configPropertyEnvVar "service" "<service>" }}` environment variable.
       - status: partial
         regexp: 'invalid username/password'
         log_record:
           body: >-
             Make sure your user credentials are correctly specified using the
-            `--set {{ configProperty "username" "<username>" }}` and
-            `--set {{ configProperty "password" "<password>" }}` command or the
             `{{ configPropertyEnvVar "username" "<username>" }}` and
             `{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/postgresql.discovery.yaml b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/postgresql.discovery.yaml
@@ -32,23 +32,19 @@ postgresql:
         log_record:
           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.
       - status: partial
         regexp: 'pq: database .* does not exist'
         log_record:
           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.
       - status: partial
         regexp: 'pq: SSL is not enabled on the server'
         log_record:
           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.
       - status: partial
         regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'

diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/postgresql.discovery.yaml.tmpl b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/postgresql.discovery.yaml.tmpl
@@ -28,23 +28,19 @@
         log_record:
           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.
       - status: partial
         regexp: 'pq: database .* does not exist'
         log_record:
           body: >-
             Make sure the target database is correctly specified using the
-            `--set {{ configProperty "databases" "[<db>]" }}` command or the
             `{{ configPropertyEnvVar "databases" "[<db>]" }}` environment variable.
       - status: partial
         regexp: 'pq: SSL is not enabled on the server'
         log_record:
           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.
       - status: partial
         regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'

diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/redis.discovery.yaml b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/redis.discovery.yaml
@@ -34,23 +34,18 @@ redis:
         log_record:
           body: >-
             Make sure your user credentials are correctly specified using the
-            `--set splunk.discovery.receivers.redis.config.password="<password>"` and
-            `--set splunk.discovery.receivers.redis.config.username="<username>"` commands or the
             `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` and
             `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variables.
       - status: partial
         regexp: 'called without any password configured for the default user'
         log_record:
           body: >-
             Make sure your user credentials are correctly specified using the
-            `--set splunk.discovery.receivers.redis.config.password="<password>"` command or the
             `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variables.
       - status: partial
         regexp: 'WRONGPASS invalid username-password pair or user is disabled'
         log_record:
           body: >-
             Make sure your user credentials are correctly specified using the
-            `--set splunk.discovery.receivers.redis.config.password="<password>"` and
-            `--set splunk.discovery.receivers.redis.config.username="<username>"` commands or the
             `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` and
             `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variables.
diff --git a/internal/confmapprovider/discovery/bundle/bundle.d/receivers/redis.discovery.yaml.tmpl b/internal/confmapprovider/discovery/bundle/bundle.d/receivers/redis.discovery.yaml.tmpl
@@ -30,23 +30,18 @@
         log_record:
           body: >-
             Make sure your user credentials are correctly specified using the
-            `--set {{ configProperty "password" "<password>" }}` and
-            `--set {{ configProperty "username" "<username>" }}` commands or the
             `{{ configPropertyEnvVar "password" "<password>" }}` and
             `{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
       - status: partial
         regexp: 'called without any password configured for the default user'
         log_record:
           body: >-
             Make sure your user credentials are correctly specified using the
-            `--set {{ configProperty "password" "<password>" }}` command or the
             `{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
       - status: partial
         regexp: 'WRONGPASS invalid username-password pair or user is disabled'
         log_record:
           body: >-
             Make sure your user credentials are correctly specified using the
-            `--set {{ configProperty "password" "<password>" }}` and
-            `--set {{ configProperty "username" "<username>" }}` commands or the
             `{{ configPropertyEnvVar "password" "<password>" }}` and
             `{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
diff --git a/...fmapprovider/discovery/bundle/bundle.d/receivers/smartagent-collectd-mysql.discovery.yaml b/...fmapprovider/discovery/bundle/bundle.d/receivers/smartagent-collectd-mysql.discovery.yaml
@@ -32,21 +32,17 @@ smartagent/collectd/mysql:
         log_record:
           body: >-
             Make sure your user credentials are correctly specified using the
-            `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.username="<username>"` and
-            `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.password="<password>"` command or 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.
       - status: partial
         regexp: 'mysql plugin: Failed to connect to database .* at server .* Unknown database'
         log_record:
           body: >-
             Make sure your MySQL databases are correctly specified using the
-            `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` command or 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.
       - status: partial
         regexp: 'mysql plugin: Failed to connect to database .* at server .* Access denied for user .* to database'
         log_record:
           body: >-
             Make sure your MySQL databases and auth information are correctly specified using the
-            `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` command or 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.