Skip to content

Enhancement: Update fields.yml mysql.performance.events_statements.digest to object and subfield text to text - #20842

Merged
ishleenk17 merged 6 commits into
mainfrom
20612-mysql-integration-expose-performance-schema-digest_text-as-a-scalar-field-for-esql-compatibility
Aug 28, 2026
Merged

ishleenk17 merged 6 commits into
mainfrom
20612-mysql-integration-expose-performance-schema-digest_text-as-a-scalar-field-for-esql-compatibility

Conversation

@eddxavier-elastic

@eddxavier-elastic eddxavier-elastic commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Proposed commit message

Fix MySQL performance digest text mapping

The MySQL performance data stream already collects DIGEST_TEXT from
performance_schema.events_statements_summary_by_digest and stores it at:

mysql.performance.events_statements.digest.text

However, the parent mysql.performance.events_statements.digest field is
currently mapped as flattened.

This change maps digest as a group/object and explicitly maps
digest.text as text.

The underlying event structure is unchanged. The ingest pipeline already
reads digest.text, so no pipeline changes are required.

This allows the normalized SQL statement text to be accessed directly in
ES|QL instead of remaining inaccessible on stack versions where flattened
fields are not supported by ES|QL.

The proposed mapping has also been validated by applying the equivalent
mapping through the metrics-mysql.performance@custom component template,
recreating the data stream, and confirming that
mysql.performance.events_statements.digest.text can then be retrieved
successfully with ES|QL.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Author's Checklist

  • Confirmed that DIGEST_TEXT is already collected under mysql.performance.events_statements.digest.text.
  • Confirmed that the ingest pipeline does not depend on digest being mapped as flattened.
  • Validated the proposed mapping using a custom component template.
  • Confirmed that mysql.performance.events_statements.digest.text becomes directly accessible in ES|QL with the proposed mapping.

How to test this PR locally

  1. Build/install the MySQL integration containing this change.

  2. Enable the mysql.performance data stream and collect statement digest metrics.

  3. Confirm that documents contain:

    mysql.performance.events_statements.digest.text

  4. Verify the generated mapping for the field:

    "digest": {
      "properties": {
        "text": {
          "type": "text"
        }
      }
    }
  5. Run an ES|QL query such as:

FROM metrics-mysql.performance-*
| KEEP
@timestamp,
mysql.performance.events_statements.query_id,
mysql.performance.events_statements.digest.text
| LIMIT 10

Related issues

Map mysql.performance.events_statements.digest as a group with digest.text as text instead of flattened to allow easier ES|QL manipulation.
@github-actions

github-actions Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

✅ Elastic Docs Style Checker (Vale)

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

Add changelog entry for exposing mysql.performance.events_statements.digest.text as a text field.
@github-actions

This comment has been minimized.

@github-actions

Copy link
Copy Markdown
Contributor

TL;DR

Check integrations mysql failed during package lint because the package version/changelog state is inconsistent in this PR.

Remediation

  • Bump packages/mysql/manifest.yml version from 1.30.2 to 1.30.3 to match the new changelog entry introduced in this PR.
  • Re-run elastic-package check (or the Buildkite Check integrations mysql step) after the version bump.
Investigation details

Root Cause

The failing step is lint validation, not tests/runtime behavior. The log reports:

  • current manifest version doesn't have changelog entry

In this PR, packages/mysql/changelog.yml adds a new top entry for 1.30.3 while packages/mysql/manifest.yml remains at version: "1.30.2" (packages/mysql/manifest.yml:4).

Evidence

Relevant files:

  • packages/mysql/manifest.yml:4version: "1.30.2"
  • PR diff in packages/mysql/changelog.yml adds - version: "1.30.3" at the top.

Verification

  • Not run locally in this environment.

Follow-up

If you intended to keep 1.30.2, remove the new 1.30.3 entry; otherwise the expected fix is to bump manifest to 1.30.3.


What is this? | From workflow: PR Buildkite Detective

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Update manifest to 1.30.3
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

…chema-digest_text-as-a-scalar-field-for-esql-compatibility
…chema-digest_text-as-a-scalar-field-for-esql-compatibility
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

✅ All changelog entries have the correct PR link.

@infra-vault-gh-plugin-prod

Copy link
Copy Markdown

💚 Build Succeeded

History

@ishleenk17
ishleenk17 merged commit 22d0273 into main Aug 28, 2026
4 of 5 checks passed
@ishleenk17
ishleenk17 deleted the 20612-mysql-integration-expose-performance-schema-digest_text-as-a-scalar-field-for-esql-compatibility branch August 28, 2026 05:25
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown
Contributor

Package mysql - 1.30.3 containing this change is available at https://epr.elastic.co/package/mysql/1.30.3/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[MySQL Integration] Expose Performance Schema DIGEST_TEXT as a scalar field for ES|QL compatibility

2 participants