[9.0] [kbn-scout] Add Synthtrace as a fixture (#210505)#211351
Merged
kibanamachine merged 1 commit intoelastic:9.0from Feb 15, 2025
Merged
[9.0] [kbn-scout] Add Synthtrace as a fixture (#210505)#211351kibanamachine merged 1 commit intoelastic:9.0from
kibanamachine merged 1 commit intoelastic:9.0from
Conversation
## Summary Closes elastic#210340 This PR adds synthtrace clients to scout as a test fixture, so you can use it in your test to generate data. The clients added were `apmSynthtraceEsClient`, `infraSynthtraceEsClient` and `otelSynthtraceEsClient`. ## How to use them in parallel tests As `synthtrace` ingests data into our indices, and sequential runs would be the perfect way to introduce flakiness in our tests, there is a better way to ingest data, using a hook, at the setup phase with `globalSetup`. We need to create a `global_setup.ts` file and link it into our playwright config. Then we can use something like ``` async function globalSetup(config: FullConfig) { const data = { apm: [ opbeans({ from: new Date(start).getTime(), to: new Date(end).getTime(), }), ], infra: [ generateHosts({ from: new Date(start).toISOString(), to: new Date(end).toISOString(), }), ], otel: [ sendotlp({ from: new Date(start).getTime(), to: new Date(end).getTime(), }), ], }; return ingestSynthtraceDataHook(config, data); } ``` Each key (apm, infra, otel) accepts an array of generators. ## How to use them in sequential tests > [!WARNING] > This should not be the standard behaviour, we should embrace parallelism and use sequential testing when there is no other way. ### apmSynthtraceEsClient ```ts test.before( async ({ apmSynthtraceEsClient }) => { await apmSynthtraceEsClient.index( opbeans({ from: new Date(start).getTime(), to: new Date(end).getTime(), }) ); } ); ``` [opbeans file](https://github.com/elastic/kibana/blob/main/x-pack/solutions/observability/plugins/apm/ftr_e2e/cypress/fixtures/synthtrace/opbeans.ts) used in the example. ### otelSynthtraceEsClient ```ts test.before( async ({otelSynthtraceEsClient }) => { await otelSynthtraceEsClient.index( sendotlp({ from: new Date(start).getTime(), to: new Date(end).getTime(), }) ); } ); ``` [sendotlp file](https://github.com/elastic/kibana/blob/main/x-pack/solutions/observability/plugins/apm/ftr_e2e/cypress/fixtures/synthtrace/sendotlp.ts) which will create the data. ### infraSynthtraceEsClient ```ts test.before( async ({ infraSynthtraceEsClient }) => { await infraSynthtraceEsClient.index( generateHosts({ from: new Date(start).toISOString(), to: new Date(end).toISOString(), }) ); } ); ``` [generateHosts file](https://github.com/elastic/kibana/blob/main/x-pack/solutions/observability/plugins/inventory/e2e/cypress/e2e/alert_count/generate_data.ts#L82) used to generate data. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit e21c5d0)
kibanamachine
force-pushed
the
backport/9.0/pr-210505
branch
from
b88b8af to
2c4520e
Compare
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
💚 Build Succeeded
Metrics [docs]Public APIs missing comments
Public APIs missing exports
cc @rmyz |
kibanamachine
added a commit
that referenced
this pull request
Feb 18, 2025
# Backport This will backport the following commits from `main` to `8.x`: - [[kbn-scout] Add Synthtrace as a fixture (#210505)](#210505) <!--- Backport version: 9.6.5 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Sergi Romeu","email":"sergi.romeu@elastic.co"},"sourceCommit":{"committedDate":"2025-02-14T18:52:22Z","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","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","apm:synthtrace","Team:obs-ux-infra_services","backport:version","test:scout","v9.1.0","v8.19.0"],"title":"[kbn-scout] Add Synthtrace as a fixture","number":210505,"url":"https://github.com/elastic/kibana/pull/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"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/211351","number":211351,"state":"MERGED","mergeCommit":{"sha":"5b6ff1cd6e7cd703ed66337ee743a08abf0fa7a8","message":"[9.0] [kbn-scout] Add Synthtrace as a fixture (#210505) (#211351)\n\n# Backport\n\nThis will backport the following commits from `main` to `9.0`:\n- [[kbn-scout] Add Synthtrace as a fixture\n(#210505)](https://github.com/elastic/kibana/pull/210505)\n\n<!--- Backport version: 9.4.3 -->\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n<!--BACKPORT [{\"author\":{\"name\":\"Sergi\nRomeu\",\"email\":\"sergi.romeu@elastic.co\"},\"sourceCommit\":{\"committedDate\":\"2025-02-14T18:52:22Z\",\"message\":\"[kbn-scout]\nAdd Synthtrace as a fixture (#210505)\\n\\n## Summary\\n\\nCloses\n#210340\\n\\nThis PR adds synthtrace clients to scout as a test fixture,\nso you can\\nuse it in your test to generate data.\\n\\nThe clients added\nwere `apmSynthtraceEsClient`,\\n`infraSynthtraceEsClient` and\n`otelSynthtraceEsClient`.\\n\\n## How to use them in parallel tests\\n\\nAs\n`synthtrace` ingests data into our indices, and sequential runs\nwould\\nbe the perfect way to introduce flakiness in our tests, there is\na\\nbetter way to ingest data, using a hook, at the setup phase\nwith\\n`globalSetup`.\\nWe need to create a `global_setup.ts` file and\nlink it into our\\nplaywright config.\\nThen we can use something\nlike\\n```\\nasync function globalSetup(config: FullConfig) {\\n const data\n= {\\n apm: [\\n opbeans({\\n from: new Date(start).getTime(),\\n to: new\nDate(end).getTime(),\\n }),\\n ],\\n infra: [\\n generateHosts({\\n from: new\nDate(start).toISOString(),\\n to: new Date(end).toISOString(),\\n }),\\n\n],\\n otel: [\\n sendotlp({\\n from: new Date(start).getTime(),\\n to: new\nDate(end).getTime(),\\n }),\\n ],\\n };\\n\\n return\ningestSynthtraceDataHook(config, data);\\n}\\n```\\nEach key (apm, infra,\notel) accepts an array of generators.\\n\\n## How to use them in\nsequential tests\\n> [!WARNING] \\n> This should not be the standard\nbehaviour, we should embrace\\nparallelism and use sequential testing\nwhen there is no other way.\\n\\n### apmSynthtraceEsClient\\n```ts\\n\ntest.before(\\n async ({ apmSynthtraceEsClient }) => {\\n await\napmSynthtraceEsClient.index(\\n opbeans({\\n from: new\nDate(start).getTime(),\\n to: new Date(end).getTime(),\\n })\\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\nin the example.\\n\\n### otelSynthtraceEsClient\\n```ts\\n test.before(\\n\nasync ({otelSynthtraceEsClient }) => {\\n await\notelSynthtraceEsClient.index(\\n sendotlp({\\n from: new\nDate(start).getTime(),\\n to: new Date(end).getTime(),\\n })\\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\nwill create the data.\\n\\n### infraSynthtraceEsClient\\n```ts\\n\ntest.before(\\n async ({ infraSynthtraceEsClient }) => {\\n await\ninfraSynthtraceEsClient.index(\\n generateHosts({\\n from: new\nDate(start).toISOString(),\\n to: new Date(end).toISOString(),\\n })\\n\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\nto generate data.\\n\\n---------\\n\\nCo-authored-by: kibanamachine\n<42973632+kibanamachine@users.noreply.github.com>\",\"sha\":\"e21c5d0e9175ffd1bea0ad78ffe26cb973cc489f\",\"branchLabelMapping\":{\"^v9.1.0$\":\"main\",\"^v8.19.0$\":\"8.x\",\"^v(\\\\d+).(\\\\d+).\\\\d+$\":\"$1.$2\"}},\"sourcePullRequest\":{\"labels\":[\"release_note:skip\",\"v9.0.0\",\"apm:synthtrace\",\"Team:obs-ux-infra_services\",\"backport:version\",\"test:scout\",\"v9.1.0\",\"v8.19.0\"],\"title\":\"[kbn-scout]\nAdd Synthtrace as a\nfixture\",\"number\":210505,\"url\":\"https://github.com/elastic/kibana/pull/210505\",\"mergeCommit\":{\"message\":\"[kbn-scout]\nAdd Synthtrace as a fixture (#210505)\\n\\n## Summary\\n\\nCloses\n#210340\\n\\nThis PR adds synthtrace clients to scout as a test fixture,\nso you can\\nuse it in your test to generate data.\\n\\nThe clients added\nwere `apmSynthtraceEsClient`,\\n`infraSynthtraceEsClient` and\n`otelSynthtraceEsClient`.\\n\\n## How to use them in parallel tests\\n\\nAs\n`synthtrace` ingests data into our indices, and sequential runs\nwould\\nbe the perfect way to introduce flakiness in our tests, there is\na\\nbetter way to ingest data, using a hook, at the setup phase\nwith\\n`globalSetup`.\\nWe need to create a `global_setup.ts` file and\nlink it into our\\nplaywright config.\\nThen we can use something\nlike\\n```\\nasync function globalSetup(config: FullConfig) {\\n const data\n= {\\n apm: [\\n opbeans({\\n from: new Date(start).getTime(),\\n to: new\nDate(end).getTime(),\\n }),\\n ],\\n infra: [\\n generateHosts({\\n from: new\nDate(start).toISOString(),\\n to: new Date(end).toISOString(),\\n }),\\n\n],\\n otel: [\\n sendotlp({\\n from: new Date(start).getTime(),\\n to: new\nDate(end).getTime(),\\n }),\\n ],\\n };\\n\\n return\ningestSynthtraceDataHook(config, data);\\n}\\n```\\nEach key (apm, infra,\notel) accepts an array of generators.\\n\\n## How to use them in\nsequential tests\\n> [!WARNING] \\n> This should not be the standard\nbehaviour, we should embrace\\nparallelism and use sequential testing\nwhen there is no other way.\\n\\n### apmSynthtraceEsClient\\n```ts\\n\ntest.before(\\n async ({ apmSynthtraceEsClient }) => {\\n await\napmSynthtraceEsClient.index(\\n opbeans({\\n from: new\nDate(start).getTime(),\\n to: new Date(end).getTime(),\\n })\\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\nin the example.\\n\\n### otelSynthtraceEsClient\\n```ts\\n test.before(\\n\nasync ({otelSynthtraceEsClient }) => {\\n await\notelSynthtraceEsClient.index(\\n sendotlp({\\n from: new\nDate(start).getTime(),\\n to: new Date(end).getTime(),\\n })\\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\nwill create the data.\\n\\n### infraSynthtraceEsClient\\n```ts\\n\ntest.before(\\n async ({ infraSynthtraceEsClient }) => {\\n await\ninfraSynthtraceEsClient.index(\\n generateHosts({\\n from: new\nDate(start).toISOString(),\\n to: new Date(end).toISOString(),\\n })\\n\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\nto generate data.\\n\\n---------\\n\\nCo-authored-by: kibanamachine\n<42973632+kibanamachine@users.noreply.github.com>\",\"sha\":\"e21c5d0e9175ffd1bea0ad78ffe26cb973cc489f\"}},\"sourceBranch\":\"main\",\"suggestedTargetBranches\":[\"9.0\",\"8.x\"],\"targetPullRequestStates\":[{\"branch\":\"9.0\",\"label\":\"v9.0.0\",\"branchLabelMappingKey\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"main\",\"label\":\"v9.1.0\",\"branchLabelMappingKey\":\"^v9.1.0$\",\"isSourceBranch\":true,\"state\":\"MERGED\",\"url\":\"https://github.com/elastic/kibana/pull/210505\",\"number\":210505,\"mergeCommit\":{\"message\":\"[kbn-scout]\nAdd Synthtrace as a fixture (#210505)\\n\\n## Summary\\n\\nCloses\n#210340\\n\\nThis PR adds synthtrace clients to scout as a test fixture,\nso you can\\nuse it in your test to generate data.\\n\\nThe clients added\nwere `apmSynthtraceEsClient`,\\n`infraSynthtraceEsClient` and\n`otelSynthtraceEsClient`.\\n\\n## How to use them in parallel tests\\n\\nAs\n`synthtrace` ingests data into our indices, and sequential runs\nwould\\nbe the perfect way to introduce flakiness in our tests, there is\na\\nbetter way to ingest data, using a hook, at the setup phase\nwith\\n`globalSetup`.\\nWe need to create a `global_setup.ts` file and\nlink it into our\\nplaywright config.\\nThen we can use something\nlike\\n```\\nasync function globalSetup(config: FullConfig) {\\n const data\n= {\\n apm: [\\n opbeans({\\n from: new Date(start).getTime(),\\n to: new\nDate(end).getTime(),\\n }),\\n ],\\n infra: [\\n generateHosts({\\n from: new\nDate(start).toISOString(),\\n to: new Date(end).toISOString(),\\n }),\\n\n],\\n otel: [\\n sendotlp({\\n from: new Date(start).getTime(),\\n to: new\nDate(end).getTime(),\\n }),\\n ],\\n };\\n\\n return\ningestSynthtraceDataHook(config, data);\\n}\\n```\\nEach key (apm, infra,\notel) accepts an array of generators.\\n\\n## How to use them in\nsequential tests\\n> [!WARNING] \\n> This should not be the standard\nbehaviour, we should embrace\\nparallelism and use sequential testing\nwhen there is no other way.\\n\\n### apmSynthtraceEsClient\\n```ts\\n\ntest.before(\\n async ({ apmSynthtraceEsClient }) => {\\n await\napmSynthtraceEsClient.index(\\n opbeans({\\n from: new\nDate(start).getTime(),\\n to: new Date(end).getTime(),\\n })\\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\nin the example.\\n\\n### otelSynthtraceEsClient\\n```ts\\n test.before(\\n\nasync ({otelSynthtraceEsClient }) => {\\n await\notelSynthtraceEsClient.index(\\n sendotlp({\\n from: new\nDate(start).getTime(),\\n to: new Date(end).getTime(),\\n })\\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\nwill create the data.\\n\\n### infraSynthtraceEsClient\\n```ts\\n\ntest.before(\\n async ({ infraSynthtraceEsClient }) => {\\n await\ninfraSynthtraceEsClient.index(\\n generateHosts({\\n from: new\nDate(start).toISOString(),\\n to: new Date(end).toISOString(),\\n })\\n\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\nto generate data.\\n\\n---------\\n\\nCo-authored-by: kibanamachine\n<42973632+kibanamachine@users.noreply.github.com>\",\"sha\":\"e21c5d0e9175ffd1bea0ad78ffe26cb973cc489f\"}},{\"branch\":\"8.x\",\"label\":\"v8.19.0\",\"branchLabelMappingKey\":\"^v8.19.0$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"}]}]\nBACKPORT-->\n\nCo-authored-by: Sergi Romeu <sergi.romeu@elastic.co>"}},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/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--> --------- Co-authored-by: Sergi Romeu <sergi.romeu@elastic.co>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
mainto9.0:Questions ?
Please refer to the Backport tool documentation