af228f0f20
## Summary Phase 1 of a multi-phase cautious approach for adding an experimental application cache for Kibana solutions called `metric_entities` and integrates it within Security Solutions. Phase 1 is putting experimental support into the application without breaking existing features. Lots of TODO's, conversations and a possible RFC from phase 1 to phase 2 approach. Some features are missing, but for phase 1 the general idea and code is all there. To enable this first phase after checking out the branch add this to your `kibana.dev.yml` ```yml xpack.metricsEntities.enabled: true xpack.securitySolution.enableExperimental: ['metricsEntitiesEnabled'] ``` Then go into Stack Management -> Advanced Settings (Under Security Solutions) and set the enabled to true like so: <img width="1229" alt="Screen Shot 2021-04-08 at 2 21 02 PM" src="https://user-images.githubusercontent.com/1151048/114091276-b3cbb700-9875-11eb-9083-5c1d91dd20ed.png"> Next go to the security_solutions page and you will see it being activated and you will have these transforms running if you look under stack management: <img width="1710" alt="Screen Shot 2021-04-29 at 2 00 27 PM" src="https://user-images.githubusercontent.com/1151048/116611174-4a2e4e00-a8f3-11eb-9e15-55cb504dfb2a.png"> On the hosts page, network, page, etc... You can see them being activated when you have no query/filter and you click on request: <img width="1405" alt="Screen Shot 2021-04-29 at 2 01 28 PM" src="https://user-images.githubusercontent.com/1151048/116611274-6a5e0d00-a8f3-11eb-9998-9f5b3d1c5c63.png"> You will see in the request the index patterns all starting with `estc_xyz*` ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/master/packages/kbn-i18n/README.md) We have lots of TODO's but no concrete docs with this just yet. - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials Behind a feature flag and this isn't there yet. - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios
151 lines
3.6 KiB
JSON
151 lines
3.6 KiB
JSON
{
|
|
"id": "metricsEntities",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-server.MetricsEntitiesPluginSetup",
|
|
"type": "Interface",
|
|
"label": "MetricsEntitiesPluginSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.MetricsEntitiesPluginSetup.getMetricsEntitiesClient",
|
|
"type": "Function",
|
|
"label": "getMetricsEntitiesClient",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/metrics_entities/server/types.ts",
|
|
"lineNumber": 15
|
|
},
|
|
"signature": [
|
|
"GetMetricsEntitiesClientType"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/metrics_entities/server/types.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-server.MetricsEntitiesPluginStart",
|
|
"type": "Type",
|
|
"label": "MetricsEntitiesPluginStart",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/metrics_entities/server/types.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"signature": [
|
|
"void"
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.ELASTIC_NAME",
|
|
"type": "string",
|
|
"label": "ELASTIC_NAME",
|
|
"description": [
|
|
"\nGlobal prefix for all the transform jobs"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/metrics_entities/common/constants.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"signature": [
|
|
"\"estc\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.METRICS_ENTITIES_TRANSFORMS",
|
|
"type": "string",
|
|
"label": "METRICS_ENTITIES_TRANSFORMS",
|
|
"description": [
|
|
"\nTransforms route"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/metrics_entities/common/constants.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.METRICS_ENTITIES_URL",
|
|
"type": "string",
|
|
"label": "METRICS_ENTITIES_URL",
|
|
"description": [
|
|
"\nBase route"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/metrics_entities/common/constants.ts",
|
|
"lineNumber": 11
|
|
},
|
|
"signature": [
|
|
"\"/api/metrics_entities\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.PLUGIN_ID",
|
|
"type": "string",
|
|
"label": "PLUGIN_ID",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/metrics_entities/common/index.ts",
|
|
"lineNumber": 8
|
|
},
|
|
"signature": [
|
|
"\"metricsEntities\""
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.PLUGIN_NAME",
|
|
"type": "string",
|
|
"label": "PLUGIN_NAME",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/metrics_entities/common/index.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"signature": [
|
|
"\"metrics_entities\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |