Skip to content

Commit 2d91f06

Browse files
authored
[discovery] Simplify the instructions for partial success (#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.
1 parent 6faf85f commit 2d91f06

27 files changed

+1
-79
lines changed

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,6 @@
4343
# log_record:
4444
# body: >-
4545
# Please ensure your user credentials are correctly specified with
46-
# `--set splunk.discovery.receivers.mongodb.config.username="<username>"` and
47-
# `--set splunk.discovery.receivers.mongodb.config.password="<password>"` or
4846
# `SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_username="<username>"` and
4947
# `SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_password="<password>"` environment variables.
5048
# - status: partial

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,5 @@
3232
# log_record:
3333
# body: >-
3434
# Make sure your user credentials are correctly specified using the
35-
# `--set splunk.discovery.receivers.mysql.config.username="<username>"` and
36-
# `--set splunk.discovery.receivers.mysql.config.password="<password>"` command or the
3735
# `SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_username="<username>"` and
3836
# `SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_password="<password>"` environment variables.

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,11 @@
4545
# log_record:
4646
# body: >-
4747
# Make sure your oracledb service is correctly specified using the
48-
# `--set splunk.discovery.receivers.oracledb.config.service="<service>"` command or the
4948
# `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_service="<service>"` environment variable.
5049
# - status: partial
5150
# regexp: 'invalid username/password'
5251
# log_record:
5352
# body: >-
5453
# Make sure your user credentials are correctly specified using the
55-
# `--set splunk.discovery.receivers.oracledb.config.username="<username>"` and
56-
# `--set splunk.discovery.receivers.oracledb.config.password="<password>"` command or the
5754
# `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_username="<username>"` and
5855
# `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_password="<password>"` environment variables.

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,19 @@
3636
# log_record:
3737
# body: >-
3838
# Please ensure your user credentials are correctly specified with
39-
# `--set splunk.discovery.receivers.postgresql.config.username="<username>"` and
40-
# `--set splunk.discovery.receivers.postgresql.config.password="<password>"` or
4139
# `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_username="<username>"` and
4240
# `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_password="<password>"` environment variables.
4341
# - status: partial
4442
# regexp: 'pq: database .* does not exist'
4543
# log_record:
4644
# body: >-
4745
# Make sure the target database is correctly specified using the
48-
# `--set splunk.discovery.receivers.postgresql.config.databases="[<db>]"` command or the
4946
# `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_databases="[<db>]"` environment variable.
5047
# - status: partial
5148
# regexp: 'pq: SSL is not enabled on the server'
5249
# log_record:
5350
# body: >-
5451
# Make sure the target database has SSL enabled or set insecure using the
55-
# `--set splunk.discovery.receivers.postgresql.config.tls::insecure="<boolean>"` command or the
5652
# `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_tls_x3a__x3a_insecure="<boolean>"` environment variable.
5753
# - status: partial
5854
# regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,18 @@
3838
# log_record:
3939
# body: >-
4040
# Make sure your user credentials are correctly specified using the
41-
# `--set splunk.discovery.receivers.redis.config.password="<password>"` and
42-
# `--set splunk.discovery.receivers.redis.config.username="<username>"` commands or the
4341
# `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` and
4442
# `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variables.
4543
# - status: partial
4644
# regexp: 'called without any password configured for the default user'
4745
# log_record:
4846
# body: >-
4947
# Make sure your user credentials are correctly specified using the
50-
# `--set splunk.discovery.receivers.redis.config.password="<password>"` command or the
5148
# `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variables.
5249
# - status: partial
5350
# regexp: 'WRONGPASS invalid username-password pair or user is disabled'
5451
# log_record:
5552
# body: >-
5653
# Make sure your user credentials are correctly specified using the
57-
# `--set splunk.discovery.receivers.redis.config.password="<password>"` and
58-
# `--set splunk.discovery.receivers.redis.config.username="<username>"` commands or the
5954
# `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` and
6055
# `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variables.

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,21 +36,17 @@
3636
# log_record:
3737
# body: >-
3838
# Make sure your user credentials are correctly specified using the
39-
# `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.username="<username>"` and
40-
# `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.password="<password>"` command or the
4139
# `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_username="<username>"` and
4240
# `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_password="<password>"` environment variables.
4341
# - status: partial
4442
# regexp: 'mysql plugin: Failed to connect to database .* at server .* Unknown database'
4543
# log_record:
4644
# body: >-
4745
# Make sure your MySQL databases are correctly specified using the
48-
# `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` command or the
4946
# `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` environment variable.
5047
# - status: partial
5148
# regexp: 'mysql plugin: Failed to connect to database .* at server .* Access denied for user .* to database'
5249
# log_record:
5350
# body: >-
5451
# Make sure your MySQL databases and auth information are correctly specified using the
55-
# `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` command or the
5652
# `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` environment variable.

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,13 @@
4949
# log_record:
5050
# body: >-
5151
# Please ensure your user credentials are correctly specified with
52-
# `--set splunk.discovery.receivers.smartagent/postgresql.config.params::username="<username>"` and
53-
# `--set splunk.discovery.receivers.smartagent/postgresql.config.params::password="<password>"` or
5452
# `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_postgresql_CONFIG_params_x3a__x3a_username="<username>"` and
5553
# `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_postgresql_CONFIG_params_x3a__x3a_password="<password>"` environment variables.
5654
# - status: partial
5755
# regexp: 'pq: database .* does not exist'
5856
# log_record:
5957
# body: >-
6058
# Make sure the target database is correctly specified using the
61-
# `--set splunk.discovery.receivers.smartagent/postgresql.config.masterDBName="<db>"` command or the
6259
# `SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_postgresql_CONFIG_masterDBName="<db>"` environment variable.
6360
# - status: partial
6461
# regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'

internal/confmapprovider/discovery/bundle/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ Example `redis.discovery.yaml.tmpl`:
3232
log_record:
3333
body: >-
3434
Please ensure your redis password is correctly specified with
35-
`--set {{ configProperty "password" "<password>" }}` or
3635
`{{ configPropertyEnvVar "password" "<username>" }}` environment variable.
3736
```
3837

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,6 @@ mongodb:
3939
log_record:
4040
body: >-
4141
Please ensure your user credentials are correctly specified with
42-
`--set splunk.discovery.receivers.mongodb.config.username="<username>"` and
43-
`--set splunk.discovery.receivers.mongodb.config.password="<password>"` or
4442
`SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_username="<username>"` and
4543
`SPLUNK_DISCOVERY_RECEIVERS_mongodb_CONFIG_password="<password>"` environment variables.
4644
- status: partial

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,6 @@
3535
log_record:
3636
body: >-
3737
Please ensure your user credentials are correctly specified with
38-
`--set {{ configProperty "username" "<username>" }}` and
39-
`--set {{ configProperty "password" "<password>" }}` or
4038
`{{ configPropertyEnvVar "username" "<username>" }}` and
4139
`{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
4240
- status: partial

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,5 @@ mysql:
2828
log_record:
2929
body: >-
3030
Make sure your user credentials are correctly specified using the
31-
`--set splunk.discovery.receivers.mysql.config.username="<username>"` and
32-
`--set splunk.discovery.receivers.mysql.config.password="<password>"` command or the
3331
`SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_username="<username>"` and
3432
`SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_password="<password>"` environment variables.

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,5 @@
2424
log_record:
2525
body: >-
2626
Make sure your user credentials are correctly specified using the
27-
`--set {{ configProperty "username" "<username>" }}` and
28-
`--set {{ configProperty "password" "<password>" }}` command or the
2927
`{{ configPropertyEnvVar "username" "<username>" }}` and
3028
`{{ configPropertyEnvVar "password" "<password>" }}` environment variables.

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,11 @@ oracledb:
4141
log_record:
4242
body: >-
4343
Make sure your oracledb service is correctly specified using the
44-
`--set splunk.discovery.receivers.oracledb.config.service="<service>"` command or the
4544
`SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_service="<service>"` environment variable.
4645
- status: partial
4746
regexp: 'invalid username/password'
4847
log_record:
4948
body: >-
5049
Make sure your user credentials are correctly specified using the
51-
`--set splunk.discovery.receivers.oracledb.config.username="<username>"` and
52-
`--set splunk.discovery.receivers.oracledb.config.password="<password>"` command or the
5350
`SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_username="<username>"` and
5451
`SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_password="<password>"` environment variables.

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,11 @@
3737
log_record:
3838
body: >-
3939
Make sure your oracledb service is correctly specified using the
40-
`--set {{ configProperty "service" "<service>" }}` command or the
4140
`{{ configPropertyEnvVar "service" "<service>" }}` environment variable.
4241
- status: partial
4342
regexp: 'invalid username/password'
4443
log_record:
4544
body: >-
4645
Make sure your user credentials are correctly specified using the
47-
`--set {{ configProperty "username" "<username>" }}` and
48-
`--set {{ configProperty "password" "<password>" }}` command or the
4946
`{{ configPropertyEnvVar "username" "<username>" }}` and
5047
`{{ configPropertyEnvVar "password" "<password>" }}` environment variables.

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,19 @@ postgresql:
3232
log_record:
3333
body: >-
3434
Please ensure your user credentials are correctly specified with
35-
`--set splunk.discovery.receivers.postgresql.config.username="<username>"` and
36-
`--set splunk.discovery.receivers.postgresql.config.password="<password>"` or
3735
`SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_username="<username>"` and
3836
`SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_password="<password>"` environment variables.
3937
- status: partial
4038
regexp: 'pq: database .* does not exist'
4139
log_record:
4240
body: >-
4341
Make sure the target database is correctly specified using the
44-
`--set splunk.discovery.receivers.postgresql.config.databases="[<db>]"` command or the
4542
`SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_databases="[<db>]"` environment variable.
4643
- status: partial
4744
regexp: 'pq: SSL is not enabled on the server'
4845
log_record:
4946
body: >-
5047
Make sure the target database has SSL enabled or set insecure using the
51-
`--set splunk.discovery.receivers.postgresql.config.tls::insecure="<boolean>"` command or the
5248
`SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_tls_x3a__x3a_insecure="<boolean>"` environment variable.
5349
- status: partial
5450
regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,19 @@
2828
log_record:
2929
body: >-
3030
Please ensure your user credentials are correctly specified with
31-
`--set {{ configProperty "username" "<username>" }}` and
32-
`--set {{ configProperty "password" "<password>" }}` or
3331
`{{ configPropertyEnvVar "username" "<username>" }}` and
3432
`{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
3533
- status: partial
3634
regexp: 'pq: database .* does not exist'
3735
log_record:
3836
body: >-
3937
Make sure the target database is correctly specified using the
40-
`--set {{ configProperty "databases" "[<db>]" }}` command or the
4138
`{{ configPropertyEnvVar "databases" "[<db>]" }}` environment variable.
4239
- status: partial
4340
regexp: 'pq: SSL is not enabled on the server'
4441
log_record:
4542
body: >-
4643
Make sure the target database has SSL enabled or set insecure using the
47-
`--set {{ configProperty "tls::insecure" "<boolean>" }}` command or the
4844
`{{ configPropertyEnvVar "tls::insecure" "<boolean>" }}` environment variable.
4945
- status: partial
5046
regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,18 @@ redis:
3434
log_record:
3535
body: >-
3636
Make sure your user credentials are correctly specified using the
37-
`--set splunk.discovery.receivers.redis.config.password="<password>"` and
38-
`--set splunk.discovery.receivers.redis.config.username="<username>"` commands or the
3937
`SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` and
4038
`SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variables.
4139
- status: partial
4240
regexp: 'called without any password configured for the default user'
4341
log_record:
4442
body: >-
4543
Make sure your user credentials are correctly specified using the
46-
`--set splunk.discovery.receivers.redis.config.password="<password>"` command or the
4744
`SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variables.
4845
- status: partial
4946
regexp: 'WRONGPASS invalid username-password pair or user is disabled'
5047
log_record:
5148
body: >-
5249
Make sure your user credentials are correctly specified using the
53-
`--set splunk.discovery.receivers.redis.config.password="<password>"` and
54-
`--set splunk.discovery.receivers.redis.config.username="<username>"` commands or the
5550
`SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` and
5651
`SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variables.

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,23 +30,18 @@
3030
log_record:
3131
body: >-
3232
Make sure your user credentials are correctly specified using the
33-
`--set {{ configProperty "password" "<password>" }}` and
34-
`--set {{ configProperty "username" "<username>" }}` commands or the
3533
`{{ configPropertyEnvVar "password" "<password>" }}` and
3634
`{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
3735
- status: partial
3836
regexp: 'called without any password configured for the default user'
3937
log_record:
4038
body: >-
4139
Make sure your user credentials are correctly specified using the
42-
`--set {{ configProperty "password" "<password>" }}` command or the
4340
`{{ configPropertyEnvVar "password" "<password>" }}` environment variables.
4441
- status: partial
4542
regexp: 'WRONGPASS invalid username-password pair or user is disabled'
4643
log_record:
4744
body: >-
4845
Make sure your user credentials are correctly specified using the
49-
`--set {{ configProperty "password" "<password>" }}` and
50-
`--set {{ configProperty "username" "<username>" }}` commands or the
5146
`{{ configPropertyEnvVar "password" "<password>" }}` and
5247
`{{ configPropertyEnvVar "password" "<password>" }}` environment variables.

internal/confmapprovider/discovery/bundle/bundle.d/receivers/smartagent-collectd-mysql.discovery.yaml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,21 +32,17 @@ smartagent/collectd/mysql:
3232
log_record:
3333
body: >-
3434
Make sure your user credentials are correctly specified using the
35-
`--set splunk.discovery.receivers.smartagent/collectd/mysql.config.username="<username>"` and
36-
`--set splunk.discovery.receivers.smartagent/collectd/mysql.config.password="<password>"` command or the
3735
`SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_username="<username>"` and
3836
`SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_password="<password>"` environment variables.
3937
- status: partial
4038
regexp: 'mysql plugin: Failed to connect to database .* at server .* Unknown database'
4139
log_record:
4240
body: >-
4341
Make sure your MySQL databases are correctly specified using the
44-
`--set splunk.discovery.receivers.smartagent/collectd/mysql.config.databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` command or the
4542
`SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` environment variable.
4643
- status: partial
4744
regexp: 'mysql plugin: Failed to connect to database .* at server .* Access denied for user .* to database'
4845
log_record:
4946
body: >-
5047
Make sure your MySQL databases and auth information are correctly specified using the
51-
`--set splunk.discovery.receivers.smartagent/collectd/mysql.config.databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` command or the
5248
`SPLUNK_DISCOVERY_RECEIVERS_smartagent_x2f_collectd_x2f_mysql_CONFIG_databases="[{name: '<db-name-0>'}, {name: '<db-name-1>', username: '<username>', password: '<password>'}]"` environment variable.

0 commit comments

Comments
 (0)