|
| 1 | +# @kbn/data-stream-adapter |
| 2 | + |
| 3 | +Utility library for Elasticsearch data stream management. |
| 4 | + |
| 5 | +## DataStreamAdapter |
| 6 | + |
| 7 | +Manage single data streams. Example: |
| 8 | + |
| 9 | +``` |
| 10 | +// Setup |
| 11 | +const dataStream = new DataStreamAdapter('my-awesome-datastream', { kibanaVersion: '8.12.1' }); |
| 12 | +
|
| 13 | +dataStream.setComponentTemplate({ |
| 14 | + name: 'awesome-component-template', |
| 15 | + fieldMap: { |
| 16 | + 'awesome.field1: { type: 'keyword', required: true }, |
| 17 | + 'awesome.nested.field2: { type: 'number', required: false }, |
| 18 | + // ... |
| 19 | + }, |
| 20 | +}); |
| 21 | +
|
| 22 | +dataStream.setIndexTemplate({ |
| 23 | + name: 'awesome-index-template', |
| 24 | + componentTemplateRefs: ['awesome-component-template', 'ecs-component-template'], |
| 25 | + template: { |
| 26 | + lifecycle: { |
| 27 | + data_retention: '5d', |
| 28 | + }, |
| 29 | + }, |
| 30 | +}); |
| 31 | +
|
| 32 | +// Start |
| 33 | +await dataStream.install({ logger, esClient, pluginStop$ }); // Installs templates and the data stream, or updates existing. |
| 34 | +``` |
| 35 | + |
| 36 | + |
| 37 | +## DataStreamSpacesAdapter |
| 38 | + |
| 39 | +Manage data streams per space. Example: |
| 40 | + |
| 41 | +``` |
| 42 | +// Setup |
| 43 | +const spacesDataStream = new DataStreamSpacesAdapter('my-awesome-datastream', { kibanaVersion: '8.12.1' }); |
| 44 | +
|
| 45 | +spacesDataStream.setComponentTemplate({ |
| 46 | + name: 'awesome-component-template', |
| 47 | + fieldMap: { |
| 48 | + 'awesome.field1: { type: 'keyword', required: true }, |
| 49 | + 'awesome.nested.field2: { type: 'number', required: false }, |
| 50 | + // ... |
| 51 | + }, |
| 52 | +}); |
| 53 | +
|
| 54 | +spacesDataStream.setIndexTemplate({ |
| 55 | + name: 'awesome-index-template', |
| 56 | + componentTemplateRefs: ['awesome-component-template', 'ecs-component-template'], |
| 57 | + template: { |
| 58 | + lifecycle: { |
| 59 | + data_retention: '5d', |
| 60 | + }, |
| 61 | + }, |
| 62 | +}); |
| 63 | +
|
| 64 | +// Start |
| 65 | +await spacesDataStream.install({ logger, esClient, pluginStop$ }); // Installs templates and updates existing data streams. |
| 66 | +
|
| 67 | +// Create a space data stream on the fly |
| 68 | +await spacesDataStream.installSpace('space2'); // creates 'my-awesome-datastream-space2' data stream if it does not exist. |
| 69 | +``` |
0 commit comments