[8.x] [APM] Migrate time_range_metadata test to deployment agnostic (e…

…lastic#200146) (elastic#200624) # Backport This will backport the following commits from `main` to `8.x`: - [[APM] Migrate time_range_metadata test to deployment agnostic (elastic#200146)](elastic#200146)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Carlos Crespo <[email protected]>
kibanamachine · Nov 18, 2024 · 8a49c1f · 8a49c1f
1 parent 779c9ba
commit 8a49c1f
Show file tree

Hide file tree

Showing 5 changed files with 324 additions and 314 deletions.
diff --git a/x-pack/test/api_integration/deployment_agnostic/apis/observability/apm/index.ts b/x-pack/test/api_integration/deployment_agnostic/apis/observability/apm/index.ts
@@ -32,6 +32,7 @@ export default function apmApiIntegrationTests({
     loadTestFile(require.resolve('./service_maps'));
     loadTestFile(require.resolve('./inspect'));
     loadTestFile(require.resolve('./service_groups'));
+    loadTestFile(require.resolve('./time_range_metadata'));
     loadTestFile(require.resolve('./diagnostics'));
     loadTestFile(require.resolve('./service_nodes'));
     loadTestFile(require.resolve('./span_links'));

diff --git a/...t/api_integration/deployment_agnostic/apis/observability/apm/time_range_metadata/index.ts b/...t/api_integration/deployment_agnostic/apis/observability/apm/time_range_metadata/index.ts
@@ -0,0 +1,15 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { DeploymentAgnosticFtrProviderContext } from '../../../../ftr_provider_context';
+
+export default function ({ loadTestFile }: DeploymentAgnosticFtrProviderContext) {
+  describe('time_range_metadata', () => {
+    loadTestFile(require.resolve('./many_apm_server_versions.spec.ts'));
+    loadTestFile(require.resolve('./time_range_metadata.spec.ts'));
+  });
+}
diff --git a/...ment_agnostic/apis/observability/apm/time_range_metadata/many_apm_server_versions.spec.ts b/...ment_agnostic/apis/observability/apm/time_range_metadata/many_apm_server_versions.spec.ts
@@ -0,0 +1,276 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+import expect from '@kbn/expect';
+import { apm, timerange } from '@kbn/apm-synthtrace-client';
+import moment from 'moment';
+import { ApmSynthtraceEsClient } from '@kbn/apm-synthtrace';
+import {
+  TRANSACTION_DURATION_HISTOGRAM,
+  TRANSACTION_DURATION_SUMMARY,
+} from '@kbn/apm-plugin/common/es_fields/apm';
+import { ApmDocumentType } from '@kbn/apm-plugin/common/document_type';
+import { RollupInterval } from '@kbn/apm-plugin/common/rollup';
+import { LatencyAggregationType } from '@kbn/apm-plugin/common/latency_aggregation_types';
+import { Readable } from 'stream';
+import type { ApmApiClient } from '../../../../services/apm_api';
+import type { DeploymentAgnosticFtrProviderContext } from '../../../../ftr_provider_context';
+
+export default function ApiTest({ getService }: DeploymentAgnosticFtrProviderContext) {
+  const apmApiClient = getService('apmApi');
+  const synthtrace = getService('synthtrace');
+  const es = getService('es');
+
+  const baseTime = new Date('2023-10-01T00:00:00.000Z').getTime();
+  const startLegacy = moment(baseTime).add(0, 'minutes');
+  const start = moment(baseTime).add(5, 'minutes');
+  const endLegacy = moment(baseTime).add(10, 'minutes');
+  const end = moment(baseTime).add(15, 'minutes');
+
+  describe('Time range metadata when there are multiple APM Server versions', () => {
+    describe('when ingesting traces from APM Server with different versions', () => {
+      let apmSynthtraceEsClient: ApmSynthtraceEsClient;
+
+      before(async () => {
+        apmSynthtraceEsClient = await synthtrace.createApmSynthtraceEsClient();
+        await generateTraceDataForService({
+          serviceName: 'synth-java-legacy',
+          start: startLegacy,
+          end: endLegacy,
+          isLegacy: true,
+          synthtrace: apmSynthtraceEsClient,
+        });
+
+        await generateTraceDataForService({
+          serviceName: 'synth-java',
+          start,
+          end,
+          isLegacy: false,
+          synthtrace: apmSynthtraceEsClient,
+        });
+      });
+
+      after(() => {
+        return apmSynthtraceEsClient.clean();
+      });
+
+      it('ingests transaction metrics with transaction.duration.summary', async () => {
+        const res = await es.search({
+          index: 'metrics-apm*',
+          body: {
+            query: {
+              bool: {
+                filter: [
+                  { exists: { field: TRANSACTION_DURATION_HISTOGRAM } },
+                  { exists: { field: TRANSACTION_DURATION_SUMMARY } },
+                ],
+              },
+            },
+          },
+        });
+
+        // @ts-expect-error
+        expect(res.hits.total.value).to.be(20);
+      });
+
+      it('ingests transaction metrics without transaction.duration.summary', async () => {
+        const res = await es.search({
+          index: 'metrics-apm*',
+          body: {
+            query: {
+              bool: {
+                filter: [{ exists: { field: TRANSACTION_DURATION_HISTOGRAM } }],
+                must_not: [{ exists: { field: TRANSACTION_DURATION_SUMMARY } }],
+              },
+            },
+          },
+        });
+
+        // @ts-expect-error
+        expect(res.hits.total.value).to.be(10);
+      });
+
+      it('has transaction.duration.summary field for every document type', async () => {
+        const response = await apmApiClient.readUser({
+          endpoint: 'GET /internal/apm/time_range_metadata',
+          params: {
+            query: {
+              start: endLegacy.toISOString(),
+              end: end.toISOString(),
+              enableContinuousRollups: true,
+              enableServiceTransactionMetrics: true,
+              useSpanName: false,
+              kuery: '',
+            },
+          },
+        });
+
+        const allHasSummaryField = response.body.sources
+          .filter(
+            (source) =>
+              source.documentType !== ApmDocumentType.TransactionEvent &&
+              source.rollupInterval !== RollupInterval.SixtyMinutes // there is not enough data for 60 minutes
+          )
+          .every((source) => {
+            return source.hasDurationSummaryField;
+          });
+
+        expect(allHasSummaryField).to.eql(true);
+      });
+
+      it('does not support transaction.duration.summary when the field is not supported by all APM server versions', async () => {
+        const response = await apmApiClient.readUser({
+          endpoint: 'GET /internal/apm/time_range_metadata',
+          params: {
+            query: {
+              start: startLegacy.toISOString(),
+              end: endLegacy.toISOString(),
+              enableContinuousRollups: true,
+              enableServiceTransactionMetrics: true,
+              useSpanName: false,
+              kuery: '',
+            },
+          },
+        });
+
+        const allHasSummaryField = response.body.sources.every((source) => {
+          return source.hasDurationSummaryField;
+        });
+
+        expect(allHasSummaryField).to.eql(false);
+      });
+
+      it('does not support transaction.duration.summary for transactionMetric 1m when not all documents within the range support it ', async () => {
+        const response = await apmApiClient.readUser({
+          endpoint: 'GET /internal/apm/time_range_metadata',
+          params: {
+            query: {
+              start: startLegacy.toISOString(),
+              end: end.toISOString(),
+              enableContinuousRollups: true,
+              enableServiceTransactionMetrics: true,
+              useSpanName: false,
+              kuery: '',
+            },
+          },
+        });
+
+        const hasDurationSummaryField = response.body.sources.find(
+          (source) =>
+            source.documentType === ApmDocumentType.TransactionMetric &&
+            source.rollupInterval === RollupInterval.OneMinute // there is not enough data for 60 minutes in the timerange defined for the tests
+        )?.hasDurationSummaryField;
+
+        expect(hasDurationSummaryField).to.eql(false);
+      });
+
+      it('does not have latency data for synth-java-legacy', async () => {
+        const res = await getLatencyChartForService({
+          serviceName: 'synth-java-legacy',
+          start,
+          end: endLegacy,
+          apmApiClient,
+          useDurationSummary: true,
+        });
+
+        expect(res.body.currentPeriod.latencyTimeseries.map(({ y }) => y)).to.eql([
+          null,
+          null,
+          null,
+          null,
+          null,
+          null,
+        ]);
+      });
+
+      it('has latency data for synth-java service', async () => {
+        const res = await getLatencyChartForService({
+          serviceName: 'synth-java',
+          start,
+          end: endLegacy,
+          apmApiClient,
+          useDurationSummary: true,
+        });
+
+        expect(res.body.currentPeriod.latencyTimeseries.map(({ y }) => y)).to.eql([
+          1000000, 1000000, 1000000, 1000000, 1000000, 1000000,
+        ]);
+      });
+    });
+  });
+}
+
+// This will retrieve latency data expecting the `transaction.duration.summary` field to be present
+function getLatencyChartForService({
+  serviceName,
+  start,
+  end,
+  apmApiClient,
+  useDurationSummary,
+}: {
+  serviceName: string;
+  start: moment.Moment;
+  end: moment.Moment;
+  apmApiClient: ApmApiClient;
+  useDurationSummary: boolean;
+}) {
+  return apmApiClient.readUser({
+    endpoint: `GET /internal/apm/services/{serviceName}/transactions/charts/latency`,
+    params: {
+      path: { serviceName },
+      query: {
+        start: start.toISOString(),
+        end: end.toISOString(),
+        environment: 'production',
+        latencyAggregationType: LatencyAggregationType.avg,
+        transactionType: 'request',
+        kuery: '',
+        documentType: ApmDocumentType.TransactionMetric,
+        rollupInterval: RollupInterval.OneMinute,
+        bucketSizeInSeconds: 60,
+        useDurationSummary,
+      },
+    },
+  });
+}
+
+function generateTraceDataForService({
+  serviceName,
+  start,
+  end,
+  isLegacy,
+  synthtrace,
+}: {
+  serviceName: string;
+  start: moment.Moment;
+  end: moment.Moment;
+  isLegacy?: boolean;
+  synthtrace: ApmSynthtraceEsClient;
+}) {
+  const instance = apm
+    .service({
+      name: serviceName,
+      environment: 'production',
+      agentName: 'java',
+    })
+    .instance(`instance`);
+
+  const events = timerange(start, end)
+    .ratePerMinute(6)
+    .generator((timestamp) =>
+      instance
+        .transaction({ transactionName: 'GET /order/{id}' })
+        .timestamp(timestamp)
+        .duration(1000)
+        .success()
+    );
+
+  const apmPipeline = (base: Readable) => {
+    return synthtrace.getDefaultPipeline({ versionOverride: '8.5.0' })(base);
+  };
+
+  return synthtrace.index(events, isLegacy ? apmPipeline : undefined);
+}