Plugin API changes in 7.12

The Kibana logging system uses a configuration schema inspired by log4j to provide Elasticsearch compatible format. Several logging configuration keys were renamed to align the naming schema with the Elasticsearch config:

Refer to #90764

Plugin IDs in the kibana.json manifest must be camelCase. This has always been a requirement in the Kibana Platform. Previously, Kibana logged a deprecation warning. Now Kibana refuses to start.

Refer to #90752

The Kibana plugin system has a concept of asynchronous lifecycles for all the Kibana plugins. The new timeout (30 seconds by default) ensures that the stop lifecycle doesn’t stop the shutdown process for the Kibana server. If a plugin doesn’t complete the stop lifecycle in 30 seconds, Kibana moves to the next plugin.

Refer to #90432

All code from x-pack/vis_type_timeseries_enhanced was moved into src/vis_type_timeseries.

Refer to #89274

The IndexPatternManagement.formatEditors API moved to IndexPatternFieldEditor.formatEditors. The functionality remains the same.

Refer to #89259

The data plugin search service SearchSource now provides a fetch$ method. In addition to the existing fetch method that returns an Observable, an overall response is returned. This is useful when _async_search is used, and the user needs to handle partial search responses.

Refer to #89211

Whenever Kibana needs access to data saved in Elasticsearch, it should check if the user has access to the data. On the server-side, APIs that require impersonation with an incoming request, are exposed by the context argument of request handler:

const router = core.http.createRouter();
router.get(
  { path: '/api/my-plugin/', validate: … },
  async (context, req, res) => {}
)

Starting with the current version, your plugin should declare an interface of the context parameter explicitly.

Before

declare module 'src/core/server' {
  interface RequestHandlerContext {
    myPlugin?: MyPluginApi;
  }
}

const router = http.createRouter();
http.registerRouteHandlerContext('my-plugin', async (context, req, res) => {...});

After

export interface MyPluginRequestHandlerContext extends RequestHandlerContext {
  myPlugin: MyPluginApi;
}
const router = http.createRouter<MyPluginRequestHandlerContext>();
http.registerRouteHandlerContext<MyPluginRequestHandlerContext, 'my-plugin'>(
  'my-plugin',
  async (context, req, res) => {...}
);

Refer to #88718

You can no longer use a common visualization expression function and a common visualization renderer to retrieve data and render your custom visualization.

To register a custom visualization:

Your visualization is ready to be rendered in Kibana applications, such as Lens, Dashboard, Canvas, and more. Refer to custom visualizations.

Refer to #88317

When using the data plugin search service search method, you can now provide an additional argument, legacyHitsTotal, in the options. When set to true (the default), the hits.total is returned as a number. When set to false, the hits.total format is returned as-is from the Elasticsearch response.

Refer to #88115

We are deprecating the legacy response logs, which were enabled when logging.verbose: true or when using logging.events.ops. The legacy response logs will be removed in 8.0, and replaced with new ops logs that are provided under the metrics.ops context at the debug level.

Before

logging:
  events:
    ops: "*"

After

logging:
  loggers:
    - context: metrics.ops
      appenders: [console]
      level: debug

For more information, check out logging config migration in the logging README.

How to test this:

Refer to #88070

We are deprecating the legacy response logs, which were enabled when logging.verbose: true or when using logging.events.request and logging.events.response. They will be removed in 8.0, and have been replaced with new response logs, which are provided under the http.server.response context at the debug level.

Before

logging:
  events:
    request: "*"
    response: "*"

After

logging:
  loggers:
    - context: http.server.response
      appenders: [console]
      level: debug

For more information, check out logging config migration in the logging README.

Refer to #87939

Support for the legacy Elasticsearch client was removed from the usage collector's fetch context.

Refer to #87356

In this change:

Before:

  {
       editorConfig: {
         schemas: new Schemas([{schemaObject1, schemasObject2}])
      }
    }

After:

  {
       editorConfig: {
         schemas: [{schemaObject1, schemasObject2}]
      }
    }

Refer to #86988

Usage of services.callCluster in the alert and action type executors is deprecated. Use the new services.scopedClusterClient instead.

Refer to #86474