[receiver/discovery] Replace log_record field to message (#4916)

`log_record` field isn't relevant anymore since we don't send discovery events as log records. The provided value is set to `discovery.message` entity attribute and sent to the backend on a regular basis. The additional `log_record.attributes` field is not being used. If needed in future, it can be added as another field in the statement section itself.

Author: dmitryax

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### 🛑 Breaking changes 🛑
+
+- (Splunk) `receiver/discovery`: Replace `log_record` field with `message` in evaluation statements ([#4583](https://github.com/signalfx/splunk-otel-collector/pull/4583))
+
 ### 🚩 Deprecations 🚩
 
 - (Splunk) The following docker images/manifests are deprecated and may not be published in a future release:

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

@@ -23,14 +23,11 @@
 #     metrics:
 #       - status: successful
 #         strict: kafka.brokers
-#         log_record:
-#           body: kafkametrics receiver is working!
+#         message: kafkametrics receiver is working!
 #     statements:
 #       - status: failed
 #         regexp: 'connect: network is unreachable'
-#         log_record:
-#           body: The container cannot be reached by the Collector. Make sure they're in the same network.
+#         message: The container cannot be reached by the Collector. Make sure they're in the same network.
 #       - status: failed
 #         regexp: 'connect: connection refused'
-#         log_record:
-#           body: The container is refusing kafka server connections.
+#         message: The container is refusing kafka server connections.

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

@@ -27,27 +27,22 @@
 #     metrics:
 #       - status: successful
 #         strict: mongodb.database.count
-#         log_record:
-#           body: mongodb receiver is working!
+#         message: mongodb receiver is working!
 #     statements:
 #       - status: failed
 #         regexp: 'connect: network is unreachable'
-#         log_record:
-#           body: The container cannot be reached by the Collector. Make sure they're in the same network.
+#         message: The container cannot be reached by the Collector. Make sure they're in the same network.
 #       - status: failed
 #         regexp: 'connect: connection refused'
-#         log_record:
-#           body: The container is refusing mongodb connections.
+#         message: The container is refusing mongodb connections.
 #       - status: partial
 #         regexp: '.* unable to authenticate using mechanism .*'
-#         log_record:
-#           body: >-
-#               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: >-
+#           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.
 #       - status: partial
 #         regexp: '.* failed to fetch index stats metrics: (Unauthorized) not authorized on admin to execute command .*'
-#         log_record:
-#           body: >-
-#             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' }])`
+#         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' }])`

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

@@ -20,17 +20,14 @@
 #     metrics:
 #       - status: successful
 #         strict: mysql.locks
-#         log_record:
-#           body: Mysql receiver is working!
+#         message: Mysql receiver is working!
 #     statements:
 #       - status: failed
 #         regexp: "Can't connect to MySQL server on .* [(]111[)]"
-#         log_record:
-#           body:  The container cannot be reached by the Collector. The container is refusing MySQL connections.
+#         message:  The container cannot be reached by the Collector. The container is refusing MySQL connections.
 #       - status: partial
 #         regexp: 'Access denied for user'
-#         log_record:
-#           body: >-
-#             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 using the
+#           `SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_username="<username>"` and
+#           `SPLUNK_DISCOVERY_RECEIVERS_mysql_CONFIG_password="<password>"` environment variables.

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

@@ -21,35 +21,28 @@
 #     metrics:
 #       - status: successful
 #         strict: oracledb.cpu_time
-#         log_record:
-#           body: oracledb receiver is working!
+#         message: oracledb receiver is working!
 #     statements:
 #       - status: failed
 #         regexp: "connection refused"
-#         log_record:
-#           body: The container is not serving http connections.
+#         message: The container is not serving http connections.
 #       - status: failed
 #         regexp: "received goaway and there are no active streams"
-#         log_record:
-#           body: Unable to connect and scrape metrics.
+#         message: Unable to connect and scrape metrics.
 #       - status: failed
 #         regexp: "dial tcp: lookup"
-#         log_record:
-#           body: Unable to resolve oracledb tcp endpoint
+#         message: Unable to resolve oracledb tcp endpoint
 #       - status: failed
 #         regexp: 'error executing select .*: EOF'
-#         log_record:
-#           body: Unable to execute select from oracledb. Verify endpoint and user permissions.
+#         message: Unable to execute select from oracledb. Verify endpoint and user permissions.
 #       - status: partial
 #         regexp: "listener does not currently know of service requested"
-#         log_record:
-#           body: >-
-#             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 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
-#             `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 using the
+#           `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_username="<username>"` and
+#           `SPLUNK_DISCOVERY_RECEIVERS_oracledb_CONFIG_password="<password>"` environment variables.

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

@@ -20,44 +20,37 @@
 #     metrics:
 #       - status: successful
 #         strict: postgresql.commits
-#         log_record:
-#           body: PostgreSQL receiver is working!
+#         message: PostgreSQL receiver is working!
 #     statements:
 #       - status: failed
 #         regexp: 'connect: network is unreachable'
-#         log_record:
-#           body: The container cannot be reached by the Collector. Make sure they're in the same network.
+#         message: The container cannot be reached by the Collector. Make sure they're in the same network.
 #       - status: failed
 #         regexp: 'connect: connection refused'
-#         log_record:
-#           body: The container is refusing PostgreSQL connections.
+#         message: The container is refusing PostgreSQL connections.
 #       - status: partial
 #         regexp: 'pq: password authentication failed for user'
-#         log_record:
-#           body: >-
-#             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: >-
+#           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.
 #       - status: partial
 #         regexp: 'pq: database .* does not exist'
-#         log_record:
-#           body: >-
-#             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 using 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
-#             `SPLUNK_DISCOVERY_RECEIVERS_postgresql_CONFIG_tls_x3a__x3a_insecure="<boolean>"` environment variable.
+#         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.
 #       - status: partial
 #         regexp: 'pq: pg_stat_statements must be loaded via shared_preload_libraries'
-#         log_record:
-#           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.
-#             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

@@ -18,36 +18,29 @@
 #     metrics:
 #       - status: successful
 #         strict: redis.uptime
-#         log_record:
-#           body: redis receiver is working!
+#         message: redis receiver is working!
 #     statements:
 #       - status: failed
 #         regexp: "connection refused"
-#         log_record:
-#           body: The container is not serving http connections.
+#         message: The container is not serving http connections.
 #       - status: failed
 #         regexp: "received goaway and there are no active streams"
-#         log_record:
-#           body: Unable to connect and scrape metrics.
+#         message: Unable to connect and scrape metrics.
 #       - status: failed
 #         regexp: "dial tcp: lookup"
-#         log_record:
-#           body: Unable to resolve redis tcp endpoint
+#         message: Unable to resolve redis tcp endpoint
 #       - status: partial
 #         regexp: 'NOAUTH Authentication required.'
-#         log_record:
-#           body: >-
-#             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 using the
+#           `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variable.
 #       - 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
-#             `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variable.
+#         message: >-
+#           Make sure your user credentials are correctly specified using the
+#           `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variable.
 #       - 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
-#             `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variable.
+#         message: >-
+#           Make sure your user credentials are correctly specified using the
+#           `SPLUNK_DISCOVERY_RECEIVERS_redis_CONFIG_password="<password>"` environment variable.

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

@@ -24,29 +24,24 @@
 #     metrics:
 #       - status: successful
 #         strict: mysql_octets.rx
-#         log_record:
-#           body: smartagent/collectd/mysql receiver is working!
+#         message: smartagent/collectd/mysql receiver is working!
 #     statements:
 #       - status: failed
 #         regexp: "mysql plugin: Failed to connect to database .* at server .* Can't connect to MySQL server on .* [(]111[)]"
-#         log_record:
-#           body: The container is refusing MySQL connections.
+#         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: .*[)]'
-#         log_record:
-#           body: >-
-#             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 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.
 #       - 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
-#             `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 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
-#             `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 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.

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

@@ -22,14 +22,11 @@
 #     metrics:
 #       - status: successful
 #         strict: connections.accepted
-#         log_record:
-#           body: smartagent/collectd/nginx receiver is working!
+#         message: smartagent/collectd/nginx receiver is working!
 #     statements:
 #       - status: failed
 #         regexp: "nginx plugin: curl_easy_perform failed: Operation timed out after"
-#         log_record:
-#           body: The container is not serving http connections.
+#         message: The container is not serving http connections.
 #       - status: failed
 #         regexp: "read-function of plugin .* failed"
-#         log_record:
-#           body: The integration is unable to read metrics from this endpoint.
+#         message: The integration is unable to read metrics from this endpoint.