[receiver/oracledb] Support query-level log collection - Query samples implementation

Author: sv-splunk

receiver/oracledbreceiver/config.go

@@ -33,6 +33,13 @@ type TopQueryCollection struct {
 	TopQueryCount       uint `mapstructure:"top_query_count"`
 }
 
+type QuerySample struct {
+	MaxRowsPerQuery uint64 `mapstructure:"max_rows_per_query"`
+
+	// prevent unkeyed literal initialization
+	_ struct{}
+}
+
 type Config struct {
 	DataSource                     string `mapstructure:"datasource"`
 	Endpoint                       string `mapstructure:"endpoint"`
@@ -44,6 +51,7 @@ type Config struct {
 	metadata.LogsBuilderConfig     `mapstructure:",squash"`
 
 	TopQueryCollection `mapstructure:"top_query_collection"`
+	QuerySample        `mapstructure:"query_sample_collection"`
 }
 
 func (c Config) Validate() error {

receiver/oracledbreceiver/documentation.md

@@ -389,6 +389,40 @@ events:
     enabled: true
 ```
 
+### db.server.query_sample
+
+sample query
+
+#### Attributes
+
+| Name | Description | Values |
+| ---- | ----------- | ------ |
+| db.query.text | The text of the database query being executed. | Any Str |
+| db.system.name | The database management system (DBMS) product as identified by the client instrumentation. | Any Str |
+| user.name | Database user name under which a session is connected to | Any Str |
+| db.namespace | The database name. | Any Str |
+| client.address | Hostname or address of the client. | Any Str |
+| client.port | TCP port used by the client. | Any Int |
+| network.peer.address | IP address of the peer client. | Any Str |
+| network.peer.port | TCP port used by the peer client. | Any Int |
+| oracledb.plan_hash_value | Binary hash value calculated on the query execution plan and used to identify similar query execution plans, reported in the HEX format. | Any Str |
+| oracledb.sql_id | The SQL ID of the query. | Any Str |
+| oracledb.child_number | The child number of the query. | Any Str |
+| oracledb.sid | ID of the Oracle Server session. | Any Str |
+| oracledb.serial | Serial number associated with a session. | Any Str |
+| oracledb.process | The operating system process ID (PID) associated with a session. | Any Str |
+| oracledb.schemaname | Oracle schema under which SQL statements are being executed | Any Str |
+| oracledb.program | Name of the client program or tool that initiated the Oracle database session. | Any Str |
+| oracledb.module | Logical module name of the client application that initiated a query or session. | Any Str |
+| oracledb.status | Execution state or result of a database query or session. | Any Str |
+| oracledb.state | Current state of the query or the session executing it. | Any Str |
+| oracledb.wait_class | The category of wait events a query or session is currently experiencing in Oracle Database. | Any Str |
+| oracledb.event | The specific wait event that a query or session is currently experiencing. | Any Str |
+| oracledb.object_name | Name of the database object that a query is accessing. | Any Str |
+| oracledb.object_type | Type of the database object that a query is accessing. | Any Str |
+| oracledb.osuser | Name of the operating system user that initiated or is running the Oracle database session. | Any Str |
+| oracledb.duration_sec | Total time taken by a database query to execute. | Any Double |
+
 ### db.server.top_query
 
 Collection of event metrics for top N queries, filtered based on the highest CPU time consumed (oracledb.elapsed_time).

receiver/oracledbreceiver/factory.go

@@ -44,6 +44,9 @@ func createDefaultConfig() component.Config {
 		ControllerConfig:     cfg,
 		MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(),
 		LogsBuilderConfig:    metadata.DefaultLogsBuilderConfig(),
+		QuerySample: QuerySample{
+			MaxRowsPerQuery: 100,
+		},
 		TopQueryCollection: TopQueryCollection{
 			MaxQuerySampleCount: 1000,
 			TopQueryCount:       200,
@@ -120,7 +123,7 @@ func createLogsReceiverFunc(sqlOpenerFunc sqlOpenerFunc, clientProviderFunc clie
 
 		mp, err := newLogsScraper(logsBuilder, sqlCfg.LogsBuilderConfig, sqlCfg.ControllerConfig, settings.Logger, func() (*sql.DB, error) {
 			return sqlOpenerFunc(getDataSource(*sqlCfg))
-		}, clientProviderFunc, instanceName, metricCache, sqlCfg.TopQueryCollection, hostName)
+		}, clientProviderFunc, instanceName, metricCache, sqlCfg.TopQueryCollection, sqlCfg.QuerySample, hostName)
 		if err != nil {
 			return nil, err
 		}

receiver/oracledbreceiver/internal/metadata/generated_config.go

@@ -84,6 +84,8 @@ all_set:
     oracledb.user_rollbacks:
       enabled: true
   events:
+    db.server.query_sample:
+      enabled: true
     db.server.top_query:
       enabled: true
   resource_attributes:
@@ -176,6 +178,8 @@ none_set:
     oracledb.user_rollbacks:
       enabled: false
   events:
+    db.server.query_sample:
+      enabled: false
     db.server.top_query:
       enabled: false
   resource_attributes: