Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 3.41 KB

README.md

File metadata and controls

54 lines (40 loc) · 3.41 KB
Raw

home plugin

Moves the legacy ui/registry/feature_catalogue module for registering "features" that should be shown in the home page's feature catalogue to a service within a "home" plugin. The feature catalogue refered to here should not be confused with the "feature" plugin for registering features used to derive UI capabilities for feature controls.

Feature catalogue (public service)

Replaces the legacy ui/registry/feature_catalogue module for registering "features" that should be showed in the home page's feature catalogue. This should not be confused with the "feature" plugin for registering features used to derive UI capabilities for feature controls.

Example registration

// For legacy plugins
import { npSetup } from 'ui/new_platform';
npSetup.plugins.home.featureCatalogue.register(/* same details here */);

// For new plugins: first add 'home` to the list of `optionalPlugins` 
// in your kibana.json file. Then access the plugin directly in `setup`:

class MyPlugin {
  setup(core, plugins) {
    if (plugins.home) {
      plugins.home.featureCatalgoue.register(/* same details here. */);
    }
  }
}

Note that the old module supported providing a Angular DI function to receive Angular dependencies. This is no longer supported as we migrate away from Angular and will be removed in 8.0.

Sample data

Replaces the sample data mixin putting functions on the global server object.

What happens when a user installs a sample data set?

  1. Kibana deletes existing Elastic search indicies for the sample data set if they exist from previous installs.
  2. Kibana creates Elasticsearch indicies with the provided field mappings.
  3. Kibana uses bulk insert to ingest the new-line delimited json into the Elasticsearch index. Kibana migrates timestamps provided in new-line delimited json to the current time frame for any date field defined in timeFields
  4. Kibana will install all saved objects for sample data set. This will override any saved objects previouslly installed for sample data set.

Elasticsearch index names are prefixed with kibana_sample_data_. For more details see createIndexName

Sample data sets typically provide data that spans 5 weeks from the past and 5 weeks into the future so users see data relative to now for a few weeks after installing sample data sets.

Adding new sample data sets

Use existing sample data sets as examples. To avoid bloating the Kibana distribution, keep data set size to a minimum.

Follow the steps below to add new Sample data sets to Kibana.

  1. Create new-line delimited json containing sample data.
  2. Create file with Elasticsearch field mappings for sample data indices.
  3. Create Kibana saved objects for sample data including index-patterns, visualizations, and dashboards. The best way to extract the saved objects is from the Kibana management -> saved objects export UI
  4. Define sample data spec conforming to Data Set Schema.
  5. Register sample data by calling plguins.home.sampleData.registerSampleDataset(yourSpecProvider) in your setup method where yourSpecProvider is a function that returns an object containing your sample data spec from step 4.