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 index 6c7e0898855a4..8075f2cdbfc3d 100644 --- 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 @@ -28,6 +28,7 @@ export default function apmApiIntegrationTests({ loadTestFile(require.resolve('./observability_overview')); loadTestFile(require.resolve('./latency')); loadTestFile(require.resolve('./infrastructure')); + loadTestFile(require.resolve('./service_maps')); loadTestFile(require.resolve('./inspect')); loadTestFile(require.resolve('./service_groups')); }); diff --git a/x-pack/test/api_integration/deployment_agnostic/apis/observability/apm/service_maps/index.ts b/x-pack/test/api_integration/deployment_agnostic/apis/observability/apm/service_maps/index.ts new file mode 100644 index 0000000000000..97681cae7def9 --- /dev/null +++ b/x-pack/test/api_integration/deployment_agnostic/apis/observability/apm/service_maps/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('service_maps', () => { + loadTestFile(require.resolve('./service_maps.spec.ts')); + loadTestFile(require.resolve('./service_maps_kuery_filter.spec.ts')); + }); +} diff --git a/x-pack/test/api_integration/deployment_agnostic/apis/observability/apm/service_maps/service_maps.spec.ts b/x-pack/test/api_integration/deployment_agnostic/apis/observability/apm/service_maps/service_maps.spec.ts new file mode 100644 index 0000000000000..809c10b2f01e8 --- /dev/null +++ b/x-pack/test/api_integration/deployment_agnostic/apis/observability/apm/service_maps/service_maps.spec.ts @@ -0,0 +1,156 @@ +/* + * 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 type { ApmSynthtraceEsClient } from '@kbn/apm-synthtrace'; +import expect from 'expect'; +import { serviceMap, timerange } from '@kbn/apm-synthtrace-client'; +import { Readable } from 'node:stream'; +import type { SupertestReturnType } from '../../../../../../apm_api_integration/common/apm_api_supertest'; +import type { DeploymentAgnosticFtrProviderContext } from '../../../../ftr_provider_context'; + +type DependencyResponse = SupertestReturnType<'GET /internal/apm/service-map/dependency'>; +type ServiceNodeResponse = + SupertestReturnType<'GET /internal/apm/service-map/service/{serviceName}'>; + +export default function ({ getService }: DeploymentAgnosticFtrProviderContext) { + const apmApiClient = getService('apmApi'); + const synthtrace = getService('synthtrace'); + + const start = new Date('2024-06-01T00:00:00.000Z').getTime(); + const end = new Date('2024-06-01T00:01:00.000Z').getTime(); + + describe('APM Service maps', () => { + describe('without data', () => { + it('returns an empty list', async () => { + const response = await apmApiClient.readUser({ + endpoint: `GET /internal/apm/service-map`, + params: { + query: { + start: new Date(start).toISOString(), + end: new Date(end).toISOString(), + environment: 'ENVIRONMENT_ALL', + }, + }, + }); + + expect(response.status).toBe(200); + expect(response.body.elements.length).toBe(0); + }); + + describe('/internal/apm/service-map/service/{serviceName} without data', () => { + let response: ServiceNodeResponse; + before(async () => { + response = await apmApiClient.readUser({ + endpoint: `GET /internal/apm/service-map/service/{serviceName}`, + params: { + path: { serviceName: 'opbeans-node' }, + query: { + start: new Date(start).toISOString(), + end: new Date(end).toISOString(), + environment: 'ENVIRONMENT_ALL', + }, + }, + }); + }); + + it('retuns status code 200', () => { + expect(response.status).toBe(200); + }); + + it('returns an object with nulls', async () => { + [ + response.body.currentPeriod?.failedTransactionsRate?.value, + response.body.currentPeriod?.memoryUsage?.value, + response.body.currentPeriod?.cpuUsage?.value, + response.body.currentPeriod?.transactionStats?.latency?.value, + response.body.currentPeriod?.transactionStats?.throughput?.value, + ].forEach((value) => { + expect(value).toEqual(null); + }); + }); + }); + + describe('/internal/apm/service-map/dependency', () => { + let response: DependencyResponse; + before(async () => { + response = await apmApiClient.readUser({ + endpoint: `GET /internal/apm/service-map/dependency`, + params: { + query: { + dependencyName: 'postgres', + start: new Date(start).toISOString(), + end: new Date(end).toISOString(), + environment: 'ENVIRONMENT_ALL', + }, + }, + }); + }); + + it('retuns status code 200', () => { + expect(response.status).toBe(200); + }); + + it('returns undefined values', () => { + expect(response.body.currentPeriod).toEqual({ transactionStats: {} }); + }); + }); + }); + + describe('with synthtrace data', () => { + let synthtraceEsClient: ApmSynthtraceEsClient; + + before(async () => { + synthtraceEsClient = await synthtrace.createApmSynthtraceEsClient(); + + const events = timerange(start, end) + .interval('10s') + .rate(3) + .generator( + serviceMap({ + services: [ + { 'frontend-rum': 'rum-js' }, + { 'frontend-node': 'nodejs' }, + { advertService: 'java' }, + ], + definePaths([rum, node, adv]) { + return [ + [ + [rum, 'fetchAd'], + [node, 'GET /nodejs/adTag'], + [adv, 'APIRestController#getAd'], + ['elasticsearch', 'GET ad-*/_search'], + ], + ]; + }, + }) + ); + + return synthtraceEsClient.index(Readable.from(Array.from(events))); + }); + + after(async () => { + await synthtraceEsClient.clean(); + }); + + it('returns service map elements', async () => { + const response = await apmApiClient.readUser({ + endpoint: 'GET /internal/apm/service-map', + params: { + query: { + start: new Date(start).toISOString(), + end: new Date(end).toISOString(), + environment: 'ENVIRONMENT_ALL', + }, + }, + }); + + expect(response.status).toBe(200); + expect(response.body.elements.length).toBeGreaterThan(0); + }); + }); + }); +} diff --git a/x-pack/test/api_integration/deployment_agnostic/apis/observability/apm/service_maps/service_maps_kuery_filter.spec.ts b/x-pack/test/api_integration/deployment_agnostic/apis/observability/apm/service_maps/service_maps_kuery_filter.spec.ts new file mode 100644 index 0000000000000..9a14b3690a81b --- /dev/null +++ b/x-pack/test/api_integration/deployment_agnostic/apis/observability/apm/service_maps/service_maps_kuery_filter.spec.ts @@ -0,0 +1,137 @@ +/* + * 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 { timerange, serviceMap } from '@kbn/apm-synthtrace-client'; +import { + APIClientRequestParamsOf, + APIReturnType, +} from '@kbn/apm-plugin/public/services/rest/create_call_apm_api'; +import { RecursivePartial } from '@kbn/apm-plugin/typings/common'; +import { ApmSynthtraceEsClient } from '@kbn/apm-synthtrace'; +import type { DeploymentAgnosticFtrProviderContext } from '../../../../ftr_provider_context'; + +export default function ApiTest({ getService }: DeploymentAgnosticFtrProviderContext) { + const apmApiClient = getService('apmApi'); + const synthtrace = getService('synthtrace'); + + const start = new Date('2023-01-01T00:00:00.000Z').getTime(); + const end = new Date('2023-01-01T00:15:00.000Z').getTime() - 1; + + async function callApi( + overrides?: RecursivePartial< + APIClientRequestParamsOf<'GET /internal/apm/service-map'>['params'] + > + ) { + return await apmApiClient.readUser({ + endpoint: 'GET /internal/apm/service-map', + params: { + query: { + start: new Date(start).toISOString(), + end: new Date(end).toISOString(), + environment: 'ENVIRONMENT_ALL', + kuery: '', + ...overrides?.query, + }, + }, + }); + } + + describe('service map kuery filter', () => { + let apmSynthtraceEsClient: ApmSynthtraceEsClient; + + before(async () => { + apmSynthtraceEsClient = await synthtrace.createApmSynthtraceEsClient(); + + const events = timerange(start, end) + .interval('15m') + .rate(1) + .generator( + serviceMap({ + services: [ + { 'synthbeans-go': 'go' }, + { 'synthbeans-java': 'java' }, + { 'synthbeans-node': 'nodejs' }, + ], + definePaths([go, java, node]) { + return [ + [go, java], + [java, go, 'redis'], + [node, 'redis'], + { + path: [node, java, go, 'elasticsearch'], + transaction: (t) => t.defaults({ 'labels.name': 'node-java-go-es' }), + }, + [go, node, java], + ]; + }, + }) + ); + await apmSynthtraceEsClient.index(events); + }); + + after(() => apmSynthtraceEsClient.clean()); + + it('returns full service map when no kuery is defined', async () => { + const { status, body } = await callApi(); + + expect(status).to.be(200); + + const { nodes, edges } = partitionElements(body.elements); + + expect(getIds(nodes)).to.eql([ + '>elasticsearch', + '>redis', + 'synthbeans-go', + 'synthbeans-java', + 'synthbeans-node', + ]); + expect(getIds(edges)).to.eql([ + 'synthbeans-go~>elasticsearch', + 'synthbeans-go~>redis', + 'synthbeans-go~synthbeans-java', + 'synthbeans-go~synthbeans-node', + 'synthbeans-java~synthbeans-go', + 'synthbeans-node~>redis', + 'synthbeans-node~synthbeans-java', + ]); + }); + + it('returns only service nodes and connections filtered by given kuery', async () => { + const { status, body } = await callApi({ + query: { kuery: `labels.name: "node-java-go-es"` }, + }); + + expect(status).to.be(200); + + const { nodes, edges } = partitionElements(body.elements); + + expect(getIds(nodes)).to.eql([ + '>elasticsearch', + 'synthbeans-go', + 'synthbeans-java', + 'synthbeans-node', + ]); + expect(getIds(edges)).to.eql([ + 'synthbeans-go~>elasticsearch', + 'synthbeans-java~synthbeans-go', + 'synthbeans-node~synthbeans-java', + ]); + }); + }); +} + +type ConnectionElements = APIReturnType<'GET /internal/apm/service-map'>['elements']; + +function partitionElements(elements: ConnectionElements) { + const edges = elements.filter(({ data }) => 'source' in data && 'target' in data); + const nodes = elements.filter((element) => !edges.includes(element)); + return { edges, nodes }; +} + +function getIds(elements: ConnectionElements) { + return elements.map(({ data }) => data.id).sort(); +} diff --git a/x-pack/test/apm_api_integration/tests/service_maps/service_maps.spec.ts b/x-pack/test/apm_api_integration/tests/service_maps/service_maps.spec.ts index 83965595020da..ae7a08b0664c1 100644 --- a/x-pack/test/apm_api_integration/tests/service_maps/service_maps.spec.ts +++ b/x-pack/test/apm_api_integration/tests/service_maps/service_maps.spec.ts @@ -52,84 +52,6 @@ export default function serviceMapsApiTests({ getService }: FtrProviderContext) }); }); - registry.when('Service Map without data', { config: 'trial', archives: [] }, () => { - describe('/internal/apm/service-map without data', () => { - it('returns an empty list', async () => { - const response = await apmApiClient.readUser({ - endpoint: `GET /internal/apm/service-map`, - params: { - query: { - start: metadata.start, - end: metadata.end, - environment: 'ENVIRONMENT_ALL', - }, - }, - }); - - expect(response.status).to.be(200); - expect(response.body.elements.length).to.be(0); - }); - }); - - describe('/internal/apm/service-map/service/{serviceName} without data', () => { - let response: ServiceNodeResponse; - before(async () => { - response = await apmApiClient.readUser({ - endpoint: `GET /internal/apm/service-map/service/{serviceName}`, - params: { - path: { serviceName: 'opbeans-node' }, - query: { - start: metadata.start, - end: metadata.end, - environment: 'ENVIRONMENT_ALL', - }, - }, - }); - }); - - it('retuns status code 200', () => { - expect(response.status).to.be(200); - }); - - it('returns an object with nulls', async () => { - [ - response.body.currentPeriod?.failedTransactionsRate?.value, - response.body.currentPeriod?.memoryUsage?.value, - response.body.currentPeriod?.cpuUsage?.value, - response.body.currentPeriod?.transactionStats?.latency?.value, - response.body.currentPeriod?.transactionStats?.throughput?.value, - ].forEach((value) => { - expect(value).to.be.eql(null); - }); - }); - }); - - describe('/internal/apm/service-map/dependency', () => { - let response: DependencyResponse; - before(async () => { - response = await apmApiClient.readUser({ - endpoint: `GET /internal/apm/service-map/dependency`, - params: { - query: { - dependencyName: 'postgres', - start: metadata.start, - end: metadata.end, - environment: 'ENVIRONMENT_ALL', - }, - }, - }); - }); - - it('retuns status code 200', () => { - expect(response.status).to.be(200); - }); - - it('returns undefined values', () => { - expect(response.body.currentPeriod).to.eql({ transactionStats: {} }); - }); - }); - }); - registry.when('Service Map with data', { config: 'trial', archives: ['apm_8.0.0'] }, () => { describe('/internal/apm/service-map with data', () => { let response: ServiceMapResponse; diff --git a/x-pack/test/apm_api_integration/tests/service_maps/service_maps_kuery_filter.spec.ts b/x-pack/test/apm_api_integration/tests/service_maps/service_maps_kuery_filter.spec.ts deleted file mode 100644 index b87e0de70495e..0000000000000 --- a/x-pack/test/apm_api_integration/tests/service_maps/service_maps_kuery_filter.spec.ts +++ /dev/null @@ -1,135 +0,0 @@ -/* - * 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 { timerange, serviceMap } from '@kbn/apm-synthtrace-client'; -import { - APIClientRequestParamsOf, - APIReturnType, -} from '@kbn/apm-plugin/public/services/rest/create_call_apm_api'; -import { RecursivePartial } from '@kbn/apm-plugin/typings/common'; -import { FtrProviderContext } from '../../common/ftr_provider_context'; - -export default function ApiTest({ getService }: FtrProviderContext) { - const registry = getService('registry'); - const apmApiClient = getService('apmApiClient'); - const apmSynthtraceEsClient = getService('apmSynthtraceEsClient'); - - const start = new Date('2023-01-01T00:00:00.000Z').getTime(); - const end = new Date('2023-01-01T00:15:00.000Z').getTime() - 1; - - async function callApi( - overrides?: RecursivePartial< - APIClientRequestParamsOf<'GET /internal/apm/service-map'>['params'] - > - ) { - return await apmApiClient.readUser({ - endpoint: 'GET /internal/apm/service-map', - params: { - query: { - start: new Date(start).toISOString(), - end: new Date(end).toISOString(), - environment: 'ENVIRONMENT_ALL', - kuery: '', - ...overrides?.query, - }, - }, - }); - } - - registry.when('Service Map', { config: 'trial', archives: [] }, () => { - describe('optional kuery param', () => { - before(async () => { - const events = timerange(start, end) - .interval('15m') - .rate(1) - .generator( - serviceMap({ - services: [ - { 'synthbeans-go': 'go' }, - { 'synthbeans-java': 'java' }, - { 'synthbeans-node': 'nodejs' }, - ], - definePaths([go, java, node]) { - return [ - [go, java], - [java, go, 'redis'], - [node, 'redis'], - { - path: [node, java, go, 'elasticsearch'], - transaction: (t) => t.defaults({ 'labels.name': 'node-java-go-es' }), - }, - [go, node, java], - ]; - }, - }) - ); - await apmSynthtraceEsClient.index(events); - }); - - after(() => apmSynthtraceEsClient.clean()); - - it('returns full service map when no kuery is defined', async () => { - const { status, body } = await callApi(); - - expect(status).to.be(200); - - const { nodes, edges } = partitionElements(body.elements); - - expect(getIds(nodes)).to.eql([ - '>elasticsearch', - '>redis', - 'synthbeans-go', - 'synthbeans-java', - 'synthbeans-node', - ]); - expect(getIds(edges)).to.eql([ - 'synthbeans-go~>elasticsearch', - 'synthbeans-go~>redis', - 'synthbeans-go~synthbeans-java', - 'synthbeans-go~synthbeans-node', - 'synthbeans-java~synthbeans-go', - 'synthbeans-node~>redis', - 'synthbeans-node~synthbeans-java', - ]); - }); - - it('returns only service nodes and connections filtered by given kuery', async () => { - const { status, body } = await callApi({ - query: { kuery: `labels.name: "node-java-go-es"` }, - }); - - expect(status).to.be(200); - - const { nodes, edges } = partitionElements(body.elements); - - expect(getIds(nodes)).to.eql([ - '>elasticsearch', - 'synthbeans-go', - 'synthbeans-java', - 'synthbeans-node', - ]); - expect(getIds(edges)).to.eql([ - 'synthbeans-go~>elasticsearch', - 'synthbeans-java~synthbeans-go', - 'synthbeans-node~synthbeans-java', - ]); - }); - }); - }); -} - -type ConnectionElements = APIReturnType<'GET /internal/apm/service-map'>['elements']; - -function partitionElements(elements: ConnectionElements) { - const edges = elements.filter(({ data }) => 'source' in data && 'target' in data); - const nodes = elements.filter((element) => !edges.includes(element)); - return { edges, nodes }; -} - -function getIds(elements: ConnectionElements) { - return elements.map(({ data }) => data.id).sort(); -} diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/apm_api_integration/service_maps/service_maps.ts b/x-pack/test_serverless/api_integration/test_suites/observability/apm_api_integration/service_maps/service_maps.ts deleted file mode 100644 index 1c849164d54c5..0000000000000 --- a/x-pack/test_serverless/api_integration/test_suites/observability/apm_api_integration/service_maps/service_maps.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* - * 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 { ApmSynthtraceEsClient } from '@kbn/apm-synthtrace'; -import expect from 'expect'; -import { serviceMap, timerange } from '@kbn/apm-synthtrace-client'; -import { Readable } from 'stream'; -import type { InternalRequestHeader, RoleCredentials } from '../../../../../shared/services'; -import { APMFtrContextProvider } from '../common/services'; - -export default function ({ getService }: APMFtrContextProvider) { - const apmApiClient = getService('apmApiClient'); - const svlUserManager = getService('svlUserManager'); - const svlCommonApi = getService('svlCommonApi'); - const synthtrace = getService('synthtrace'); - - const start = new Date('2024-06-01T00:00:00.000Z').getTime(); - const end = new Date('2024-06-01T00:01:00.000Z').getTime(); - - describe('APM Service maps', () => { - let roleAuthc: RoleCredentials; - let internalReqHeader: InternalRequestHeader; - let synthtraceEsClient: ApmSynthtraceEsClient; - - before(async () => { - synthtraceEsClient = await synthtrace.createSynthtraceEsClient(); - - const events = timerange(start, end) - .interval('10s') - .rate(3) - .generator( - serviceMap({ - services: [ - { 'frontend-rum': 'rum-js' }, - { 'frontend-node': 'nodejs' }, - { advertService: 'java' }, - ], - definePaths([rum, node, adv]) { - return [ - [ - [rum, 'fetchAd'], - [node, 'GET /nodejs/adTag'], - [adv, 'APIRestController#getAd'], - ['elasticsearch', 'GET ad-*/_search'], - ], - ]; - }, - }) - ); - - internalReqHeader = svlCommonApi.getInternalRequestHeader(); - roleAuthc = await svlUserManager.createM2mApiKeyWithRoleScope('admin'); - - return synthtraceEsClient.index(Readable.from(Array.from(events))); - }); - - after(async () => { - await svlUserManager.invalidateM2mApiKeyWithRoleScope(roleAuthc); - return synthtraceEsClient.clean(); - }); - - it('returns service map elements', async () => { - const response = await apmApiClient.slsUser({ - endpoint: 'GET /internal/apm/service-map', - params: { - query: { - start: new Date(start).toISOString(), - end: new Date(end).toISOString(), - environment: 'ENVIRONMENT_ALL', - }, - }, - roleAuthc, - internalReqHeader, - }); - - expect(response.status).toBe(200); - expect(response.body.elements.length).toBeGreaterThan(0); - }); - }); -} diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/index.ts b/x-pack/test_serverless/api_integration/test_suites/observability/index.ts index bfe3fd4cbb2c6..89543982f2d44 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/index.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/index.ts @@ -12,7 +12,6 @@ export default function ({ loadTestFile }: FtrProviderContext) { this.tags(['esGate']); loadTestFile(require.resolve('./apm_api_integration/feature_flags.ts')); - loadTestFile(require.resolve('./apm_api_integration/service_maps/service_maps')); loadTestFile(require.resolve('./apm_api_integration/traces/critical_path')); loadTestFile(require.resolve('./cases')); loadTestFile(require.resolve('./synthetics'));