* 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 |
||
---|---|---|
.. | ||
.storybook | ||
common | ||
docs | ||
public | ||
scripts | ||
server | ||
types | ||
jest.config.js | ||
kibana.json | ||
README.md | ||
tsconfig.json |
The infra
plugin
This is the home of the infra
plugin, which aims to provide a solution for
the infrastructure monitoring use-case within Kibana.
UI Structure
The plugin provides two main apps in Kibana - the Metrics UI and the Logs UI. Both are reachable via their own main navigation items and via links from other parts of Kibana.
The Metrics UI consists of three main screens, which are the Inventory, the Node details and the Metrics explorer.
The Logs UI provides one log viewer screen.
Communicating
In order to address the whole infrastructure monitoring team, the @elastic/infra-logs-ui team alias can be used as a mention or in review requests.
The Infrastructure forum and Logs forum on Discuss are frequented by the team as well.
Contributing
Since the infra
plugin lives within the Kibana repository, Kibana's
contribution procedures apply. In addition to that,
this section details a few plugin-specific aspects.
Ingesting metrics for development
The Metrics UI displays ECS-compatible metric data from indices
matching the metricbeat-*
pattern by default. The primary way to ingest these
is by running Metricbeat to deliver metrics to the development Elasticsearch
cluster. It can be used to ingest development host metrics using the system
module.
A setup that ingests docker and nginx metrics is described in [./docs/test_setups/infra_metricbeat_docker_nginx.md].
Ingesting logs for development
Similarly, the Logs UI assumes ECS-compatible log data to be present in
indices matching the filebeat-*
pattern. At the time of writing the minimum
required fields are @timestamp
and message
, but the presence of other ECS
fields enable additional functionality such as linking to and from other
solutions.
The primary way to ingest such log data is via Filebeat. A convenient source of log entries are the Kibana and Elasticsearch log files produced by the development environment itself. These can easily be consumed by enabling the modules
$ filebeat modules enable elasticsearch
$ filebeat modules enable kibana
and then editing the modules.d/elasticsearch.yml
and modules.d/kibana.yml
to change the var.paths
settings to contain paths to the development
environment's log files, e.g.:
- module: elasticsearch
server:
enabled: true
var.paths:
- "${WORK_ENVIRONMENT}/kibana/.es/8.0.0/logs/elasticsearch_server.json"
var.convert_timezone: true
Creating PRs
As with all of Kibana, we welcome contributions from everyone. The usual life-cycle of a PR looks like the following:
- Create draft PR: To make ongoing work visible, we recommend creating
draft PRs as soon as possible. PRs are usually targetted at
master
and backported later. The checklist in the PR description template can be used to guide the progress of the PR. - Label the PR: To ensure that a newly created PR gets the attention of
the @elastic/logs-metrics-ui team, the following label should be applied to
PRs:
Team:logs-metrics-ui
Feature:Metrics UI
if it relates to the Metrics UIFeature:Logs UI
if it relates to the Logs UI- Version labels for merge and backport targets (see Kibana's contribution
procedures), usually:
- the version that
master
currently represents - the version of the next minor release
- the version that
- Release note labels (see Kibana's contribution procedures)
release_note:enhancement
if the PR contains a new feature or enhancementrelease_note:fix
if the PR contains an external-facing fixrelease_note:breaking
if the PR contains a breaking changerelease_note:deprecation
if the PR contains deprecations of publicly documented features.release_note:skip
if the PR contains only house-keeping changes, fixes to unreleased code or documentation changes
- Satisfy CI: The PR will automatically be picked up by the CI system,
which will run the full test suite as well as some additional checks. A
comment containing
@elasticmachine merge upstream
orretest
can be used to manually trigger a CI run. The result will be reported on the PR itself. Out of courtesy for the reviewers the checks should pass before requesting reviews. - Request reviews: Once the PR is ready for reviews it can be marked as
such by changing the PR state to ready. If the
GitHub automation doesn't automatically request a review from
@elastic/logs-metrics-ui
it should be requested manually. - Incorporate review feedback: Usually one reviewer's approval is sufficient. Particularly complicated or cross-cutting concerns might warrant multiple reviewers.
- Merge: Once CI is green and the reviewers are approve, PRs in the Kibana
repo are "squash-merged" to
master
to keep the history clean. - Backport: After merging to
master
, the PR is backported to the branches that represent the versions indicated by the labels. Theyarn backport
command can be used to automate most of the process.
There are always exceptions to the rule, so seeking guidance about any of the steps is highly recommended.