x-pack/metricbeat/module/sql: Add debug queries when merge_results: true

[shmsr]

Proposed commit message

Add debug queries when merge_results: true. No new configuration added to match the behaviour when merge_results: false. Previously, as it was multiple queries that results in merge of results, the query parameter was left entry and hence the field was omitted out when merge_results: true. Now, we will publish it from here. Users that want this can keep it and others who do not want it can drop it.

Checklist

• My code follows the style guidelines of this project
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have made corresponding change to the default configuration files
• I have added tests that prove my fix is effective or that my feature works
• I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

How to test this PR locally

• Test if queries are there when merge_results is set to true.

Related issues

• SQL server integration provide the sql.query for debug integrations#12029
• [O11y][MSSQL] Add mssql.query field to transaction_logs data stream for debug purposes integrations#12216
• [O11y][MSSQL] Add optional mssql.query field to performance data stream for debugging purposes integrations#12212

Screenshots

• When merge_results: false:

---

• When merge_results: true:

[mergify]

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @shmsr? 🙏.
For such, you'll need to label your PR with:

• The upcoming major version of the Elastic Stack
• The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

• backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit

[mergify]

backport-8.x has been added to help with the transition to the new branch 8.x.
If you don't need it please use backport-skip label and remove the backport-8.x label.

[agithomas]

If the actual query is what is considered here, don't you think that this would increase the size of the document significantly? Some of the queries can be long.

[shmsr]

If the actual query is what is considered here, don't you think that this would increase the size of the document significantly? Some of the queries can be long.

Yes. If you see the related issue's description, Lalit noted the same that the query field was left out because it could take up space in cases of multiple long queries.

We're adding this feature now since the current behavior doesn't match when merge_results: false. Now, we'll let users decide whether they want to preserve queries or not through a configuration option in the integration. This puts the control in users' hands - they can choose to keep or drop the field based on their needs. We handle this in ingest pipelines.

A sample PR: elastic/integrations#12216 demonstrates this approach in integrations. While the query field preservation is optional, users who need it for debugging or analysis purposes can easily enable it.

[agithomas]

LGTM!