Your window into the Elastic Stack
Find a file
Pierre Gayvallet ea7c78d10e
Restructure SavedObject types internal representation (#56378)
* adapt types and tests to prepare for new NP api

* rename and export public types

* update generated doc

* first implementation of registerMappings

* adapt es archiver to convert legacy mappings

* update generated doc

* fix more tests

* add unit tests

* add legacy-compat unit test

* add documentation and examples

* Introduce SavedObjectTypeRegistry and SavedObjectType types

* add and fix tests

* expose createSerializer API and fix usages

* remove registerMappings API, add internal registerType

* revert changes to migration guide

* adapt ES-archiver migrator creation

* export serializer-related types

* update generated doc

* add and use convertTypesToLegacySchema

* remove / move to internal some mapping types

* fix forEach closure context

* add missing docs

* fix core path

* some nits

* fix so_mixin tests

* fix integration tests

* fix integration tests for real

* add documentation on serializer + restructure files and types

* nit

* add and use the ISavedObjectTypeRegistry interface

* Add documentation, deprecates migrationLogger#warning

* better typing for SavedObjectsRawDoc._source

* nits

* update generated doc

* remove exposition of SavedObjectsTypeMappingDefinitions, update doc

* creates so internal contracts mocks

* improve documentation
2020-02-06 10:30:55 +01:00
.ci Code coverage: run functional tests from repo copy (#55195) 2020-01-29 14:36:47 +01:00
.github Improve pull request template proposal (#56756) 2020-02-04 22:07:37 -06:00
bin Update node options Initialization on our scripts (#40302) 2019-08-15 16:09:22 +01:00
common/graphql [Uptime] Implement EuiSuperDatePicker (#28217) 2019-01-18 13:44:58 -05:00
config Instrument Kibana with APM RUM agent (#44281) 2019-12-18 12:16:15 +01:00
data [folder structure] plugins/.data -> data 2016-07-05 14:06:16 -05:00
docs Restructure SavedObject types internal representation (#56378) 2020-02-06 10:30:55 +01:00
examples bfetch (2) (#53711) 2020-01-16 05:33:52 -08:00
licenses Migrate x-pack-kibana source to kibana 2018-04-24 13:48:10 -07:00
packages Updating tree-kill to 1.2.2 (#55889) 2020-02-05 13:53:01 -08:00
rfcs Advanced settings component registry ⇒ kibana platform plugin (#55940) 2020-02-04 13:38:18 -06:00
scripts Add lockfile symlinks (#55440) 2020-01-27 11:38:20 -05:00
src Restructure SavedObject types internal representation (#56378) 2020-02-06 10:30:55 +01:00
style_guides Updating accessibility guide and contributing readmes (#52038) 2019-12-04 19:11:16 -06:00
tasks Add lockfile symlinks (#55440) 2020-01-27 11:38:20 -05:00
test Restructure SavedObject types internal representation (#56378) 2020-02-06 10:30:55 +01:00
typings [State Management] State syncing utilities (#53582) 2020-01-10 17:14:33 +03:00
utilities remove use of experimental fs.promises api (#53346) 2019-12-25 06:27:21 -07:00
vars Fix Github PR comment formatting (#56078) 2020-01-27 20:45:24 -05:00
webpackShims [kbn/ui-shared-deps] include polyfills, required by some deps (#54667) 2020-01-14 11:35:35 -07:00
x-pack Restructure SavedObject types internal representation (#56378) 2020-02-06 10:30:55 +01:00
.backportrc.json add 7.6 branch to backportrc (#54975) 2020-01-15 18:21:39 -05:00
.browserslistrc [autoprefixer] upgrade to 9.6.1, unify browserslist handling (#41038) 2019-07-15 09:33:33 -07:00
.editorconfig [editorconfig] disable insert_final_newline for package.json 2019-04-18 09:44:17 -07:00
.eslintignore Generate a static parser, move tests to vis_type_timelion (#55299) 2020-01-21 17:38:28 +03:00
.eslintrc.js [SIEM] Add eslint-plugin-react-perf (#55960) 2020-02-04 11:22:40 +01:00
.gitattributes [canvas] Color fixes + Storybook 5 (#34075) 2019-04-02 11:21:51 -05:00
.gitignore Instrument Kibana with APM RUM agent (#44281) 2019-12-18 12:16:15 +01:00
.i18nrc.json Advanced settings component registry ⇒ kibana platform plugin (#55940) 2020-02-04 13:38:18 -06:00
.node-version Update Node.js to version 10.19.0 (#56940) 2020-02-05 21:57:43 -08:00
.nvmrc Update Node.js to version 10.19.0 (#56940) 2020-02-05 21:57:43 -08:00
.prettierrc Increase prettier line width to 100 (#20535) 2018-07-09 22:50:37 +02:00
.sass-lint.yml Vislib replacement toggle (#56439) 2020-02-03 22:05:32 -06:00
.yarnrc [kbn-pm] Use yarn workspaces for dependencies (#24095) 2018-11-12 12:38:11 -06:00
api-documenter.json Normalize EOL symbol in platform docs (#56021) 2020-01-27 18:42:45 +01:00
CONTRIBUTING.md added note about yarn kbn clean and yarn cache clean 2020-01-29 15:22:52 -06:00
FAQ.md propose language changes (#10709) 2017-03-05 12:10:32 -05:00
github_checks_reporter.json implementing github checks - second attempt (#35757) 2019-05-01 16:02:33 -05:00
Gruntfile.js autofix all violations 2019-12-13 23:17:13 -07:00
Jenkinsfile Remove matrix build support (#54202) 2020-01-27 17:10:34 -05:00
kibana.d.ts Update eslint related packages (#48513) 2019-10-21 16:32:31 -07:00
LICENSE.txt Migrate x-pack-kibana source to kibana 2018-04-24 13:48:10 -07:00
NOTICE.txt [SIEM][Detection Engine] Final final rule changes (#56806) 2020-02-04 18:19:36 -07:00
package.json Update Node.js to version 10.19.0 (#56940) 2020-02-05 21:57:43 -08:00
preinstall_check.js Apache 2.0 license headers (#19383) 2018-05-28 20:06:30 -07:00
README.md chore: point issue links to choose (#49616) 2019-10-29 15:54:27 +01:00
renovate.json5 bump renovate label from 7.6 to 7.7 (#55621) 2020-01-29 15:11:01 -06:00
STYLEGUIDE.md Upgrade to TypeScript 3.7.2 (#47188) 2019-11-15 10:33:29 +01:00
tsconfig.browser.json [typescript] continue to use the default config in development (#21966) 2018-08-14 15:27:07 -07:00
tsconfig.json [Metric] convert mocha tests to jest (#54054) 2020-01-17 12:00:35 -06:00
tsconfig.types.json [Core] Move Saved objects files to core (#38771) 2019-06-18 13:10:23 +02:00
TYPESCRIPT.md Update deprecated React.SFC and React.StatelessComponent types (#50852) 2019-11-21 20:53:54 +01:00
yarn.lock Updating angular-* packages to 1.7.9 to appease the scanners (#56924) 2020-02-05 18:54:10 -08:00

Kibana

Kibana is your window into the Elastic Stack. Specifically, it's a browser-based analytics and search dashboard for Elasticsearch.

Getting Started

If you just want to try Kibana out, check out the Elastic Stack Getting Started Page to give it a whirl.

If you're interested in diving a bit deeper and getting a taste of Kibana's capabilities, head over to the Kibana Getting Started Page.

Using a Kibana Release

If you want to use a Kibana release in production, give it a test run, or just play around:

Building and Running Kibana, and/or Contributing Code

You might want to build Kibana locally to contribute some code, test out the latest features, or try out an open PR:

Documentation

Visit Elastic.co for the full Kibana documentation.

For information about building the documentation, see the README in elastic/docs.

Version Compatibility with Elasticsearch

Ideally, you should be running Elasticsearch and Kibana with matching version numbers. If your Elasticsearch has an older version number or a newer major number than Kibana, then Kibana will fail to run. If Elasticsearch has a newer minor or patch number than Kibana, then the Kibana Server will log a warning.

Note: The version numbers below are only examples, meant to illustrate the relationships between different types of version numbers.

Situation Example Kibana version Example ES version Outcome
Versions are the same. 5.1.2 5.1.2 💚 OK
ES patch number is newer. 5.1.2 5.1.5 ⚠️ Logged warning
ES minor number is newer. 5.1.2 5.5.0 ⚠️ Logged warning
ES major number is newer. 5.1.2 6.0.0 🚫 Fatal error
ES patch number is older. 5.1.2 5.1.0 ⚠️ Logged warning
ES minor number is older. 5.1.2 5.0.0 🚫 Fatal error
ES major number is older. 5.1.2 4.0.0 🚫 Fatal error

Questions? Problems? Suggestions?

  • If you've found a bug or want to request a feature, please create a GitHub Issue. Please check to make sure someone else hasn't already created an issue for the same topic.
  • Need help using Kibana? Ask away on our Kibana Discuss Forum and a fellow community member or Elastic engineer will be glad to help you out.