[8.x] [kbn-scout] Add Synthtrace as a fixture (#210505)

[kibanamachine]

Backport

This will backport the following commits from main to 8.x:

• [kbn-scout] Add Synthtrace as a fixture (#210505)

Questions ?

Please refer to the Backport tool documentation

\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n\n\nCo-authored-by: Sergi Romeu "}},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com//pull/210505","number":210505,"mergeCommit":{"message":"[kbn-scout] Add Synthtrace as a fixture (#210505)\n\n## Summary\n\nCloses #210340\n\nThis PR adds synthtrace clients to scout as a test fixture, so you can\nuse it in your test to generate data.\n\nThe clients added were `apmSynthtraceEsClient`,\n`infraSynthtraceEsClient` and `otelSynthtraceEsClient`.\n\n## How to use them in parallel tests\n\nAs `synthtrace` ingests data into our indices, and sequential runs would\nbe the perfect way to introduce flakiness in our tests, there is a\nbetter way to ingest data, using a hook, at the setup phase with\n`globalSetup`.\nWe need to create a `global_setup.ts` file and link it into our\nplaywright config.\nThen we can use something like\n```\nasync function globalSetup(config: FullConfig) {\n const data = {\n apm: [\n opbeans({\n from: new Date(start).getTime(),\n to: new Date(end).getTime(),\n }),\n ],\n infra: [\n generateHosts({\n from: new Date(start).toISOString(),\n to: new Date(end).toISOString(),\n }),\n ],\n otel: [\n sendotlp({\n from: new Date(start).getTime(),\n to: new Date(end).getTime(),\n }),\n ],\n };\n\n return ingestSynthtraceDataHook(config, data);\n}\n```\nEach key (apm, infra, otel) accepts an array of generators.\n\n## How to use them in sequential tests\n> [!WARNING] \n> This should not be the standard behaviour, we should embrace\nparallelism and use sequential testing when there is no other way.\n\n### apmSynthtraceEsClient\n```ts\n test.before(\n async ({ apmSynthtraceEsClient }) => {\n await apmSynthtraceEsClient.index(\n opbeans({\n from: new Date(start).getTime(),\n to: new Date(end).getTime(),\n })\n );\n }\n );\n```\n[opbeans\nfile](https://github.com/elastic/kibana/blob/main/x-pack/solutions/observability/plugins/apm/ftr_e2e/cypress/fixtures/synthtrace/opbeans.ts)\nused in the example.\n\n### otelSynthtraceEsClient\n```ts\n test.before(\n async ({otelSynthtraceEsClient }) => {\n await otelSynthtraceEsClient.index(\n sendotlp({\n from: new Date(start).getTime(),\n to: new Date(end).getTime(),\n })\n );\n }\n );\n```\n[sendotlp\nfile](https://github.com/elastic/kibana/blob/main/x-pack/solutions/observability/plugins/apm/ftr_e2e/cypress/fixtures/synthtrace/sendotlp.ts)\nwhich will create the data.\n\n### infraSynthtraceEsClient\n```ts\n test.before(\n async ({ infraSynthtraceEsClient }) => {\n await infraSynthtraceEsClient.index(\n generateHosts({\n from: new Date(start).toISOString(),\n to: new Date(end).toISOString(),\n })\n );\n }\n );\n```\n[generateHosts\nfile](https://github.com/elastic/kibana/blob/main/x-pack/solutions/observability/plugins/inventory/e2e/cypress/e2e/alert_count/generate_data.ts#L82)\nused to generate data.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"e21c5d0e9175ffd1bea0ad78ffe26cb973cc489f"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->

[rmyz]

this depends on #211541 getting merged

[elasticmachine]

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

[github-actions]

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

• /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
• run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: f718a24

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
@kbn/apm-synthtrace	94	97	+3
@kbn/scout	93	99	+6
total			+9

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
@kbn/scout	14	15	+1

Unknown metric groups

API count

id	before	after	diff
@kbn/apm-synthtrace	94	97	+3
@kbn/scout	383	389	+6
total			+9

History

• 💔 Build #277213 failed cf1ede6
• 💔 Build #277120 failed a4fd0b4

cc @rmyz