forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into alerting/consumer-based-rbac
* master: [Lens] Fitting functions (elastic#69820) [Telemetry] Add documentation about Application Usage (elastic#70624) [Ingest Manager] Improve agent unenrollment with unenroll action (elastic#70031) Handle timeouts on creating templates (elastic#70635) [Lens] Add ability to set colors for y-axis series (elastic#70311) [Uptime] Use elastic charts donut (elastic#70364) [Ingest Manager] Update registry URL to point to snapshot registry (elastic#70687) [Composable template] Create / Edit wizard (elastic#70220) [APM] Optimize services overview (elastic#69648)
- Loading branch information
Showing
119 changed files
with
3,963 additions
and
733 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
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
37 changes: 37 additions & 0 deletions
37
src/plugins/kibana_usage_collection/server/collectors/application_usage/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,37 @@ | ||
# Application Usage | ||
|
||
This collector reports the number of general clicks and minutes on screen for each registered application in Kibana. | ||
|
||
The final payload matches the following contract: | ||
|
||
```JSON | ||
{ | ||
"application_usage": { | ||
"application_ID": { | ||
"clicks_7_days": 10, | ||
"clicks_30_days": 100, | ||
"clicks_90_days": 300, | ||
"clicks_total": 600, | ||
"minutes_on_screen_7_days": 10.40, | ||
"minutes_on_screen_30_days": 20.0, | ||
"minutes_on_screen_90_days": 110.1, | ||
"minutes_on_screen_total": 112.5 | ||
} | ||
} | ||
} | ||
``` | ||
|
||
Where `application_ID` matches the `id` registered when calling the method `core.application.register`. | ||
This collection occurs by default for every application registered via the mentioned method and there is no need to do anything else to enable it or _opt-in_ for your plugin. | ||
|
||
**Note to maintainers in the Kibana repo:** At the moment of writing, the `usageCollector.schema` is not updated automatically ([#70622](https://github.com/elastic/kibana/issues/70622)) so, if you are adding a new app to Kibana, you'll need to give the Kibana Telemetry team a heads up to update the mappings in the Telemetry Cluster accordingly. | ||
|
||
## Developer notes | ||
|
||
In order to keep the count of the events, this collector uses 2 Saved Objects: | ||
|
||
1. `application_usage_transactional`: It stores each individually reported event (up to 90 days old). Grouped by `timestamp` and `appId`. | ||
2. `application_usage_totals`: It stores the sum of all the events older than 90 days old per `appId`. | ||
|
||
Both of them use the shared fields `appId: 'keyword'`, `numberOfClicks: 'long'` and `minutesOnScreen: 'float'`. `application_usage_transactional` also stores `timestamp: { type: 'date' }`. | ||
but they are currently not added in the mappings because we don't use them for search purposes, and we need to be thoughtful with the number of mapped fields in the SavedObjects index ([#43673](https://github.com/elastic/kibana/issues/43673)). |
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
x-pack/plugins/apm/common/utils/array_union_to_callable.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; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
import { ValuesType } from 'utility-types'; | ||
|
||
// work around a TypeScript limitation described in https://stackoverflow.com/posts/49511416 | ||
|
||
export const arrayUnionToCallable = <T extends any[]>( | ||
array: T | ||
): Array<ValuesType<T>> => { | ||
return array; | ||
}; |
104 changes: 104 additions & 0 deletions
104
x-pack/plugins/apm/common/utils/join_by_key/index.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,104 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
import { joinByKey } from './'; | ||
|
||
describe('joinByKey', () => { | ||
it('joins by a string key', () => { | ||
const joined = joinByKey( | ||
[ | ||
{ | ||
serviceName: 'opbeans-node', | ||
avg: 10, | ||
}, | ||
{ | ||
serviceName: 'opbeans-node', | ||
count: 12, | ||
}, | ||
{ | ||
serviceName: 'opbeans-java', | ||
avg: 11, | ||
}, | ||
{ | ||
serviceName: 'opbeans-java', | ||
p95: 18, | ||
}, | ||
], | ||
'serviceName' | ||
); | ||
|
||
expect(joined.length).toBe(2); | ||
|
||
expect(joined).toEqual([ | ||
{ | ||
serviceName: 'opbeans-node', | ||
avg: 10, | ||
count: 12, | ||
}, | ||
{ | ||
serviceName: 'opbeans-java', | ||
avg: 11, | ||
p95: 18, | ||
}, | ||
]); | ||
}); | ||
|
||
it('joins by a record key', () => { | ||
const joined = joinByKey( | ||
[ | ||
{ | ||
key: { | ||
serviceName: 'opbeans-node', | ||
transactionName: '/api/opbeans-node', | ||
}, | ||
avg: 10, | ||
}, | ||
{ | ||
key: { | ||
serviceName: 'opbeans-node', | ||
transactionName: '/api/opbeans-node', | ||
}, | ||
count: 12, | ||
}, | ||
{ | ||
key: { | ||
serviceName: 'opbeans-java', | ||
transactionName: '/api/opbeans-java', | ||
}, | ||
avg: 11, | ||
}, | ||
{ | ||
key: { | ||
serviceName: 'opbeans-java', | ||
transactionName: '/api/opbeans-java', | ||
}, | ||
p95: 18, | ||
}, | ||
], | ||
'key' | ||
); | ||
|
||
expect(joined.length).toBe(2); | ||
|
||
expect(joined).toEqual([ | ||
{ | ||
key: { | ||
serviceName: 'opbeans-node', | ||
transactionName: '/api/opbeans-node', | ||
}, | ||
avg: 10, | ||
count: 12, | ||
}, | ||
{ | ||
key: { | ||
serviceName: 'opbeans-java', | ||
transactionName: '/api/opbeans-java', | ||
}, | ||
avg: 11, | ||
p95: 18, | ||
}, | ||
]); | ||
}); | ||
}); |
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,48 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
import { UnionToIntersection, ValuesType } from 'utility-types'; | ||
import { isEqual } from 'lodash'; | ||
|
||
/** | ||
* Joins a list of records by a given key. Key can be any type of value, from | ||
* strings to plain objects, as long as it is present in all records. `isEqual` | ||
* is used for comparing keys. | ||
* | ||
* UnionToIntersection is needed to get all keys of union types, see below for | ||
* example. | ||
* | ||
const agentNames = [{ serviceName: '', agentName: '' }]; | ||
const transactionRates = [{ serviceName: '', transactionsPerMinute: 1 }]; | ||
const flattened = joinByKey( | ||
[...agentNames, ...transactionRates], | ||
'serviceName' | ||
); | ||
*/ | ||
|
||
type JoinedReturnType< | ||
T extends Record<string, any>, | ||
U extends UnionToIntersection<T>, | ||
V extends keyof T & keyof U | ||
> = Array<Partial<U> & Record<V, U[V]>>; | ||
|
||
export function joinByKey< | ||
T extends Record<string, any>, | ||
U extends UnionToIntersection<T>, | ||
V extends keyof T & keyof U | ||
>(items: T[], key: V): JoinedReturnType<T, U, V> { | ||
return items.reduce<JoinedReturnType<T, U, V>>((prev, current) => { | ||
let item = prev.find((prevItem) => isEqual(prevItem[key], current[key])); | ||
|
||
if (!item) { | ||
item = { ...current } as ValuesType<JoinedReturnType<T, U, V>>; | ||
prev.push(item); | ||
} else { | ||
Object.assign(item, current); | ||
} | ||
|
||
return prev; | ||
}, []); | ||
} |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.