Your window into the Elastic Stack
Find a file
Rudolf Meijering 8c7d8469a8
Expose core api types in /public and /server (#32746) (#33477)
* Expose core api types in /public and /server

* Export CoreStart from core/public

* Export Server and Public from 'kibana'

* Cast frozen object type back to original

The exported type `InjectedMetadataStart` derives it's type from the returned values.
Since it's internal state is frozen the type changes to `ReadOnly<`. However, consumers
of the API shouldn't have to know or care about this type.

* Be more selective with what gets exported

* Fix type imports in tests

* Fix type errors

* Remove src/type_exports.ts

* More remove src/type_exports.ts

* Remove build:types

* Fix bootstrap import

* Expose internal API's at the top level

Exposing the internal API's at the top level of core/public and core/server
makes it obvious that these API's are consumed outside these modules. Marking
these @internal ensures they don't get exported as part of the documentation.

* Fix tests

* Put core/{public/server} in their own namespaces
2019-03-19 10:07:41 +01:00
.ci Refactor ES-related environment variables (#33036) (#33169) 2019-03-13 13:18:51 -07:00
.github Removes CODEOWNERS to avoid pings on backports. (#30352) 2019-02-07 06:12:19 -05:00
bin Bump node to 10.15.1 (#27918) 2019-02-05 16:06:59 -06:00
common/graphql [Uptime] Implement EuiSuperDatePicker (#28217) 2019-01-18 13:44:58 -05:00
config Support for multiple Elasticsearch nodes and sniffing (#21928) 2018-12-18 13:22:43 -06:00
data [folder structure] plugins/.data -> data 2016-07-05 14:06:16 -05:00
docs [DOCS]Adds info on index naming conventions (#33321) 2019-03-18 09:40:40 -04:00
licenses Migrate x-pack-kibana source to kibana 2018-04-24 13:48:10 -07:00
packages moving interpreter package to plugin (#32997) (#33284) 2019-03-15 09:55:53 +01:00
plugins [folder structure] plugins/.data -> data 2016-07-05 14:06:16 -05:00
scripts [7.x] [ts] add script to verify that all ts is in a project (#32727) (#32826) 2019-03-08 16:13:55 -08:00
src Expose core api types in /public and /server (#32746) (#33477) 2019-03-19 10:07:41 +01:00
style_guides Point to EUI for SASS/CSS guidelines (#27415) 2018-12-18 14:39:38 -05:00
tasks Refactor ES-related environment variables (#33036) (#33169) 2019-03-13 13:18:51 -07:00
test [Vis: Default editor] EUIficate string control (#32881) (#33386) 2019-03-18 12:47:42 +03:00
typings Add client side service mocks (#32999) (#33420) 2019-03-18 17:30:57 +01:00
utilities Only using known handlers with handlebars (#27061) 2018-12-17 08:29:37 -08:00
webpackShims Improve dll plugin relation with webpackshims (#30129) (#31766) 2019-02-22 02:43:44 +00:00
x-pack [APM] Add new agent name 'rum-js' (#33212) (#33458) 2019-03-18 22:58:21 -07:00
.backportrc.json Fix .backportrc.json to use 7.x instead of 7.1 (#30253) (#30254) 2019-02-06 10:51:44 -05:00
.browserslistrc Convert all Less files to Sass in Dashboard, using EUI variable scope (#21374) 2018-08-14 19:05:33 -04:00
.editorconfig Apply the same editorconfig rules to both markdown and asciidoc files 2016-09-07 11:41:41 -04:00
.eslintignore [7.x] Add http/1 response streaming to Canvas batches (#32027) (#32309) 2019-03-04 10:24:20 -05:00
.eslintrc.js Enable prettier for saved objects (#33194) (#33208) 2019-03-13 19:37:47 -04:00
.gitignore Implement built_assets directory (#27468) 2019-01-09 17:30:29 -07:00
.i18nrc.json [Maps] Localization (#30881) (#32601) 2019-03-06 20:06:06 -05:00
.node-version Bump node to 10.15.2 (#32200) 2019-02-28 10:49:28 -06:00
.nvmrc Bump node to 10.15.2 (#32200) 2019-02-28 10:49:28 -06:00
.prettierrc Increase prettier line width to 100 (#20535) 2018-07-09 22:50:37 +02:00
.sass-lint.yml Dark mode fixes for Visualize charts, TSVB, and Timelion (#30478) (#31149) 2019-02-14 13:05:09 -05:00
.yarnrc [kbn-pm] Use yarn workspaces for dependencies (#24095) 2018-11-12 12:38:11 -06:00
CONTRIBUTING.md [docs] Corrects breaking change issue label (#33252) 2019-03-14 09:19:52 -07:00
FAQ.md propose language changes (#10709) 2017-03-05 12:10:32 -05:00
Gruntfile.js Apache 2.0 license headers (#19383) 2018-05-28 20:06:30 -07:00
kibana.d.ts Expose core api types in /public and /server (#32746) (#33477) 2019-03-19 10:07:41 +01:00
LICENSE.txt Migrate x-pack-kibana source to kibana 2018-04-24 13:48:10 -07:00
NOTICE.txt [ftr/element] custom scrollIntoView to support fixed header (#28727) 2019-01-16 12:37:40 -08:00
package.json Expose core api types in /public and /server (#32746) (#33477) 2019-03-19 10:07:41 +01:00
preinstall_check.js Apache 2.0 license headers (#19383) 2018-05-28 20:06:30 -07:00
README.md Update paths to ui, server, deprecation, plugin_discovery in src/legacy 2019-02-11 11:06:26 -05:00
STYLEGUIDE.md Point to EUI for SASS/CSS guidelines (#27415) 2018-12-18 14:39:38 -05:00
tsconfig.browser.json [typescript] continue to use the default config in development (#21966) 2018-08-14 15:27:07 -07:00
tsconfig.json Expose core api types in /public and /server (#32746) (#33477) 2019-03-19 10:07:41 +01:00
tslint.yaml [tslint] ban exclusive tests (#30448) (#30462) 2019-02-09 23:46:05 -08:00
TYPESCRIPT.md docs(Typescript): Update doc to declare @elastic/eui typings in global typings file (#26160) 2018-11-28 10:46:07 +01:00
yarn.lock Chore/update headless shell to pptr@1.13.0 (#33272) (#33431) 2019-03-18 11:39:58 -07: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.