ContextQMD
Back to Kibana

Kibana breaking changes [kibana-breaking-changes]

docs/release-notes/breaking-changes.md

9.4.021.7 KB
Original Source

Kibana breaking changes [kibana-breaking-changes]

Breaking changes can impact your Elastic applications, potentially disrupting normal operations. Before you upgrade, carefully review the Kibana breaking changes and take the necessary steps to mitigate any issues.

If you are migrating from a version prior to version 9.0, you must first upgrade to the last 8.x version available. To learn how to upgrade, check out Upgrade.

% ## Next version [kibana-X.X.X-breaking-changes]

% Use the following template to add entries to this document.

% TEMPLATE START % $$$kibana-PR_NUMBER$$$ % ::::{dropdown} Title of breaking change % Description of the breaking change. % Impact Impact of the breaking change. % Action Steps for mitigating impact. % View [PR #](PR link). % :::: % TEMPLATE END

% 1. Copy and edit the template in the right area section of this file. Most recent entries should be at the top of the section. % 2. Edit the anchor ID ($$$kibana-PR_NUMBER$$$) of the template with the correct PR number to give the entry a unique URL. % 3. Don't hardcode the link to the new entry. Instead, make it available through the doc link service files: % - {kib-repo}blob/{branch}/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts % - {kib-repo}blob/{branch}/src/platform/packages/shared/kbn-doc-links/src/types.ts % % The entry in the main links file should look like this: % % id: ${KIBANA_DOCS}breaking-changes.html#kibana-PR_NUMBER % % 4. You can then call the link from any Kibana code. For example: href: docLinks.links.upgradeAssistant.id % Check https://docs.elastic.dev/docs/kibana-doc-links (internal) for more details about the Doc links service.

9.3.2 [kibana-9.3.2-breaking-changes]

$$$kibana-255122$$$ ::::{dropdown} The _source field mode is now saved to the template index settings

Details The index and component template forms in Index Management previously saved the _source field mode (stored and synthetic) in the mappings._source.mode setting. This path is deprecated and has no effect in {{es}}. The form now uses the correct settings.index.mapping.source.mode setting. When you edit a template in the UI, any existing mappings._source.mode setting is automatically moved to the index settings and removed from mappings. Other _source options (enabled, includes, and excludes) remain in mappings.

View #255122. ::::

9.3.0 [kibana-9.3.0-breaking-changes]

There are no breaking changes in this version.

9.2.0 [kibana-9.2.0-breaking-changes]

$$$kibana-230067$$$ ::::{dropdown} Improved advanced settings management APIs privilege checks Details Roles with explicit read access to advanced settings but all access to SavedObjectManagement can no longer update settings using the internal advanced settings API. This update enforces explicit privileges instead of relying on saved object security checks. View #230067. ::::

9.1.0 [kibana-9.1.0-breaking-changes]

$$$kibana-213916$$$ ::::{dropdown} Change to variable syntax in {{esql}} queries

Details Fields and functions variables are now described with ?? in {{esql}} queries. For value variables, you can continue to use ?.

View #213916. ::::

$$$kibana-216558$$$ ::::{dropdown} API keys are used for authenticating report generation requests

Details In 9.1.0, report generation requests are authenticated by API keys instead of session cookies. There are several key differences between the authentication methods. API keys capture your role privileges, whereas session cookie are based on your user credentials. API keys are also longer-lived, compared to session cookies, which have a shorter lifespan.

If you have a cross-cluster search environment and want to generate reports from remote clusters, you must have the appropriate cluster and index privileges on the remote cluster and local cluster. For example, if requests are authenticated with an API key, the API key requires certain privileges on the local cluster that contains the local index, in addition to the remote. For more information and examples, refer to Configure roles and users for remote clusters.

View #216558. ::::

9.0.0 [kibana-900-breaking-changes]

$$$kibana-193792$$$ :::{dropdown} Access to {{kib}}'s internal APIs is blocked Access to internal Kibana HTTP APIs is restricted from version 9.0.0. This is to ensure that HTTP API integrations with Kibana avoid unexpected breaking changes.

Impact Any HTTP API calls to internal Kibana endpoints will fail with a 400 status code starting from version 9.0.0.

Action Do not integrate with internal HTTP APIs. They may change or be removed without notice, and lead to unexpected behaviors. If you would like some capability to be exposed over an HTTP API, create an issue. We would love to discuss your use case.

View #193792. ::::

Alerts and cases

$$$kibana-203148$$$ ::::{dropdown} Removed deprecated Alerting endpoints

  • POST /api/alerts/alert/{id?} has been replaced by POST /api/alerting/rule/{id?}
  • GET /api/alerts/alert/{{id}} has been replaced by GET /api/alerting/rule/{{id}}
  • PUT /api/alerts/alert/{{id}} has been replaced by PUT /api/alerting/rule/rule/{{id}}
  • DELETE: /api/alerts/alert/{{id}} has been replaced by DELETE /api/alerting/rule/{{id}}
  • POST /api/alerts/alert/{{id}}/_disable has been replaced by POST /api/alerting/rule/{{id}}/_disable
  • POST /api/alerts/alert/{{id}}/_enable has been replaced by POST /api/alerting/rule/{{id}}/_enable
  • GET /api/alerts/_find has been replaced by GET /api/alerting/rules/_find
  • GET /api/alerts/_health has been replaced by GET /api/alerting/rule/_health
  • GET /api/alerts/list_alert_types has been replaced by GET /api/alerting/rule_types
  • POST /api/alerts/alert/{{alert_id}}/alert_instance/{{alert_instance_id}}/_mute has been replaced by POST /api/alerting/rule/{{rule_id}}/alert/{{alert_id}}/_mute
  • POST /api/alerts/alert/{{alert_id}}/alert_instance/{{alert_instance_id}}/_unmute has been replaced by POST /api/alerting/rule/{{rule_id}}/alert/{{alert_id}}/_unmute
  • POST /api/alerts/alert/{{id}}/_mute_all has been replaced by POST /api/alerting/rule/{{id}}/_mute_all
  • POST /api/alerts/alert/{{id}}/_unmute_all has been replaced by POST /api/alerting/rule/{{id}}/_unmute_all
  • POST /api/alerts/alert/{{id}}/_update_api_key has been replaced by POST /api/alerting/rule/{{id}}/_update_api_key
  • GET /api/alerts/{{id}}/_instance_summary has been deprecated without replacement. Will be removed in v9.0.0
  • GET /api/alerts/{{id}}/state has been deprecated without replacement. Will be removed in v9.0.0

Impact Deprecated endpoints will fail with a 404 status code starting from version 9.0.0.

Action Remove references to GET /api/alerts/{{id}}/_instance_summary endpoint. Remove references to GET /api/alerts/{{id}}/state endpoint. Replace references to endpoints listed as deprecated by it’s replacement. See Details section. The updated APIs can be found in https://www.elastic.co/docs/api/doc/kibana/group/endpoint-alerting. ::::

$$$kibana-198435$$$ ::::{dropdown} Removed deprecated Alerting settings :name: breaking-198435

Details

The following deprecated configuration settings were removed:

  • xpack.actions.customHostSettings.ssl.rejectUnauthorized
  • xpack.actions.whitelistedHosts
  • xpack.actions.rejectUnauthorized
  • xpack.actions.proxyRejectUnauthorizedCertificates
  • xpack.alerts.healthCheck
  • xpack.alerts.invalidateApiKeysTask.interval
  • xpack.alerts.invalidateApiKeysTask.removalDelay
  • xpack.alerting.defaultRuleTaskTimeout

View #198435. ::::

$$$kibana-208208$$$

$$$kibana-208086$$$

$$$kibana-207926$$$ ::::{dropdown} Removed deprecated Cases endpoints :name: deprecation-208208

Details

The following Cases APIs were removed:

  • Get case status
  • Get user actions
  • Get all comments
  • GET /api/cases/status is deleted with no replacement
  • GET /api/cases/{{case_id}}/comments is replaced by GET /api/cases/{{case_id}}/comments/_find, released in v7.13
  • GET /api/cases/<case_id>/user_actions is replaced by GET /api/cases/<case_id>/user_actions/_find, released in v8.7
  • includeComments parameter in GET /api/cases/{{case_id}} is deprecated. Use GET /api/cases/{{case_id}}/comments/_find instead, released in v7.13

Impact Using these endpoints will fail with a 404 status code starting from version 9.0.0.

Action Remove references to the GET /api/cases/status endpoint. Replace references to other endpoints with the replacements listed in the breaking change details.

View #208208, #208086, and #207926. ::::

$$$kibana-197421$$$

$$$kibana-201313$$$ ::::{dropdown} Removed ephemeral tasks from task manager, action, and alerting plugins. :name: breaking-201313

Details

Ephemeral tasks are now removed. The following settings will no longer have any effect and are now deprecated:

  • xpack.task_manager.ephemeral_tasks.enabled
  • xpack.task_manager.ephemeral_tasks.request_capacity
  • xpack.alerting.maxEphemeralActionsPerAlert

No action is required on the user's end.

View #201313 and #197421. ::::

Discover and dashboards

$$$kibana-203927$$$ ::::{dropdown} Search sessions disabled by default :name: breaking-203927

Details Starting from version 9.0.0, search sessions are disabled by default. To view, manage, and restore search sessions, the feature needs to be explicitly re-enabled.

Impact Search sessions will be disabled unless they are explicitly enabled in config.yml.

Action If you would like to continue using, managing, and restoring search sessions in 9.0, you’ll need to re-enable the feature in your kibana.yml configuration file. If not, no action is necessary.

To re-enable search sessions, add the following in your config.yml:

data.search.sessions.enabled: true

View #203927. ::::

$$$kibana-202863$$$ ::::{dropdown} Saved query privileges have been reworked :name: breaking-202863

Details

Saved query privileges have been reworked to rely solely on a single global savedQueryManagement privilege, and eliminate app-specific overrides (e.g. implicit access with all privilege for Discover, Dashboard, Maps, and Visualize apps). This change simplifies the security model and ensures consistency in the saved query management UI across Kibana, but results in different handling of saved query privileges for new user roles, and minor breaking changes to the existing management UX.

Impact

The savedQueryManagement feature privilege now globally controls access to saved query management for all new user roles. Regardless of privileges for Discover, Dashboard, Maps, or Visualize, new user roles follow this behaviour:

  • If savedQueryManagement is none, the user cannot see or access the saved query management UI or APIs.
  • If savedQueryManagement is read, the user can load queries from the UI and access read APIs, but cannot save queries from the UI or make changes to queries through APIs.
  • If savedQueryManagement is all, the user can both load and save queries from the UI and through APIs.

Action

Existing user roles that were previously implicitly granted access to saved queries through the dashboard, discover, visualize, or maps feature privileges will retain that access to prevent breaking changes. While no action is required for existing roles, it’s still advisable to audit relevant roles and re-save them to migrate to the latest privileges model. For new roles, ensure that the savedQueryManagement privilege is set as needed.

View #202863. ::::

$$$kibana-202679$$$ ::::{dropdown} Removed discover:searchFieldsFromSource setting :name: breaking-202679

The discover:searchFieldsFromSource advanced setting has been removed.

Details

Users can no longer configure Discover to load fields from _source. This is an internal optimization and should have little impact on users. View #202679. ::::

$$$kibana-201254$$$ ::::{dropdown} Removed the legacy table in Discover :name: breaking-201254

Details

It's no longer possible to use the legacy documents table in Discover. To that effect, the doc_table:legacy and truncate:maxHeight deprecated advanced settings have been removed. View #201254.

Impact

This is primarily a UX change and should have little impact on Discover users. ::::

$$$kibana-202250$$$ ::::{dropdown} Scripted field creation has been disabled in the Data Views management page :name: breaking-202250

Details

The ability to create new scripted fields has been removed from the Data Views management page in 9.0. Existing scripted fields can still be edited or deleted, and the creation UI can be accessed by navigating directly to /app/management/kibana/dataViews/dataView/{dataViewId}/create-field, but we recommend migrating to runtime fields or ES|QL queries instead to prepare for removal.

Impact

It will no longer be possible to create new scripted fields directly from the Data Views management page.

Action

Migrate to runtime fields or ES|QL instead of creating new scripted fields. Existing scripted fields can still be edited or deleted. ::::

$$$kibana-162389$$$ ::::{dropdown} Removed visualization:colorMapping advanced setting :name: kibana-deprecation-197802

Details

The visualization:colorMapping advanced setting for TSVB and Visualize charts has been removed. You can switch to Lens charts, which offer a more advanced, per-chart color mapping feature with enhanced configuration options. View #162389. ::::

Elasticsearch solution

$$$kibana-212031$$$ ::::{dropdown} Removed Behavioral Analytics :name: breaking-212031

Details

The Behavioral Analytics feature is removed from the Kibana interface in 9.0 and its associated APIs are deprecated.

View #212031. ::::

Elastic Observability solution

$$$kibana-202278$$$ ::::{dropdown} Profiling now defaults to 19Hz sampling frequency :name: breaking-202278

Details

View #202278. ::::

$$$kibana-203996$$$ ::::{dropdown} Disabled log stream and settings pages :name: deprecation-203996

Details

Logs Stream and the logs settings page in Observability are removed. Use the Discover application, which now offers a contextual experience for logs, to explore your logs. The logs stream panel in dashboards is removed, use Discover sessions instead.

View #203996. ::::

$$$kibana-203685$$$ ::::{dropdown} Removed Logs explorer :name: deprecation-203685

Details

Logs explorer has been removed. Instead, you can use Discover, that was improved to provide an optimal logs exploration experience. View #203685. ::::

Elastic Security solution

For the Elastic Security 9.0.0 release information, refer to Elastic Security Solution Release Notes.

Data ingestion and Fleet

$$$kibana-198799$$$ ::::{dropdown} Removed deprecated settings API endpoints in Fleet :name: breaking-198799

Details

  • GET/DELETE/POST enrollment-api-keys: removed in favor of GET/DELETE/POST enrollment_api_keys
  • Removed list property from GET enrollment_api_keys response in favor of items
  • GET/POST /settings: fleet_server_hosts was removed from the response and body

View #198799. ::::

$$$kibana-198313$$$ ::::{dropdown} Removed deprecated Fleet APIs for agents endpoints :name: breaking-198313

Details

Removed API endpoints:

  • POST /service-tokens in favor of POST /service_tokens
  • GET /agent-status in favor GET /agent_status
  • PUT /agents/:agentid/reassign in favor of POST /agents/:agentid/reassign

Removed deprecated parameters or responses:

  • Removed total from GET /agent_status response
  • Removed list from GET /agents response

View #198313. ::::

$$$kibana-198434$$$ ::::{dropdown} Removed deprecated epm Fleet APIs :name: breaking-198434

Details

  • Removed GET/POST/DELETE /epm/packages/:pkgkey APIs in favor of GET/POST/DELETE /epm/packages/:pkgName/:pkgVersion
  • Removed experimental query parameter in GET /epm/packages and GET /epm/categories
  • Removed response in response in * /epm/packages* and GET /epm/categories
  • Removed savedObject in /epm/packages response in favor of installationInfo

View #198434. ::::

$$$kibana-199226$$$ ::::{dropdown} Removed deprecated topics property for kafka output in favor of the topic property :name: breaking-199226

Details

Removed deprecated property topics from output APIs in response and requests ((GET|POST|PUT) /api/fleet/outputs) in favor of the topic property. View #199226. ::::

$$$kibana-196887$$$ ::::{dropdown} Limit pagination size to 100 when retrieving full policy or withAgentCount in Fleet :name: breaking-196887

Details

In addition to the new pagination limit size of 100, retrieving agent policies without agent count is now the new default behavior, and a new query parameter withAgentCount was added to retrieve the agent count.

View #196887. ::::

Reporting

$$$kibana-200834$$$ :::{dropdown} Reporting uses Kibana feature privileges only to control access to reporting features In 8.x, the default access control model was based on a built-in role called reporting_user, which granted access to reporting features. Since 7.13, the preferred model for controlling access to reporting features has been Kibana feature privileges, enabled by setting xpack.reporting.roles.enabled: false in kibana.yml.

In 9.0.0, the xpack.reporting.roles.* settings will be ignored.

Impact The built-in reporting_user role is no longer deprecated and provides access to reporting features using Kibana feature privileges. This means that users that do not have privileges to use reporting will not see reporting features in the Kibana UI.

Action Use Kibana feature privileges to control access to reporting features.

  • The reporting_user role is still supported, but gives full access to all reporting features. We recommend creating custom roles with minimal privileges in Stack Management > Roles.
  • The xpack.reporting.roles.allow setting is no longer supported. If you have a xpack.reporting.roles.allow value in your kibana.yml, you should remove this setting and assign privileges to reporting features using Kibana feature privileges.

View #200834. ::::

$$$kibana-199033$$$ ::::{dropdown} Removed the "Download CSV" export type functionality :name: breaking-199033

Details

The functionality that allowed to download a CSV export from a dashboard's saved search panel without creating a report has been removed. To export CSV data from a dashboard panel, you may use the action menu of a saved search panel in a dashboard to generate a CSV report, and download the report from a toast popup when the report has finished generating.

View #199033. ::::

Kibana management

$$$kibana-214051$$$ :::{dropdown} Upgrade Assistant's reindexing and batch reindexing APIs are now internal

Upgrade Assistant public APIs for reindexing and batch reindexing have been made internal. You should instead use Elasticsearch’s native reindexing APIs for programmatic reindexing.

View #214051. :::

Kibana security

$$$kibana-199656$$$ :::{dropdown} Removed v1 Security endpoints All v1 Kibana security HTTP endpoints have been removed.

GET /api/security/v1/logout has been replaced by GET /api/security/logout GET /api/security/v1/oidc/implicit has been replaced by GET /api/security/oidc/implicit GET /api/security/v1/oidc has been replaced by GET /api/security/oidc/callback POST /api/security/v1/oidc has been replaced by POST /api/security/oidc/initiate_login POST /api/security/v1/saml has been replaced by POST /api/security/saml/callback GET /api/security/v1/me has been removed with no replacement.

Impact Any HTTP API calls to the v1 Kibana security endpoints will fail with a 404 status code starting from version 9.0.0. Third party OIDC and SAML identity providers configured with v1 endpoints will no longer work.

Action Update any OIDC and SAML identity providers to reference the corresponding replacement endpoint listed above. Remove references to the /api/security/v1/me endpoint from any automations, applications, tooling, and scripts.

View #199656. ::::

$$$kibana-213123$$$ ::::{dropdown} Removed default --openssl-legacy-provider :name: breaking-213123

Details

Legacy OpenSSL algorithms have been disabled by default. Further information on which algorithms can be found at https://docs.openssl.org/3.0/man7/OSSL_PROVIDER-legacy. These can be re-enabled by adding --openssl-legacy-provider to $KBN_PATH_CONF/node.options. View #213123. ::::

$$$kibana-203856$$$ ::::{dropdown} Removed TLSv1.1 from the default set of supported protocols :name: deprecation-203856

Details

View #203856. ::::