* bump to a pre-8.0 version * export KibanaClient from /lib sub-folder * workaround the problem of the absence of estypes * update es client usage in pacakges * export estypes from another path * import errors from root * import errors from root 2 * update transport import * update import path for /api/types * update import path for /api/types * import errors from top export * use TransportResult instead if ApiResponse * fix errors in client_config * fix src/core/server/saved_objects/migrationsv2/actions/integration_tests/actions.test.ts * use KibanaClient in mock. we dont export the original Client * fix client mocks * fix errors on SO * fix remaining core errors * update estype import path * fix errors in data plugin * fix data_views * fix es_ui_shared * fix errors in interactive_setup * fix errors in ./test folder * add @elastic/transport to the runtime deps * fix errors in packages * fix erros in src/core * fix errors in test/ * fix an error in actions plugin * woraround and fix errors in APM plugin * fix errors in canvas * fix errors in event_log * fix errors in fleet * fix errors in ILM * fix errors in infra * fix errors in ingest_pipeline * fix errors in lens * fix errors in license_management * fix errors in licensing * fix errors in logstash * fix errors in ml * fix errors in monitoring * fix errors in observability * fix errors in rule_registry * fix errors in reporting * fix errors in rule_registry * fix errors in security * fix errors in security_solution * fix errors in snapshot_restore * fix errors in transform * fix errors in UA * fix errors in uptime * fix errors in x-pack/test * fix eslint errors * fix new errors * use default HTTP Connection. Undici does not support agent config options keepAlive and maxSockets * create does not accept require_alias option * update deps * use transport types exported from ES client package * fix ErrorCause | string errors * do not use enum * fix errors in data plugin * update x-pack code * fix transport * fix apm search request * do not crash on reporting * fix kbn-test build * mute reporting error to start * fix ftr build * another attempt * update import path * address or mute new errors * REMOVE me. pin transport version temporarily. * remove deep imports from transport package * fix jest crash * fix product check tests * remove unnecessary ts-expect-error * fix a few failed unit tests * bump to canary 24 * remove unnecessary ts-expect-error * remove dependency on transport * fix types in tests * mute errors in xpack tests * product check doesn;t spam in logs anymore * filterPath --> filter_path * ignoreUnavailable --> ignore_unavailable * ignoreUnavailable --> ignore_unavailable * trackScores --> track_scores * trackTotalHits --> track_total_hits * fix es-arcives * fix data plugin crashes * fix watcher test utils * rollback unnecessary changes * fix another problem in es-archiver * fix scroll. for whatever reason scroll fails when request scroll_id in body * add meta: true in kbn-securitysolution-es-utils * bump client to canary 25 * fix errors in accordance with the es client spec * update securityscolution-es-utils * unify scroll api in reporting and fix tests * fix unit tests in watcher * refactor APM to abort request with AbortController API * fix missing es client calls in tests * fix missing meta in detection engine FTR tests * fix another bunch of errors in js tests * fix wrong coercion * remove test-grep pattern * fix apm unit test * rename terminateAfter to terminate_after in infra plugin * rename terminateAfter to terminate_after in uptime plugin * rename terminateAfter to terminate_after in apm plugin * fix security roles FTR tests * fix reference * fix post_privilidges test * fix post_privilidges * bump client to 26 * add meta for index_management test helpers * remove ts-expect-error caused by bad type in reason * bump client to 27 * REMOVE me. workaround until fixed in the es client * fix incorrect type casting * swtich from camelCase params * use `HttpConnection` for FTR-related clients * bump client to 29 * Revert "REMOVE me. workaround until fixed in the es client" This reverts commit |
||
---|---|---|
.. | ||
__mocks__ | ||
common | ||
public | ||
server | ||
.gitignore | ||
jest.config.js | ||
kibana.json | ||
package.json | ||
readme.md | ||
shared_imports.ts | ||
tsconfig.json |
Documentation for ML UI developers
This plugin provides access to the machine learning features provided by Elastic.
Requirements
To use machine learning features, you must have a Platinum or Enterprise license or a free 14-day Trial. File Data Visualizer requires a Basic license. For more info, refer to Set up machine learning features.
Setup local environment
Kibana
-
Fork and clone the Kibana repo.
-
Install
nvm
,node
,yarn
(for example, by using Homebrew). See Install dependencies. -
Make sure that Elasticsearch is deployed and running on localhost:9200.
-
Navigate to the directory of the
kibana
repository on your machine. -
Fetch the latest changes from the repository.
-
Checkout the branch of the version you want to use. For example, if you want to use a 7.9 version, run
git checkout 7.9
. -
Run
nvm use
. The response shows the Node version that the environment uses. If you need to update your Node version, the response message contains the command you need to run to do it. -
Run
yarn kbn bootstrap
. It takes all the dependencies in the code and installs/checks them. It is recommended to use it every time when you switch between branches. -
Make a copy of
kibana.yml
and save askibana.dev.yml
. (Git will not track the changes inkibana.dev.yml
but yarn will use it.) -
Provide the appropriate password and user name in
kibana.dev.yml
. -
Run
yarn start
to start Kibana. -
Go to http://localhost:560x/xxx (check the terminal message for the exact path).
For more details, refer to this getting started page.
Adding sample data to Kibana
Kibana has sample data sets that you can add to your setup so that you can test different configurations on sample data.
-
Click the Elastic logo in the upper left hand corner of your browser to navigate to the Kibana home page.
-
Click Load a data set and a Kibana dashboard.
-
Pick a data set or feel free to click Add on all of the available sample data sets.
These data sets are now ready be analyzed in ML jobs in Kibana.
Running tests
Jest tests
Documentation: https://www.elastic.co/guide/en/kibana/current/development-tests.html#_unit_testing
Run the test following jest tests from kibana/x-pack/plugins/ml
.
New snapshots, all plugins:
yarn test:jest
Update snapshots for the ML plugin:
yarn test:jest -u
Update snapshots for a specific directory only:
yarn test:jest public/application/settings/filter_lists
Run tests with verbose output:
yarn test:jest --verbose
Functional tests
Before running the test server, make sure to quit all other instances of Elasticsearch.
Run the following commands from the x-pack
directory and use separate terminals
for test server and test runner. The test server command starts an Elasticsearch
and Kibana instance that the tests will be run against.
-
Functional UI tests with
Trial
license (default config):node scripts/functional_tests_server.js node scripts/functional_test_runner.js --include-tag mlqa
ML functional
Trial
license tests are located inx-pack/test/functional/apps/ml
. -
Functional UI tests with
Basic
license:node scripts/functional_tests_server.js --config test/functional_basic/config.ts node scripts/functional_test_runner.js --config test/functional_basic/config.ts --include-tag mlqa
ML functional
Basic
license tests are located inx-pack/test/functional_basic/apps/ml
. -
API integration tests with
Trial
license:node scripts/functional_tests_server.js node scripts/functional_test_runner.js --config test/api_integration/config.ts --include-tag mlqa
ML API integration
Trial
license tests are located inx-pack/test/api_integration/apis/ml
. -
API integration tests with
Basic
license:node scripts/functional_tests_server.js --config test/api_integration_basic/config.ts node scripts/functional_test_runner.js --config test/api_integration_basic/config.ts --include-tag mlqa
ML API integration
Basic
license tests are located inx-pack/test/api_integration_basic/apis/ml
. -
Accessibility tests:
We maintain a suite of accessibility tests (you may see them referred to elsewhere as
a11y
tests). These tests render each of our pages and ensure that the inputs and other elements contain the attributes necessary to ensure all users are able to make use of ML (for example, users relying on screen readers).node scripts/functional_tests_server --config test/accessibility/config.ts node scripts/functional_test_runner.js --config test/accessibility/config.ts --grep=ml
ML accessibility tests are located in
x-pack/test/accessibility/apps
.
Shared functions
You can find the ML shared functions in the following files in GitHub:
https://github.com/elastic/kibana/blob/master/x-pack/plugins/ml/public/shared.ts
https://github.com/elastic/kibana/blob/master/x-pack/plugins/ml/server/shared.ts
These functions are shared from the root of the ML plugin, you can import them with an import statement. For example:
import { MlPluginSetup } from '../../../../ml/server';
or
import { ANOMALY_SEVERITY } from '../../ml/common';
Functions are shared from the following directories:
ml/common
ml/public
ml/server