Skip to content

Add MySQL workload detection#2177

Open
Klarsen04 wants to merge 9 commits into
feature/dbi-mysqlfrom
larkirs/mysql-workload-detection
Open

Add MySQL workload detection#2177
Klarsen04 wants to merge 9 commits into
feature/dbi-mysqlfrom
larkirs/mysql-workload-detection

Conversation

@Klarsen04

Copy link
Copy Markdown

Description of the issue

Adds workload detection support for MySQL database servers as part of the workload-discovery feature.

Description of changes

Implements a MySQL process detector that:

  • Identifies MySQL server instances by checking for the mysqld executable
  • Extracts the listening port from process arguments (--port/-P flag) or the MYSQL_TCP_PORT environment variable, defaulting to 3306 if neither is set. This is consistent with the upstream OTel MySQL receiver default
  • Always returns READY status with the resolved port

New files:

  • mysql.go - Main detector implementation
  • port.go - Port extraction logic
    Unit tests for both components

License

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Tests

Added unit tests for MySQL detector (mysql_test.go)
Added unit tests for port extractor (port_test.go)
make fmt and make lint pass

Test on AL2:


$ sudo /tmp/workload-discovery -debug
time=2026-06-25T13:48:04.298Z level=DEBUG source=internal/detector/nvidia/nvidia.go:36 msg="Starting NVIDIA GPU detection"
time=2026-06-25T13:48:04.299Z level=DEBUG source=internal/detector/nvidia/nvidia.go:39 msg="No NVIDIA GPU devices found"
time=2026-06-25T13:48:04.347Z level=DEBUG source=cmd/workload-discovery/discovery.go:105 msg="Starting discovery" num_process=271 num_worker=8
time=2026-06-25T13:48:04.348Z level=DEBUG source=internal/detector/mysql/mysql.go:46 msg="MySQL process detected" pid=19573
time=2026-06-25T13:48:04.348Z level=DEBUG source=cmd/workload-discovery/discovery.go:201 msg="Detected supported workload(s) for process" pid=19573 categories=[MYSQL]
time=2026-06-25T13:48:04.348Z level=DEBUG source=cmd/workload-discovery/discovery.go:93 msg="Discovered metadata" elapsed=49.58251ms
[
  {
    "categories": [
      "MYSQL"
    ],
    "name": "mysql",
    "telemetry_port": 3306,
    "status": "READY"
  }
]

Requirements

Run make fmt and make fmt-sh
Run make lint

Create the core MySQL receiver translator with functional options pattern:
- translator.go with endpoint, username, passfile, TLS, localhost detection
- translator_test.go with unit tests for all option functions
- Register mysqlreceiver.NewFactory() in defaultcomponents
- Add MySQLKey and MySQL DBI component name constants to common.go
- Add go.mod dependency on mysqlreceiver
Add YAML configs and translator wiring for MySQL DBI pipelines:
- dbi_dbload_mysql.yaml: count connector for active sessions by wait/user/db/sql/host
- dbi_topsql_mysql.yaml: signaltometrics connector for top query metrics
- transform_dbi_fix_start_time_mysql.yaml: transform processor for MySQL timestamps
- Update count, signaltometrics, and transform translators to handle MySQL component names
- Add unit tests for MySQL connector/processor creation
Add mysql[] array schema to database_insights in schema.json:
- endpoint, instance_name, username, password_file
- tls.ca_file for TLS configuration
- logs.file_path for server log ingestion
@Klarsen04 Klarsen04 requested a review from a team as a code owner June 25, 2026 14:01
@Klarsen04 Klarsen04 added the ready for testing Indicates this PR is ready for integration tests to run label Jun 25, 2026
Extend the DBI pipeline orchestrator to support MySQL instances:
- Add translator_mysql.go with dbiMysqlTranslator implementing 4 pipeline types:
  - metrics/dbi_mysql_N: counter metrics + DBLoad/TopSQL from connectors
  - logs/dbi_mysql_N: log-to-metrics via count + signaltometrics connectors
  - logs/dbi_mysql_rawevents_N: raw query sample/top query events
  - logs/dbi_mysql_serverlogs_N: MySQL server log file ingestion
- Add parseDbiMysqlInstances() to parse mysql[] config array
- MySQL-specific resource attributes (db.system.name = "mysql")
- MySQL-specific log group paths and monitor user exclusion filter
- Unit tests for pipeline wiring with single/multiple instances
Add end-to-end config translation test for MySQL DBI:
- dbi_mysql_config_linux.conf: input agent config fixture
- dbi_mysql_config_linux.json: parsed JSON intermediate fixture
- dbi_mysql_config_linux.yaml: golden YAML output (full OTel pipeline)
- .mysql_credentials: test passfile for credential loading
- Register TestMySQLDbiConfig in tocwconfig_unix_test.go
@Klarsen04 Klarsen04 force-pushed the larkirs/mysql-workload-detection branch 2 times, most recently from 615b5d5 to 7352bdb Compare June 30, 2026 14:11
- Unify the DBI pipeline translator: merge translator_mysql.go into a single
  dbiTranslator that branches by engine (carried on the instance config),
  instead of maintaining a separate MySQL translator.
- Make component naming consistent across engines using an engine suffix:
  count/dbi_dbload_<engine>, signaltometrics/dbi_topsql_<engine>,
  transform/dbi_fix_start_time_<engine>, and per-instance
  dbi_resource_<engine>_N, dbi_scope_<engine>_N, dbi_logs_<engine>_<dest>_N,
  dbi_exclude_monitor_<engine>_N. PostgreSQL components now carry the
  _postgresql suffix for consistency.
- Rename engine-specific connector/processor YAMLs for symmetry
  (dbi_dbload_postgresql.yaml, dbi_topsql_postgresql.yaml,
  transform_dbi_fix_start_time_postgresql.yaml); the connector and transform
  translators select the config by engine.
- Add the dbi_scope transform processor (cloudwatch.source/solution) to all
  MySQL pipelines, matching the PostgreSQL implementation.
- Use the shared named resourcedetection/opentelemetry processor.
- Add the validateOttlSafe check to the unified Translate() so username and
  instance_name are validated for both engines.
- Fix the host metrics process scraper to match the mysqld process (mysqld.*)
  when MySQL DBI is configured.
- Remove TLS/ca_file from the MySQL schema and receiver; MySQL DBI is
  localhost-only and always connects with TLS disabled.
- Fix the MySQL passfile test fixture to the pgpass-style format
  (host:port:database:username:password) and assert all seven DB Load metrics.
- Regenerate golden YAMLs (mysql, postgres, combined configs).
@Klarsen04 Klarsen04 force-pushed the larkirs/mysql-workload-detection branch from 7352bdb to 3a7fea5 Compare June 30, 2026 17:16
…upport

The CloudWatch Console (Cinch) creates separate SSM parameters for each
workload configuration (e.g. one for database-insights-postgres and one
for database-insights-mysql). When the agent loads multiple config files
from the .d/ directory, the config merger needs to deep-merge the
database_insights section so that both postgresql and mysql arrays
coexist.

Without this rule, the agent treats database_insights from two separate
config sources as conflicting values and drops one, causing missing
log groups in CloudWatch.

Register database_insights as a SectionMergeRule under the collect rule,
matching the existing pattern for opentelemetry and collect.
@Klarsen04 Klarsen04 force-pushed the larkirs/mysql-workload-detection branch from 3a7fea5 to 97bfc15 Compare June 30, 2026 17:24
- Move the complete 14-metric Top SQL connector config (dbi_topsql_mysql.yaml)
  into this PR. The full metric set was previously committed in the MySQL
  workload-detection PR by mistake, which left this PR's embedded config with
  only 2 metrics while the golden YAML had 14 (mismatch that failed the
  translation unit tests). All 14 metrics match what the mysqlreceiver
  publishes on db.server.top_query events.
- Remove the user.name attribute from all Top SQL metrics: top queries come
  from events_statements_summary_by_digest, aggregated by digest and schema,
  so the receiver does not publish user.name on top_query events (validated
  against the forked mysqlreceiver RecordDbServerTopQueryEvent).
- Remove the duplicate dbiMysqlKey variable in favor of the shared
  common.DatabaseInsightsMysqlKey.
- Regenerate the MySQL golden YAML.
@Klarsen04 Klarsen04 force-pushed the larkirs/mysql-workload-detection branch from 97bfc15 to 6814222 Compare July 1, 2026 18:59
Implement detection of mysqld processes for the workload discovery framework:
- Add mysql.NewDetector that matches mysqld process by executable name
- Add port extraction from --port/-P flags, MYSQL_TCP_PORT env var, or default 3306
- Add CategoryMySQL constant to metadata categories
- Register MySQL detector in workload-discovery main
- Unit tests for detection logic and port extraction (all flag/env variants)
@Klarsen04 Klarsen04 force-pushed the larkirs/mysql-workload-detection branch from 6814222 to c266a98 Compare July 1, 2026 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready for testing Indicates this PR is ready for integration tests to run

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant