* ES client : use the new type definitions (#83808) * Use client from branch * Get type checking working in core * Fix types in other plugins * Update client types + remove type errors from core * migrate Task Manager Elasticsearch typing from legacy library to client library * use SortOrder instead o string in alerts * Update client types + fix core type issues * fix maps ts errors * Update Lens types * Convert Search Profiler body from a string to an object to conform to SearchRequest type. * Fix SOT types * Fix/mute Security/Spaces plugins type errors. * Fix bootstrap types * Fix painless_lab * corrected es typing in Event Log * Use new types from client for inferred search responses * Latest type defs * Integrate latest type defs for APM/UX * fix core errors * fix telemetry errors * fix canvas errors * fix data_enhanced errors * fix event_log errors * mute lens errors * fix or mute maps errors * fix reporting errors * fix security errors * mute errors in task_manager * fix errors in telemetry_collection_xpack * fix errors in data plugins * fix errors in alerts * mute errors in index_management * fix task_manager errors * mute or fix lens errors * fix upgrade_assistant errors * fix or mute errors in index_lifecycle_management * fix discover errors * fix core tests * ML changes * fix core type errors * mute error in kbn-es-archiver * fix error in data plugin * fix error in telemetry plugin * fix error in discover * fix discover errors * fix errors in task_manager * fix security errors * fix wrong conflict resolution * address errors with upstream code * update deps to the last commit * remove outdated comments * fix core errors * fix errors after update * adding more expect errors to ML * pull the lastest changes * fix core errors * fix errors in infra plugin * fix errors in uptime plugin * fix errors in ml * fix errors in xpack telemetry * fix or mute errors in transform * fix errors in upgrade assistant * fix or mute fleet errors * start fixing apm errors * fix errors in osquery * fix telemetry tests * core cleanup * fix asMutableArray imports * cleanup * data_enhanced cleanup * cleanup events_log * cleaup * fix error in kbn-es-archiver * fix errors in kbn-es-archiver * fix errors in kbn-es-archiver * fix ES typings for Hit * fix SO * fix actions plugin * fix fleet * fix maps * fix stack_alerts * fix eslint problems * fix event_log unit tests * fix failures in data_enhanced tests * fix test failure in kbn-es-archiver * fix test failures in index_pattern_management * fixing ML test * remove outdated comment in kbn-es-archiver * fix error type in ml * fix eslint errors in osquery plugin * fix runtime error in infra plugin * revert changes to event_log cluser exist check * fix eslint error in osquery * fixing ML endpoint argument types * fx types * Update api-extractor docs * attempt fix for ese test * Fix lint error * Fix types for ts refs * Fix data_enhanced unit test * fix lens types * generate docs * Fix a number of type issues in monitoring and ml * fix triggers_actions_ui * Fix ILM functional test * Put search.d.ts typings back * fix data plugin * Update typings in typings/elasticsearch * Update snapshots * mute errors in task_manager * mute fleet errors * lens. remove unnecessary ts-expect-errors * fix errors in stack_alerts * mute errors in osquery * fix errors in security_solution * fix errors in lists * fix errors in cases * mute errors in search_examples * use KibanaClient to enforce promise-based API * fix errors in test/ folder * update comment * fix errors in x-pack/test folder * fix errors in ml plugin * fix optional fields in ml api_integartoon tests * fix another casting problem in ml tests * fix another ml test failure * fix fleet problem after conflict resolution * rollback changes in security_solution. trying to fix test * Update type for discover rows * uncomment runtime_mappings as its outdated * address comments from Wylie * remove eslint error due to any * mute error due to incompatibility * Apply suggestions from code review Co-authored-by: John Schulz <github.com@jfsiii.org> * fix type error in lens tests * Update x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.ts Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com> * Update x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com> * update deps * fix errors in core types * fix errors for the new elastic/elasticsearch version * remove unused type * remove unnecessary manual type cast and put optional chaining back * ML: mute Datafeed is missing indices_options * Apply suggestions from code review Co-authored-by: Josh Dover <1813008+joshdover@users.noreply.github.com> * use canary pacakge instead of git commit Co-authored-by: Josh Dover <me@joshdover.com> Co-authored-by: Josh Dover <1813008+joshdover@users.noreply.github.com> Co-authored-by: Gidi Meir Morris <github@gidi.io> Co-authored-by: Nathan Reese <reese.nathan@gmail.com> Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> Co-authored-by: CJ Cenizal <cj@cenizal.com> Co-authored-by: Aleh Zasypkin <aleh.zasypkin@gmail.com> Co-authored-by: Dario Gieselaar <dario.gieselaar@elastic.co> Co-authored-by: restrry <restrry@gmail.com> Co-authored-by: James Gowdy <jgowdy@elastic.co> Co-authored-by: John Schulz <github.com@jfsiii.org> Co-authored-by: Alison Goryachev <alisonmllr20@gmail.com> # Conflicts: # package.json # src/core/server/saved_objects/migrationsv2/integration_tests/migration.test.ts # src/plugins/data/server/autocomplete/value_suggestions_route.ts # src/plugins/discover/public/application/angular/doc_table/create_doc_table_react.tsx # x-pack/plugins/apm/server/lib/services/get_service_dependencies/get_destination_map.ts # x-pack/plugins/infra/server/lib/alerting/inventory_metric_threshold/evaluate_condition.ts # x-pack/plugins/security/server/authentication/api_keys/api_keys.ts # yarn.lock * fix file broken during conflict resolution * fix lint errors and test failure Co-authored-by: Tomas Della Vedova <delvedor@users.noreply.github.com> |
||
---|---|---|
.. | ||
.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/infra-logs-ui team, the following label should be applied to
PRs:
Team:infra-logs-ui
Feature:Infra UI
if it relates to the Intrastructure UIFeature:Logs UI
if it relates to the Logs UI[zube]: In Progress
to track the stage of the PR- 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
jenkins, test this
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. In addition the label
[zube]: In Progress
should be replaced with[zube]: In Review
andreview
. If the GitHub automation doesn't automatically request a review from@elastic/infra-logs-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.