History

Frank Hassanabad af228f0f20 [Security Solutions] (Phase 1) Adds an application cache called metrics entities and integrates it within Security Solutions behind a feature flag (#96446 ) ## 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		2021-04-30 12:36:06 -06:00
..
src	[Security Solutions] (Phase 1) Adds an application cache called metrics entities and integrates it within Security Solutions behind a feature flag (#96446 )	2021-04-30 12:36:06 -06:00
jest.config.js
package.json	chore(NA): moving @kbn/dev-utils into bazel (#98496 )	2021-04-28 23:46:33 +01:00
README.md
tsconfig.json	chore(NA): enable preserve symlinks for ts without breaking packages development (#95433 )	2021-03-31 00:02:22 +01:00

README.md

`CliDevMode`

A class that manages the alternate behavior of the Kibana cli when using the --dev flag. This mode provides several useful features in a single CLI for a nice developer experience:

automatic server restarts when code changes
runs the @kbn/optimizer to build browser bundles
runs a base path proxy which helps developers test that they are writing code which is compatible with custom basePath settings while they work
pauses requests when the server or optimizer are not ready to handle requests so that when users load Kibana in the browser it's always using the code as it exists on disk

To accomplish this, and to make it easier to test, the CliDevMode class manages several objects:

`Watcher`

The Watcher manages a chokidar instance to watch the server files, logs about file changes observed and provides an observable to the DevServer via its serverShouldRestart$() method.

`DevServer`

The DevServer object is responsible for everything related to running and restarting the Kibana server process:

listens to restart notifications from the Watcher object, sending SIGKILL to the existing server and launching a new instance with the current code
writes the stdout/stderr logs from the Kibana server to the parent process
gracefully kills the process if the SIGINT signal is sent
kills the server if the SIGTERM signal is sent, process.exit() is used, a second SIGINT is sent, or the gracefull shutdown times out
proxies SIGHUP notifications to the child process, though the core team is working on migrating this functionality to the KP and making this unnecessary

`Optimizer`

The Optimizer object manages a @kbn/optimizer instance, adapting its configuration and logging to the data available to the CLI.

`BasePathProxyServer`

This proxy injects a random three character base path in the URL that Kibana is served from to help ensure that Kibana features are written to adapt to custom base path configurations from users.

The basePathProxy also has another important job, ensuring that requests don't fail because the server is restarting and that the browser receives front-end assets containing all saved changes. We accomplish this by observing the ready state of the Optimizer and DevServer objects and pausing all requests through the proxy until both objects report that they aren't building/restarting based on recently saved changes.