-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[EBT] Use UI/Usage Counters to report success telemetry about EBT (#1…
- Loading branch information
Showing
17 changed files
with
295 additions
and
17 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
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
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
14 changes: 14 additions & 0 deletions
14
src/plugins/kibana_usage_collection/public/ebt_counters/README.md
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 @@ | ||
| # Event-based Telemetry Success Counters (browser-side) | ||
|
|
||
| Using the UI Counters API, it reports the stats coming from the `core.analytics.telemetryCounters$` observable. It allows us to track the success of the EBT client on the browser. | ||
|
|
||
| ## Field mappings | ||
|
|
||
| As the number of fields available in the Usage API is reduced, this collection merges some fields to be able to report it. | ||
|
|
||
| | UI Counter field | Telemetry Counter fields | | ||
| |------------------|--------------------------------------------------------------------------------------------------| | ||
| | `appName` | Concatenation of the string `'ebt_counters.'` and the `source` (`'client'` or the shipper name). | | ||
| | `eventName` | Matches the `eventType`. | | ||
| | `counterType` | Concatenation of the `type` and the `code` (i.e.: `'succeeded_200'`). | | ||
| | `total` | Matches the value in `count`. | |
9 changes: 9 additions & 0 deletions
9
src/plugins/kibana_usage_collection/public/ebt_counters/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,9 @@ | ||
| /* | ||
| * 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 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| export { registerEbtCounters } from './register_ebt_counters'; |
54 changes: 54 additions & 0 deletions
54
src/plugins/kibana_usage_collection/public/ebt_counters/register_ebt_counters.test.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,54 @@ | ||
| /* | ||
| * 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 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import type { TelemetryCounter } from '@kbn/analytics-client'; | ||
| import { TelemetryCounterType } from '@kbn/analytics-client'; | ||
| import { coreMock } from '@kbn/core/public/mocks'; | ||
| import { usageCollectionPluginMock } from '@kbn/usage-collection-plugin/public/mocks'; | ||
| import { registerEbtCounters } from './register_ebt_counters'; | ||
|
|
||
| describe('registerEbtCounters', () => { | ||
| let core: ReturnType<typeof coreMock.createSetup>; | ||
| let usageCollection: ReturnType<typeof usageCollectionPluginMock.createSetupContract>; | ||
| let internalListener: (counter: TelemetryCounter) => void; | ||
| let telemetryCounter$Spy: jest.SpyInstance; | ||
|
|
||
| beforeEach(() => { | ||
| core = coreMock.createSetup(); | ||
| usageCollection = usageCollectionPluginMock.createSetupContract(); | ||
| telemetryCounter$Spy = jest | ||
| .spyOn(core.analytics.telemetryCounter$, 'subscribe') | ||
| .mockImplementation(((listener) => { | ||
| internalListener = listener as (counter: TelemetryCounter) => void; | ||
| }) as typeof core.analytics.telemetryCounter$['subscribe']); | ||
| }); | ||
|
|
||
| test('it subscribes to `analytics.telemetryCounters$`', () => { | ||
| registerEbtCounters(core.analytics, usageCollection); | ||
| expect(telemetryCounter$Spy).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| test('it reports a UI counter whenever a counter is emitted', () => { | ||
| registerEbtCounters(core.analytics, usageCollection); | ||
| expect(telemetryCounter$Spy).toHaveBeenCalledTimes(1); | ||
| internalListener({ | ||
| type: TelemetryCounterType.succeeded, | ||
| source: 'test-shipper', | ||
| event_type: 'test-event', | ||
| code: 'test-code', | ||
| count: 1, | ||
| }); | ||
| expect(usageCollection.reportUiCounter).toHaveBeenCalledTimes(1); | ||
| expect(usageCollection.reportUiCounter).toHaveBeenCalledWith( | ||
| 'ebt_counters.test-shipper', | ||
| 'succeeded_test-code', | ||
| 'test-event', | ||
| 1 | ||
| ); | ||
| }); | ||
| }); |
20 changes: 20 additions & 0 deletions
20
src/plugins/kibana_usage_collection/public/ebt_counters/register_ebt_counters.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,20 @@ | ||
| /* | ||
| * 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 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import type { AnalyticsServiceSetup } from '@kbn/core/public'; | ||
| import type { UsageCollectionSetup } from '@kbn/usage-collection-plugin/public'; | ||
|
|
||
| export function registerEbtCounters( | ||
| analytics: AnalyticsServiceSetup, | ||
| usageCollection: UsageCollectionSetup | ||
| ) { | ||
| // The client should complete telemetryCounter$ when shutting down. We shouldn't need to pipe(takeUntil(stop$)). | ||
| analytics.telemetryCounter$.subscribe(({ type, source, event_type: eventType, code, count }) => { | ||
| usageCollection.reportUiCounter(`ebt_counters.${source}`, `${type}_${code}`, eventType, count); | ||
| }); | ||
| } |
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,13 @@ | ||
| /* | ||
| * 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 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import { KibanaUsageCollectionPlugin } from './plugin'; | ||
|
|
||
| export function plugin() { | ||
| return new KibanaUsageCollectionPlugin(); | ||
| } |
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,25 @@ | ||
| /* | ||
| * 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 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import type { UsageCollectionSetup } from '@kbn/usage-collection-plugin/public'; | ||
| import type { CoreSetup, Plugin } from '@kbn/core/public'; | ||
| import { registerEbtCounters } from './ebt_counters'; | ||
|
|
||
| interface KibanaUsageCollectionPluginsDepsSetup { | ||
| usageCollection: UsageCollectionSetup; | ||
| } | ||
|
|
||
| export class KibanaUsageCollectionPlugin implements Plugin { | ||
| public setup(coreSetup: CoreSetup, { usageCollection }: KibanaUsageCollectionPluginsDepsSetup) { | ||
| registerEbtCounters(coreSetup.analytics, usageCollection); | ||
| } | ||
|
|
||
| public start() {} | ||
|
|
||
| public stop() {} | ||
| } |
14 changes: 14 additions & 0 deletions
14
src/plugins/kibana_usage_collection/server/ebt_counters/README.md
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 @@ | ||
| # Event-based Telemetry Success Counters (server-side) | ||
|
|
||
| Using the Usage Counters API, it reports the stats coming from the `core.analytics.telemetryCounters$` observable. It allows us to track the success of the EBT client on the server side. | ||
|
|
||
| ## Field mappings | ||
|
|
||
| As the number of fields available in the Usage API is reduced, this collection merges some fields to be able to report it. | ||
|
|
||
| | Usage Counter field | Telemetry Counter fields | | ||
| |---------------------|--------------------------------------------------------------------------------------------------| | ||
| | `domainId` | Concatenation of the string `'ebt_counters.'` and the `source` (`'client'` or the shipper name). | | ||
| | `counterName` | Matches the `eventType`. | | ||
| | `counterType` | Concatenation of the `type` and the `code` (i.e.: `'succeeded_200'`). | | ||
| | `total` | Matches the value in `count`. | |
9 changes: 9 additions & 0 deletions
9
src/plugins/kibana_usage_collection/server/ebt_counters/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,9 @@ | ||
| /* | ||
| * 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 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| export { registerEbtCounters } from './register_ebt_counters'; |
76 changes: 76 additions & 0 deletions
76
src/plugins/kibana_usage_collection/server/ebt_counters/register_ebt_counters.test.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,76 @@ | ||
| /* | ||
| * 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 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import type { TelemetryCounter } from '@kbn/analytics-client'; | ||
| import { TelemetryCounterType } from '@kbn/analytics-client'; | ||
| import { coreMock } from '@kbn/core/server/mocks'; | ||
| import { createUsageCollectionSetupMock } from '@kbn/usage-collection-plugin/server/mocks'; | ||
| import { registerEbtCounters } from './register_ebt_counters'; | ||
|
|
||
| describe('registerEbtCounters', () => { | ||
| let core: ReturnType<typeof coreMock.createSetup>; | ||
| let usageCollection: ReturnType<typeof createUsageCollectionSetupMock>; | ||
| let internalListener: (counter: TelemetryCounter) => void; | ||
| let telemetryCounter$Spy: jest.SpyInstance; | ||
|
|
||
| beforeEach(() => { | ||
| core = coreMock.createSetup(); | ||
| usageCollection = createUsageCollectionSetupMock(); | ||
| telemetryCounter$Spy = jest | ||
| .spyOn(core.analytics.telemetryCounter$, 'subscribe') | ||
| .mockImplementation(((listener) => { | ||
| internalListener = listener as (counter: TelemetryCounter) => void; | ||
| }) as typeof core.analytics.telemetryCounter$['subscribe']); | ||
| }); | ||
|
|
||
| test('it subscribes to `analytics.telemetryCounters$`', () => { | ||
| registerEbtCounters(core.analytics, usageCollection); | ||
| expect(telemetryCounter$Spy).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| test('it creates a new usageCounter when it does not exist', () => { | ||
| registerEbtCounters(core.analytics, usageCollection); | ||
| expect(telemetryCounter$Spy).toHaveBeenCalledTimes(1); | ||
| internalListener({ | ||
| type: TelemetryCounterType.succeeded, | ||
| source: 'test-shipper', | ||
| event_type: 'test-event', | ||
| code: 'test-code', | ||
| count: 1, | ||
| }); | ||
| expect(usageCollection.getUsageCounterByType).toHaveBeenCalledTimes(1); | ||
| expect(usageCollection.getUsageCounterByType).toHaveBeenCalledWith('ebt_counters.test-shipper'); | ||
| expect(usageCollection.createUsageCounter).toHaveBeenCalledTimes(1); | ||
| expect(usageCollection.createUsageCounter).toHaveBeenCalledWith('ebt_counters.test-shipper'); | ||
| }); | ||
|
|
||
| test('it reuses the usageCounter when it already exists', () => { | ||
| const incrementCounterMock = jest.fn(); | ||
| usageCollection.getUsageCounterByType.mockReturnValue({ | ||
| incrementCounter: incrementCounterMock, | ||
| }); | ||
| registerEbtCounters(core.analytics, usageCollection); | ||
| expect(telemetryCounter$Spy).toHaveBeenCalledTimes(1); | ||
| internalListener({ | ||
| type: TelemetryCounterType.succeeded, | ||
| source: 'test-shipper', | ||
| event_type: 'test-event', | ||
| code: 'test-code', | ||
| count: 1, | ||
| }); | ||
| expect(usageCollection.getUsageCounterByType).toHaveBeenCalledTimes(1); | ||
| expect(usageCollection.getUsageCounterByType).toHaveBeenCalledWith('ebt_counters.test-shipper'); | ||
| expect(usageCollection.createUsageCounter).toHaveBeenCalledTimes(0); | ||
| expect(incrementCounterMock).toHaveBeenCalledTimes(1); | ||
| expect(incrementCounterMock).toHaveBeenCalledWith({ | ||
| counterName: 'test-event', | ||
| counterType: `succeeded_test-code`, | ||
| incrementBy: 1, | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.