Kibana

https://www.elastic.co/guide/en/kibana/8.19/
Admin
Kibana is a data visualization and exploration platform that enables users to visualize, analyze,...
Tokens:741,798
Snippets:8,183
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start Kibana with developer examples

Source: https://www.elastic.co/guide/en/kibana/8.19/development-getting-started.html

Start Kibana in a separate terminal window, including developer examples by adding the optional --run-examples flag. View all available options with pnpm start --help.

```shell
pnpm start --run-examples
```

--------------------------------

### Set plugin installation timeout with --timeout

Source: https://www.elastic.co/guide/en/kibana/8.19/kibana-plugins.html

Use the --timeout option with the install command to set a time limit for the installation request. The first example waits for 30 seconds before failing, and the second waits for 1 minute before failing.

```bash
bin/kibana-plugin install --timeout 30s sample-plugin
```

```bash
bin/kibana-plugin install --timeout 1m sample-plugin
```

--------------------------------

### Unsupported URL Type error example

Source: https://www.elastic.co/guide/en/kibana/8.19/running-kibana-advanced.html

This is an example error message you might see when running `npm` instead of `pnpm`. To fix it, install dependencies with `pnpm kbn bootstrap` instead.

```text
Unsupported URL Type: link:packages/kbn-eslint-config
```

--------------------------------

### Manual Vega sizing with autosize none

Source: https://www.elastic.co/guide/en/kibana/8.19/vega.html

Manual sizing example. Set autosize to none and provide exact pixel sizes, including padding for the title, legend, and axes.

```vega
autosize: none
width: 600
height: 200
padding: {
  top: 20
  bottom: 20
  left: 55
  right: 150
}
```

--------------------------------

### Elasticsearch response for terms aggregation

Source: https://www.elastic.co/guide/en/kibana/8.19/vega.html

Example response from the terms aggregation query, showing the nested buckets structure with categories and time_buckets.

```json
{
  "aggregations" : {
    "categories" : {
      "doc_count_error_upper_bound" : 0,
      "sum_other_doc_count" : 0,
      "buckets" : [{
        "key" : "Men's Clothing",
        "doc_count" : 1661,
        "time_buckets" : {
          "buckets" : [{
            "key_as_string" : "2020-06-30T00:00:00.000Z",
            "key" : 1593475200000,
            "doc_count" : 19
          }, {
            "key_as_string" : "2020-07-01T00:00:00.000Z",
            "key" : 1593561600000,
            "doc_count" : 71
          }]
        }
      }]
    }
  }
}
```

--------------------------------

### Vega Elasticsearch aggregation response structure

Source: https://www.elastic.co/guide/en/kibana/8.19/vega.html

Example response structure from the Vega Elasticsearch query. The "key" field is a unix timestamp that can be used directly by Vega date expressions.

```json
{
  "aggregations": {
    "time_buckets": {
      "buckets": [{
          "key_as_string": "2015-11-30T22:00:00.000Z",
          "key": 1448920800000,__
          "doc_count": 28
        }, {
          "key_as_string": "2015-11-30T23:00:00.000Z",
          "key": 1448924400000, __
          "doc_count": 330
        }, ...
```

--------------------------------

### Mock Kibana Core setup contract with coreMock

Source: https://www.elastic.co/guide/en/kibana/8.19/testing-kibana-plugin.html

Use coreMock.createSetup() to get the whole core setup contract. The example shows mocking uiSettings.get to return a custom implementation. This example is from my_plugin/server/plugin.test.ts.

```typescript
import { coreMock } from '@kbn/core/public/mocks';

const coreSetup = coreMock.createSetup();
coreSetup.uiSettings.get.mockImplementation((key: string) => {
  …
});
…
const plugin = new MyPlugin(coreSetup, ...);
```

--------------------------------

### Install kbn-action and list connectors

Source: https://www.elastic.co/guide/en/kibana/8.19/testing-connectors.html

Install the kbn-action tool globally via npm and set the KBN_URLBASE environment variable for a Cloud-hosted Elastic deployment. Then run 'kbn-action ls' to list existing connectors, which returns a JSON array of connector details.

```bash
$ npm -g install pmuellr/kbn-action

$ export KBN_URLBASE=https://elastic:<password>@<cloud-host>.us-east-1.aws.found.io:9243

$ kbn-action ls
[
    {
        "id": "a692dc89-15b9-4a3c-9e47-9fb6872e49ce",
        "actionTypeId": ".email",
        "name": "gmail",
        "config": {
            "from": "test@gmail.com",
            "host": "smtp.gmail.com",
            "port": 465,
            "secure": true,
            "service": null
        },
        "isPreconfigured": false,
        "isDeprecated": false,
        "referencedByCount": 0
    }
]
```

--------------------------------

### Sample data for parsing a log line

Source: https://www.elastic.co/guide/en/kibana/8.19/xpack-grokdebugger.html

A sample message representing data to parse in the Grok Debugger. This example is used in the 'Get started' section.

```text
55.3.244.1 GET /index.html 15824 0.043
```

--------------------------------

### Install kbn-action CLI

Source: https://www.elastic.co/guide/en/kibana/8.19/alerting-troubleshooting.html

Install the kbn-action command-line client globally via npm. This tool uses legacy rule APIs and must be updated for the new APIs.

```bash
npm install -g pmuellr/kbn-action
```

--------------------------------

### Write and export plugin mocks

Source: https://www.elastic.co/guide/en/kibana/8.19/testing-kibana-plugin.html

Export plugin mocks from the root /server and /public directories. The example shows creating a setup contract mock with jest.Mocked and returning it. Mocks should cover public APIs only: setup, start, and stop contracts.

```typescript
const createSetupContractMock = () => {
  const startContract: jest.Mocked<MyPluginStartContract>= {
    isValid: jest.fn(),
  }
  // here we already type check as TS infers to the correct type declared above
  startContract.isValid.mockReturnValue(true);
  return startContract;
}

export const myPluginMocks = {
  createSetup: createSetupContractMock,
  createStart: …
}
```

--------------------------------

### Show snapshot command options with --help

Source: https://www.elastic.co/guide/en/kibana/8.19/running-elasticsearch.html

Displays all available options for the snapshot command, such as specifying a license. The '--license trial' option provides access to all capabilities.

```shell
pnpm es snapshot --help
```

--------------------------------

### Get Parameters API - Request Example

Source: https://www.elastic.co/guide/en/kibana/8.19/get-parameters-api.html

Example request to retrieve a single parameter by its ID using the Get Parameters API.

```http
GET /api/synthetics/params/unique-parameter-id
```

--------------------------------

### mid helper example

Source: https://www.elastic.co/guide/en/kibana/8.19/drilldowns.html

The mid helper extracts a substring by start position and number of characters. This example extracts five characters starting from the third character.

```handlebars
{{mid event.value 3 5}}
```

--------------------------------

### List keystore settings

Source: https://www.elastic.co/guide/en/kibana/8.19/secure-settings.html

Displays a list of all settings currently stored in the keystore.

```bash
bin/kibana-keystore list
```

--------------------------------

### Install plugin from local file (bin/kibana-plugin install)

Source: https://www.elastic.co/guide/en/kibana/8.19/kibana-plugins.html

Installs a plugin from a local file path using the file:// protocol. The URL can also use HTTP or HTTPS protocols.

```text
$ bin/kibana-plugin install file:///local/path/to/custom_plugin.zip
```

--------------------------------

### demo plugin.ts - Using another plugin's interfaces

Source: https://www.elastic.co/guide/en/kibana/8.19/kibana-platform-plugin-api.html

Shows how to consume the 'foobar' plugin's public API. It manually composes TypeScript types for the setup and start plugins, and then uses the 'foobar' object in the setup and start methods. Note that getFoo() is only available in setup and getBar() only in start, as indicated by the comments.

```typescript
import type { CoreSetup, CoreStart } from '@kbn/core/server';
import type { FoobarPluginSetup, FoobarPluginStart } from '../../foobar/server';

interface DemoSetupPlugins { __
  foobar: FoobarPluginSetup;
}

interface DemoStartPlugins {
  foobar: FoobarPluginStart;
}

export class AnotherPlugin {
  public setup(core: CoreSetup, plugins: DemoSetupPlugins) { __
    const { foobar } = plugins;
    foobar.getFoo(); // 'foo'
    foobar.getBar(); // throws because getBar does not exist
  }

  public start(core: CoreStart, plugins: DemoStartPlugins) { __
    const { foobar } = plugins;
    foobar.getFoo(); // throws because getFoo does not exist
    foobar.getBar(); // 'bar'
  }

  public stop() {}
}
```

--------------------------------

### Start remote cluster for cross-cluster setup

Source: https://www.elastic.co/guide/en/kibana/8.19/running-elasticsearch.html

Starts the remote cluster for CCS/CCR setup. Uses transport port 9500, HTTP port 9201, and stores data in '../data_prod2'.

```shell
pnpm es snapshot -E transport.port=9500 -E http.port=9201 -E path.data=../data_prod2
```

--------------------------------

### Install dependencies and build OS packages

Source: https://www.elastic.co/guide/en/kibana/8.19/building-kibana.html

Installs the required dependencies for building OS packages (fpm, dpkg, rpm, and Docker) and then builds the packages. Package building is only tested on Linux and is not supported on other platforms.

```bash
apt-get install ruby ruby-dev rpm dpkg build-essential
```

```bash
gem install fpm -v 1.5.0
```

```bash
pnpm build --skip-archives
```

--------------------------------

### createModelVersionTestBed integration test example

Source: https://www.elastic.co/guide/en/kibana/8.19/saved-objects-service.html

Use this helper to set up a full integration test bed for model version testing. It starts and stops the ES server, prepares the index and performs the SO migration, and provides two repositories (before and after) to test cohabitation between versions. Note that the test bed has limitations: no extensions (security, encryption, spaces) are enabled and all SO types use the same SO index.

```typescript
import {
  createModelVersionTestBed,
  type ModelVersionTestKit
} from '@kbn/core-test-helpers-model-versions';

describe('myIntegrationTest', () => {
  const testbed = createModelVersionTestBed();
  let testkit: ModelVersionTestKit;

  beforeAll(async () => {
    await testbed.startES();
  });

  afterAll(async () => {
    await testbed.stopES();
  });

  beforeEach(async () => {
    // prepare the test, preparing the index and performing the SO migration
    testkit = await testbed.prepareTestKit({
      savedObjectDefinitions: [{
        definition: mySoTypeDefinition,
        // the model version that will be used for the "before" version
        modelVersionBefore: 1,
        // the model version that will be used for the "after" version
        modelVersionAfter: 2,
      }]
    })
  });

  afterEach(async () => {
    if(testkit) {
      // delete the indices between each tests to perform a migration again
      await testkit.tearDown();
    }
  });

  it('can be used to test model version cohabitation', async () => {
    // last registered version is `1` (modelVersionBefore)
    const repositoryV1 = testkit.repositoryBefore;
    // last registered version is `2` (modelVersionAfter)
    const repositoryV2 = testkit.repositoryAfter;

    // do something with the two repositories, e.g
    await repositoryV1.create(someAttrs, { id });
    const v2docReadFromV1 = await repositoryV2.get('my-type', id);
    expect(v2docReadFromV1.attributes).toEqual(whatIExpect);
  });
});
```

--------------------------------

### Kibana Core API plugin lifecycle example

Source: https://www.elastic.co/guide/en/kibana/8.19/kibana-platform-api.html

Shows the structure of a Kibana plugin using Core API lifecycle methods. The plugin class receives PluginInitializerContext in the constructor, and implements setup, start, and stop methods called during Kibana's startup, after all plugins are set up, and during shutdown respectively.

```typescript
import type { PluginInitializerContext, CoreSetup, CoreStart } from '@kbn/core/server';

export class MyPlugin {
  constructor(initializerContext: PluginInitializerContext) {}

  public setup(core: CoreSetup) {
    // called when plugin is setting up during Kibana's startup sequence
  }

  public start(core: CoreStart) {
    // called after all plugins are set up
  }

  public stop() {
    // called when plugin is torn down during Kibana's shutdown sequence
  }
}
```
Tokens:
Raw