feat: add query level monitoring support for RDS (#189)

feat: add query level monitoring support for RDS (#189)

Author: spathlavath

CHANGELOG.md

@@ -9,6 +9,11 @@ Unreleased section should follow [Release Toolkit](https://github.com/newrelic/r
 
 ## Unreleased
 
+### enhancements
+- Added Query Performance Monitoring support for RDS
+- Added QueryMonitoringOnly flag to enable only query monitoring feature
+- Made individual query filtering case-insensitive
+
 ## v1.15.0 - 2025-04-21
 
 ### 🚀 Enhancements

mysql-config.yml.sample

@@ -40,7 +40,7 @@ integrations:
     role: write-replica
   inventory_source: config/mysql
 
-# Example configuration for enabling performance monitoring
+# Example configuration for enabling query performance monitoring
 - name: nri-mysql
   env:
     HOSTNAME: localhost
@@ -69,6 +69,7 @@ integrations:
 
     # Enable query performance monitoring
     ENABLE_QUERY_MONITORING: true
+
     # Fetch interval in seconds for grouped slow queries. Should match the interval in mysql-config.yml
     # SLOW_QUERY_MONITORING_FETCH_INTERVAL: 30
     # Threshold in milliseconds for query response time to fetch individual query performance metrics
@@ -82,4 +83,48 @@ integrations:
   labels:
     env: production
     role: performance-monitoring
+  inventory_source: config/mysql-performance
+
+# Example configuration for enabling query performance monitoring only
+- name: nri-mysql
+  env:
+    HOSTNAME: localhost
+    PORT: 3306
+    # ENABLE_TLS: false
+    # INSECURE_SKIP_VERIFY: false
+    # Specify extra connection parameters as attr1=val1&attr2=val2.
+    # EXTRA_CONNECTION_URL_ARGS: ""
+
+    # If not empty `socket` parameter will discard `port` parameter
+    # SOCKET: <PATH_TO_LOCAL_SOCKET_FILE_NAME>
+
+    USERNAME: newrelic
+    PASSWORD: <YOUR_SELECTED_PASSWORD>
+    # Allow old password https://dev.mysql.com/doc/refman/5.6/en/server-system-variables.html#sysvar_old_passwords
+    # OLD_PASSWORDS: false
+
+    # New users should leave this property as `true`, to identify the
+    # monitored entities as `remote`. Setting this property to `false` (the
+    # default value) is deprecated and will be removed soon, disallowing
+    # entities that are identified as `local`.
+    # Please check the documentation to get more information about local
+    # versus remote entities:
+    # https://github.com/newrelic/infra-integrations-sdk/blob/master/docs/entity-definition.md
+    REMOTE_MONITORING: true
+
+    # Enable collection of only detailed query performance metrics, excluding other metrics. - Defaults to false
+    QUERY_MONITORING_ONLY : true
+    # Fetch interval in seconds for grouped slow queries. Should match the interval in mysql-config.yml
+    # SLOW_QUERY_MONITORING_FETCH_INTERVAL: 30
+    # Threshold in milliseconds for query response time to fetch individual query performance metrics
+    # QUERY_MONITORING_RESPONSE_TIME_THRESHOLD: 500
+    # Query count limit for fetching grouped slow and individual query performance metrics
+    # QUERY_MONITORING_COUNT_THRESHOLD: 20
+    # Provide any necessary database exclusions as a JSON array
+    # EXCLUDED_PERFORMANCE_DATABASES: '["employees","azure_sys"]' 
+    # Note: System databases (mysql, information_schema, performance_schema, sys) are always excluded.
+  interval: 30s 
+  labels:
+    env: production
+    role: performance-monitoring-only
   inventory_source: config/mysql-performance

src/args/argument_list.go

@@ -20,6 +20,7 @@ type ArgumentList struct {
 	OldPasswords                         bool   `default:"false" help:"Allow the use of old passwords: https://dev.mysql.com/doc/refman/5.6/en/server-system-variables.html#sysvar_old_passwords"`
 	ShowVersion                          bool   `default:"false" help:"Display build information and exit."`
 	EnableQueryMonitoring                bool   `default:"false" help:"Enable collection of detailed query performance metrics."`
+	QueryMonitoringOnly                  bool   `default:"false" help:"Enable collection of only detailed query performance metrics, excluding other metrics."`
 	SlowQueryMonitoringFetchInterval     int    `default:"30" help:"Fetch interval in seconds for grouped slow queries. Should match the interval in mysql-config.yml."`
 	QueryMonitoringResponseTimeThreshold int    `default:"500" help:"Threshold in milliseconds for query response time to fetch individual query performance metrics."`
 	QueryMonitoringCountThreshold        int    `default:"20" help:"Query count limit for fetching grouped slow and individual query performance metrics."`

src/mysql.go

@@ -49,6 +49,15 @@ func main() {
 	e, err := infrautils.CreateNodeEntity(i, args.RemoteMonitoring, args.Hostname, args.Port)
 	infrautils.FatalIfErr(err)
 
+	/*
+		If the QueryMonitoringOnly flag is set, only populate query performance metrics
+		and return from main function without proceeding further.
+	*/
+	if args.QueryMonitoringOnly {
+		queryperformancemonitoring.PopulateQueryPerformanceMetrics(args, e, i)
+		return
+	}
+
 	db, err := openSQLDB(dbutils.GenerateDSN(args, ""))
 	infrautils.FatalIfErr(err)
 	defer db.close()

src/query-performance-monitoring/constants/constants.go

@@ -22,12 +22,6 @@ const (
 	*/
 	ExplainQueryFormat = "EXPLAIN FORMAT=JSON %s"
 
-	/*
-		SupportedStatements defines the SQL statements for which this integration fetches query execution plans.
-		Restricting the supported statements improves compatibility and reduces the complexity of plan analysis.
-	*/
-	SupportedStatements = "SELECT WITH"
-
 	/*
 		QueryPlanTimeoutDuration sets the timeout for fetching query execution plans.
 		This prevents indefinite waits when a query plan retrieval takes too long, ensuring system responsiveness.
@@ -81,6 +75,17 @@ const (
 		This ensures version strings are formatted correctly and allows for proper version comparison.
 	*/
 	MinVersionParts = 2
+
+	/*
+		EssentialConsumersCount defines the number of essential consumers that must be enabled
+		in the performance schema to ensure that the necessary performance data is available.
+
+		The EssentialConsumersCount is set to 5 because two of the consumers (events_statements_cpu and events_waits_history_long)
+		are optional and may not be available in Aurora RDS environments. Therefore, we consider only the remaining five consumers
+		(events_waits_current, events_waits_history, events_statements_current, events_statements_history, and events_statements_history_long) as essential and
+		consistently available across all supported MySQL environments.
+	*/
+	EssentialConsumersCount = 5
 )
 
 /*

src/query-performance-monitoring/performance-metrics-collectors/query_execution_plan.go

@@ -341,8 +341,14 @@ func SetExecutionPlanMetrics(i *integration.Integration, args arguments.Argument
 
 // isSupportedStatement checks if the given query is a supported statement.
 func isSupportedStatement(query string) bool {
-	for _, stmt := range strings.Split(constants.SupportedStatements, " ") {
-		if strings.HasPrefix(query, stmt) {
+	upperCaseQuery := strings.ToUpper(strings.TrimSpace(query))
+	/*
+		SupportedStatements defines the SQL statements for which this integration fetches query execution plans.
+		Restricting the supported statements improves compatibility and reduces the complexity of plan analysis.
+	*/
+	supportedStatements := []string{"SELECT", "WITH"}
+	for _, stmt := range supportedStatements {
+		if strings.HasPrefix(upperCaseQuery, stmt) {
 			return true
 		}
 	}

src/query-performance-monitoring/performance-metrics-collectors/query_execution_plan_test.go

@@ -354,6 +354,11 @@ func TestIsSupportedStatement(t *testing.T) {
 	t.Run("Supported Statement", func(t *testing.T) {
 		assert.True(t, isSupportedStatement("SELECT * FROM test"))
 		assert.True(t, isSupportedStatement("WITH cte AS (SELECT * FROM test) SELECT * FROM cte"))
+		assert.True(t, isSupportedStatement("select * from users"))
+		assert.True(t, isSupportedStatement("  SELECT * FROM users"))
+		assert.True(t, isSupportedStatement("with cte as (select * from users) select * from cte"))
+		assert.True(t, isSupportedStatement("Select * from test"))
+		assert.True(t, isSupportedStatement("With cte as (Select * from test) Select * from cte"))
 	})
 
 	t.Run("Unsupported Statement", func(t *testing.T) {
@@ -362,6 +367,9 @@ func TestIsSupportedStatement(t *testing.T) {
 		assert.False(t, isSupportedStatement("INSERT INTO test VALUES (1)"))
 		assert.False(t, isSupportedStatement("UPDATE test SET value = 1"))
 		assert.False(t, isSupportedStatement("DELETE FROM test"))
+		assert.False(t, isSupportedStatement("CREATE TABLE users (id INT, name VARCHAR(255))"))
+		assert.False(t, isSupportedStatement(""))
+		assert.False(t, isSupportedStatement("   "))
 	})
 }
 

src/query-performance-monitoring/utils/helpers.go

@@ -16,14 +16,12 @@ import (
 
 // Dynamic error
 var (
-	ErrEssentialConsumerNotEnabled   = errors.New("essential consumer is not enabled")
-	ErrEssentialInstrumentNotEnabled = errors.New("essential instrument is not fully enabled")
-	ErrMySQLVersion                  = errors.New("failed to determine MySQL version")
-	ErrModelIsNotValid               = errors.New("model is not a valid struct")
-	ErrNoRowsReturned                = errors.New("no rows returned from EXPLAIN")
-	ErrQueryTextNil                  = errors.New("query text is nil")
-	ErrQueryTextEmpty                = errors.New("query text is empty")
-	ErrQueryIDNil                    = errors.New("query ID is nil")
+	ErrMySQLVersion    = errors.New("failed to determine MySQL version")
+	ErrModelIsNotValid = errors.New("model is not a valid struct")
+	ErrNoRowsReturned  = errors.New("no rows returned from EXPLAIN")
+	ErrQueryTextNil    = errors.New("query text is nil")
+	ErrQueryTextEmpty  = errors.New("query text is empty")
+	ErrQueryIDNil      = errors.New("query ID is nil")
 )
 
 func CreateMetricSet(e *integration.Entity, sampleName string, args arguments.ArgumentList) *metric.Set {