-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate
/custom_dashboards
to be deployment agnostic (#199295)
closes #198964 closes #198966 part of #193245 ### How to test - Serverless ``` node scripts/functional_tests_server --config x-pack/test/api_integration/deployment_agnostic/configs/serverless/oblt.serverless.config.ts node scripts/functional_test_runner --config x-pack/test/api_integration/deployment_agnostic/configs/serverless/oblt.serverless.config.ts --grep="APM" ``` - Stateful ``` node scripts/functional_tests_server --config x-pack/test/api_integration/deployment_agnostic/configs/stateful/oblt.stateful.config.ts node scripts/functional_test_runner --config x-pack/test/api_integration/deployment_agnostic/configs/stateful/oblt.stateful.config.ts --grep="APM" ``` - MKI tested against [MKI](https://github.com/crespocarlos/kibana/blob/main/x-pack/test_serverless/README.md#run-tests-on-mki)
- Loading branch information
1 parent
763410c
commit a947525
Showing
19 changed files
with
897 additions
and
895 deletions.
There are no files selected for viewing
This file contains 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
193 changes: 193 additions & 0 deletions
193
...on/deployment_agnostic/apis/observability/apm/custom_dashboards/custom_dashboards.spec.ts
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,193 @@ | ||
/* | ||
* 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 type { ApmSynthtraceEsClient } from '@kbn/apm-synthtrace'; | ||
import type { DeploymentAgnosticFtrProviderContext } from '../../../../ftr_provider_context'; | ||
import { | ||
getServiceDashboardApi, | ||
getLinkServiceDashboardApi, | ||
deleteAllServiceDashboard, | ||
} from './api_helper'; | ||
|
||
export default function ApiTest({ getService }: DeploymentAgnosticFtrProviderContext) { | ||
const apmApiClient = getService('apmApi'); | ||
const synthtrace = getService('synthtrace'); | ||
|
||
const start = '2023-08-22T00:00:00.000Z'; | ||
const end = '2023-08-22T00:15:00.000Z'; | ||
|
||
describe('Service dashboards', () => { | ||
describe('when data is not loaded', () => { | ||
it('handles empty state', async () => { | ||
const response = await getServiceDashboardApi(apmApiClient, 'synth-go', start, end); | ||
expect(response.status).to.be(200); | ||
expect(response.body.serviceDashboards).to.eql([]); | ||
}); | ||
}); | ||
|
||
describe('when data is loaded', () => { | ||
const range = timerange(new Date(start).getTime(), new Date(end).getTime()); | ||
let apmSynthtraceEsClient: ApmSynthtraceEsClient; | ||
|
||
const goInstance = apm | ||
.service({ | ||
name: 'synth-go', | ||
environment: 'production', | ||
agentName: 'go', | ||
}) | ||
.instance('go-instance'); | ||
|
||
const javaInstance = apm | ||
.service({ | ||
name: 'synth-java', | ||
environment: 'production', | ||
agentName: 'java', | ||
}) | ||
.instance('java-instance'); | ||
|
||
before(async () => { | ||
apmSynthtraceEsClient = await synthtrace.createApmSynthtraceEsClient(); | ||
|
||
return apmSynthtraceEsClient.index([ | ||
range | ||
.interval('1s') | ||
.rate(4) | ||
.generator((timestamp) => | ||
goInstance | ||
.transaction({ transactionName: 'GET /api' }) | ||
.timestamp(timestamp) | ||
.duration(1000) | ||
.success() | ||
), | ||
range | ||
.interval('1s') | ||
.rate(4) | ||
.generator((timestamp) => | ||
javaInstance | ||
.transaction({ transactionName: 'GET /api' }) | ||
.timestamp(timestamp) | ||
.duration(1000) | ||
.success() | ||
), | ||
]); | ||
}); | ||
|
||
after(() => { | ||
return apmSynthtraceEsClient.clean(); | ||
}); | ||
|
||
afterEach(async () => { | ||
await deleteAllServiceDashboard(apmApiClient, 'synth-go', start, end); | ||
}); | ||
|
||
describe('and when data is not loaded', () => { | ||
it('creates a new service dashboard', async () => { | ||
const serviceDashboard = { | ||
dashboardSavedObjectId: 'dashboard-saved-object-id', | ||
serviceFiltersEnabled: true, | ||
kuery: 'service.name: synth-go', | ||
}; | ||
const createResponse = await getLinkServiceDashboardApi({ | ||
apmApiClient, | ||
...serviceDashboard, | ||
}); | ||
expect(createResponse.status).to.be(200); | ||
expect(createResponse.body).to.have.property('id'); | ||
expect(createResponse.body).to.have.property('updatedAt'); | ||
|
||
expect(createResponse.body).to.have.property( | ||
'dashboardSavedObjectId', | ||
serviceDashboard.dashboardSavedObjectId | ||
); | ||
expect(createResponse.body).to.have.property('kuery', serviceDashboard.kuery); | ||
expect(createResponse.body).to.have.property( | ||
'serviceEnvironmentFilterEnabled', | ||
serviceDashboard.serviceFiltersEnabled | ||
); | ||
expect(createResponse.body).to.have.property( | ||
'serviceNameFilterEnabled', | ||
serviceDashboard.serviceFiltersEnabled | ||
); | ||
|
||
const dasboardForGoService = await getServiceDashboardApi( | ||
apmApiClient, | ||
'synth-go', | ||
start, | ||
end | ||
); | ||
const dashboardForJavaService = await getServiceDashboardApi( | ||
apmApiClient, | ||
'synth-java', | ||
start, | ||
end | ||
); | ||
expect(dashboardForJavaService.body.serviceDashboards.length).to.be(0); | ||
expect(dasboardForGoService.body.serviceDashboards.length).to.be(1); | ||
}); | ||
|
||
it('updates the existing linked service dashboard', async () => { | ||
const serviceDashboard = { | ||
dashboardSavedObjectId: 'dashboard-saved-object-id', | ||
serviceFiltersEnabled: true, | ||
kuery: 'service.name: synth-go or agent.name: java', | ||
}; | ||
|
||
await getLinkServiceDashboardApi({ | ||
apmApiClient, | ||
...serviceDashboard, | ||
}); | ||
|
||
const dasboardForGoService = await getServiceDashboardApi( | ||
apmApiClient, | ||
'synth-go', | ||
start, | ||
end | ||
); | ||
|
||
const updateResponse = await getLinkServiceDashboardApi({ | ||
apmApiClient, | ||
customDashboardId: dasboardForGoService.body.serviceDashboards[0].id, | ||
...serviceDashboard, | ||
serviceFiltersEnabled: true, | ||
}); | ||
|
||
expect(updateResponse.status).to.be(200); | ||
|
||
const updateddasboardForGoService = await getServiceDashboardApi( | ||
apmApiClient, | ||
'synth-go', | ||
start, | ||
end | ||
); | ||
expect(updateddasboardForGoService.body.serviceDashboards.length).to.be(1); | ||
expect(updateddasboardForGoService.body.serviceDashboards[0]).to.have.property( | ||
'serviceEnvironmentFilterEnabled', | ||
true | ||
); | ||
expect(updateddasboardForGoService.body.serviceDashboards[0]).to.have.property( | ||
'serviceNameFilterEnabled', | ||
true | ||
); | ||
expect(updateddasboardForGoService.body.serviceDashboards[0]).to.have.property( | ||
'kuery', | ||
'service.name: synth-go or agent.name: java' | ||
); | ||
|
||
const dashboardForJavaService = await getServiceDashboardApi( | ||
apmApiClient, | ||
'synth-java', | ||
start, | ||
end | ||
); | ||
expect(dashboardForJavaService.body.serviceDashboards.length).to.be(1); | ||
}); | ||
}); | ||
}); | ||
}); | ||
} |
14 changes: 14 additions & 0 deletions
14
...est/api_integration/deployment_agnostic/apis/observability/apm/custom_dashboards/index.ts
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
/* | ||
* 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('custom_dashboards', () => { | ||
loadTestFile(require.resolve('./custom_dashboards.spec.ts')); | ||
}); | ||
} |
Oops, something went wrong.