[receiver/discovery] Remove append_pattern option from log statements (#4838)

Remove `append_pattern` option from log evaluation statements.
  - The matched log message is now set as `discovery.matched_log` entity attributes instead of being appended to the `discovery.message` attribute.
  - The matched log fields like `caller` and `stacktrace` are not sent as attributes anymore since it's not relevant to the emitted entities anymore and don't provide any value to the end users

Author: dmitryax

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+### 🛑 Breaking changes 🛑
+
+- (Splunk) `receiver/discovery`: Remove `append_pattern` option from log evaluation statements ([#4583](https://github.com/signalfx/splunk-otel-collector/pull/4583))
+  - The matched log message is now set as `discovery.matched_log` entity attributes instead of being appended to 
+    the `discovery.message` attribute.
+  - The matched log fields like `caller` and `stacktrace` are not sent as attributes anymore.
+
 ### 💡 Enhancements 💡
 
 - (Splunk) [`splunk-otel-collector` Salt formula](https://github.com/signalfx/splunk-otel-collector/tree/main/deployments/salt): Initial support for

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

@@ -29,17 +29,14 @@
 #       - status: failed
 #         regexp: 'connect: network is unreachable'
 #         log_record:
-#           append_pattern: true
 #           body: The container cannot be reached by the Collector. Make sure they're in the same network.
 #       - status: failed
 #         regexp: 'connect: connection refused'
 #         log_record:
-#           append_pattern: true
 #           body: The container is refusing mongodb connections.
 #       - status: partial
 #         regexp: '.* unable to authenticate using mechanism .*'
 #         log_record:
-#           append_pattern: true
 #           body: >-
 #               Please ensure your user credentials are correctly specified with
 #               `--set splunk.discovery.receivers.mongodb.config.username="<username>"` and
@@ -49,7 +46,6 @@
 #       - status: partial
 #         regexp: '.* failed to fetch index stats metrics: (Unauthorized) not authorized on admin to execute command .*'
 #         log_record:
-#           append_pattern: true
 #           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' }])`

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

@@ -26,12 +26,10 @@
 #       - status: failed
 #         regexp: "Can't connect to MySQL server on .* [(]111[)]"
 #         log_record:
-#           append_pattern: true
 #           body:  The container cannot be reached by the Collector. The container is refusing MySQL connections.
 #       - status: partial
 #         regexp: 'Access denied for user'
 #         log_record:
-#           append_pattern: true
 #           body: >-
 #             Make sure your user credentials are correctly specified using the
 #             `--set splunk.discovery.receivers.mysql.config.username="<username>"` and

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

@@ -27,35 +27,29 @@
 #       - status: failed
 #         regexp: "connection refused"
 #         log_record:
-#           append_pattern: true
 #           body: The container is not serving http connections.
 #       - status: failed
 #         regexp: "received goaway and there are no active streams"
 #         log_record:
-#           append_pattern: true
 #           body: Unable to connect and scrape metrics.
 #       - status: failed
 #         regexp: "dial tcp: lookup"
 #         log_record:
-#           append_pattern: true
 #           body: Unable to resolve oracledb tcp endpoint
 #       - status: failed
 #         regexp: 'error executing select .*: EOF'
 #         log_record:
-#           append_pattern: true
 #           body: Unable to execute select from oracledb. Verify endpoint and user permissions.
 #       - status: partial
 #         regexp: "listener does not currently know of service requested"
 #         log_record:
-#           append_pattern: true
 #           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:
-#           append_pattern: true
 #           body: >-
 #             Make sure your user credentials are correctly specified using the
 #             `--set splunk.discovery.receivers.oracledb.config.username="<username>"` and

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

@@ -26,17 +26,14 @@
 #       - status: failed
 #         regexp: 'connect: network is unreachable'
 #         log_record:
-#           append_pattern: true
 #           body: The container cannot be reached by the Collector. Make sure they're in the same network.
 #       - status: failed
 #         regexp: 'connect: connection refused'
 #         log_record:
-#           append_pattern: true
 #           body: The container is refusing PostgreSQL connections.
 #       - status: partial
 #         regexp: 'pq: password authentication failed for user'
 #         log_record:
-#           append_pattern: true
 #           body: >-
 #             Please ensure your user credentials are correctly specified with
 #             `--set splunk.discovery.receivers.postgresql.config.username="<username>"` and
@@ -46,23 +43,20 @@
 #       - status: partial
 #         regexp: 'pq: database .* does not exist'
 #         log_record:
-#           append_pattern: true
 #           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:
-#           append_pattern: true
 #           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'
 #         log_record:
-#           append_pattern: true
 #           body: >-
 #             Make sure your PostgreSQL database has
 #             `shared_preload_libraries = 'pg_stat_statements'`

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

@@ -24,22 +24,18 @@
 #       - status: failed
 #         regexp: "connection refused"
 #         log_record:
-#           append_pattern: true
 #           body: The container is not serving http connections.
 #       - status: failed
 #         regexp: "received goaway and there are no active streams"
 #         log_record:
-#           append_pattern: true
 #           body: Unable to connect and scrape metrics.
 #       - status: failed
 #         regexp: "dial tcp: lookup"
 #         log_record:
-#           append_pattern: true
 #           body: Unable to resolve redis tcp endpoint
 #       - status: partial
 #         regexp: 'NOAUTH Authentication required.'
 #         log_record:
-#           append_pattern: true
 #           body: >-
 #             Make sure your user credentials are correctly specified using the
 #             `--set splunk.discovery.receivers.redis.config.password="<password>"` and
@@ -49,15 +45,13 @@
 #       - status: partial
 #         regexp: 'called without any password configured for the default user'
 #         log_record:
-#           append_pattern: true
 #           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:
-#           append_pattern: true
 #           body: >-
 #             Make sure your user credentials are correctly specified using the
 #             `--set splunk.discovery.receivers.redis.config.password="<password>"` and

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

@@ -30,12 +30,10 @@
 #       - status: failed
 #         regexp: "mysql plugin: Failed to connect to database .* at server .* Can't connect to MySQL server on .* [(]111[)]"
 #         log_record:
-#           append_pattern: true
 #           body: 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:
-#           append_pattern: true
 #           body: >-
 #             Make sure your user credentials are correctly specified using the
 #             `--set splunk.discovery.receivers.smartagent/collectd/mysql.config.username="<username>"` and
@@ -45,15 +43,13 @@
 #       - status: partial
 #         regexp: 'mysql plugin: Failed to connect to database .* at server .* Unknown database'
 #         log_record:
-#           append_pattern: true
 #           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:
-#           append_pattern: true
 #           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

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

@@ -28,10 +28,8 @@
 #       - status: failed
 #         regexp: "nginx plugin: curl_easy_perform failed: Operation timed out after"
 #         log_record:
-#           append_pattern: true
 #           body: The container is not serving http connections.
 #       - status: failed
 #         regexp: "read-function of plugin .* failed"
 #         log_record:
-#           append_pattern: true
 #           body: The integration is unable to read metrics from this endpoint.

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

@@ -39,17 +39,14 @@
 #       - status: failed
 #         regexp: 'connect: network is unreachable'
 #         log_record:
-#           append_pattern: true
 #           body: The container cannot be reached by the Collector. Make sure they're in the same network.
 #       - status: failed
 #         regexp: 'connect: connection refused'
 #         log_record:
-#           append_pattern: true
 #           body: The container is refusing PostgreSQL connections.
 #       - status: partial
 #         regexp: 'pq: password authentication failed for user'
 #         log_record:
-#           append_pattern: true
 #           body: >-
 #             Please ensure your user credentials are correctly specified with
 #             `--set splunk.discovery.receivers.smartagent/postgresql.config.params::username="<username>"` and
@@ -59,15 +56,13 @@
 #       - status: partial
 #         regexp: 'pq: database .* does not exist'
 #         log_record:
-#           append_pattern: true
 #           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'
 #         log_record:
-#           append_pattern: true
 #           body: >-
 #             Make sure your PostgreSQL database has
 #             `shared_preload_libraries = 'pg_stat_statements'`

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

@@ -25,17 +25,14 @@ mongodb:
       - status: failed
         regexp: 'connect: network is unreachable'
         log_record:
-          append_pattern: true
           body: The container cannot be reached by the Collector. Make sure they're in the same network.
       - status: failed
         regexp: 'connect: connection refused'
         log_record:
-          append_pattern: true
           body: The container is refusing mongodb connections.
       - status: partial
         regexp: '.* unable to authenticate using mechanism .*'
         log_record:
-          append_pattern: true
           body: >-
               Please ensure your user credentials are correctly specified with
               `--set splunk.discovery.receivers.mongodb.config.username="<username>"` and
@@ -45,7 +42,6 @@ mongodb:
       - status: partial
         regexp: '.* failed to fetch index stats metrics: (Unauthorized) not authorized on admin to execute command .*'
         log_record:
-          append_pattern: true
           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' }])`

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

@@ -21,17 +21,14 @@
       - status: failed
         regexp: 'connect: network is unreachable'
         log_record:
-          append_pattern: true
           body: The container cannot be reached by the Collector. Make sure they're in the same network.
       - status: failed
         regexp: 'connect: connection refused'
         log_record:
-          append_pattern: true
           body: The container is refusing mongodb connections.
       - status: partial
         regexp: '.* unable to authenticate using mechanism .*'
         log_record:
-          append_pattern: true
           body: >-
               Please ensure your user credentials are correctly specified with
               `--set {{ configProperty "username" "<username>" }}` and
@@ -41,7 +38,6 @@
       - status: partial
         regexp: '.* failed to fetch index stats metrics: (Unauthorized) not authorized on admin to execute command .*'
         log_record:
-          append_pattern: true
           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' }])`

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

@@ -22,12 +22,10 @@ mysql:
       - status: failed
         regexp: "Can't connect to MySQL server on .* [(]111[)]"
         log_record:
-          append_pattern: true
           body:  The container cannot be reached by the Collector. The container is refusing MySQL connections.
       - status: partial
         regexp: 'Access denied for user'
         log_record:
-          append_pattern: true
           body: >-
             Make sure your user credentials are correctly specified using the
             `--set splunk.discovery.receivers.mysql.config.username="<username>"` and

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

@@ -18,12 +18,10 @@
       - status: failed
         regexp: "Can't connect to MySQL server on .* [(]111[)]"
         log_record:
-          append_pattern: true
           body:  The container cannot be reached by the Collector. The container is refusing MySQL connections.
       - status: partial
         regexp: 'Access denied for user'
         log_record:
-          append_pattern: true
           body: >-
             Make sure your user credentials are correctly specified using the
             `--set {{ configProperty "username" "<username>" }}` and

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

@@ -23,35 +23,29 @@ oracledb:
       - status: failed
         regexp: "connection refused"
         log_record:
-          append_pattern: true
           body: The container is not serving http connections.
       - status: failed
         regexp: "received goaway and there are no active streams"
         log_record:
-          append_pattern: true
           body: Unable to connect and scrape metrics.
       - status: failed
         regexp: "dial tcp: lookup"
         log_record:
-          append_pattern: true
           body: Unable to resolve oracledb tcp endpoint
       - status: failed
         regexp: 'error executing select .*: EOF'
         log_record:
-          append_pattern: true
           body: Unable to execute select from oracledb. Verify endpoint and user permissions.
       - status: partial
         regexp: "listener does not currently know of service requested"
         log_record:
-          append_pattern: true
           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:
-          append_pattern: true
           body: >-
             Make sure your user credentials are correctly specified using the
             `--set splunk.discovery.receivers.oracledb.config.username="<username>"` and

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

@@ -19,35 +19,29 @@
       - status: failed
         regexp: "connection refused"
         log_record:
-          append_pattern: true
           body: The container is not serving http connections.
       - status: failed
         regexp: "received goaway and there are no active streams"
         log_record:
-          append_pattern: true
           body: Unable to connect and scrape metrics.
       - status: failed
         regexp: "dial tcp: lookup"
         log_record:
-          append_pattern: true
           body: Unable to resolve oracledb tcp endpoint
       - status: failed
         regexp: 'error executing select .*: EOF'
         log_record:
-          append_pattern: true
           body: Unable to execute select from oracledb. Verify endpoint and user permissions.
       - status: partial
         regexp: "listener does not currently know of service requested"
         log_record:
-          append_pattern: true
           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:
-          append_pattern: true
           body: >-
             Make sure your user credentials are correctly specified using the
             `--set {{ configProperty "username" "<username>" }}` and