[ResponseOps][Rules] Add xpack.alerting.rules.apiKeyType config#251899
Merged
umbopepato merged 15 commits intoelastic:mainfrom Feb 9, 2026
Merged
[ResponseOps][Rules] Add xpack.alerting.rules.apiKeyType config#251899umbopepato merged 15 commits intoelastic:mainfrom
umbopepato merged 15 commits intoelastic:mainfrom
Conversation
umbopepato
added
release_note:skip
Contributor
|
Pinging @elastic/response-ops (Team:ResponseOps) |
ersin-erdal
approved these changes
Feb 6, 2026
Contributor
ersin-erdal
left a comment
ersin-erdal
left a comment
There was a problem hiding this comment.
LGTM
Works as expected.
Just added a nit.
| maxAlerts: number; | ||
| ruleTypeRegistry: RuleTypeRegistry; | ||
| rulesSettingsService: RulesSettingsService; | ||
| apiKeyType: 'es' | 'uiam'; |
Contributor
There was a problem hiding this comment.
nit: Can we create an enum in the types files and use it where ever we use these strings?
export enum ApiKeyTypes {
ES = 'es',
UIAM = 'uiam',
}
| usageCounter: this.usageCounter, | ||
| getEventLogClient: (request: KibanaRequest) => plugins.eventLog.getClient(request), | ||
| isServerless: this.isServerless, | ||
| apiKeyType: this.config.rules.apiKeyType ?? 'es', |
Contributor
There was a problem hiding this comment.
enum could be used here too. ApiKeyTypes.ES
darnautov
added
Feature:Alerting
Feature:Alerting/RulesFramework
darnautov
reviewed
Feb 6, 2026
darnautov
reviewed
Feb 6, 2026
darnautov
reviewed
Feb 6, 2026
Co-authored-by: Dima Arnautov <arnautov.dima@gmail.com>
Member
florent-leborgne
left a comment
florent-leborgne
left a comment
There was a problem hiding this comment.
For the docs, it'll be best to also directly edit this file https://github.com/elastic/kibana/blob/main/docs/reference/configuration-reference/alerting-settings.md as the current "setting generation" yml file is not yet in use to my knowledge
The content I saw in that file LGTM though
|
|
||
| - setting: xpack.alerting.rules.apiKeyType | ||
| description: | | ||
| The API key type to use for execting alerting rules. The default value, corresponding to the existing behavior, is `es`, which uses an ElasticSearch API key. |
Member
There was a problem hiding this comment.
Suggested change
| The API key type to use for execting alerting rules. The default value, corresponding to the existing behavior, is `es`, which uses an ElasticSearch API key. | |
| The API key type to use for executing alerting rules. The default value, corresponding to the existing behavior, is `es`, which uses an Elasticsearch API key. |
Contributor
🔍 Preview links for changed docs |
darnautov
reviewed
Feb 6, 2026
| max: 5 | ||
| ``` | ||
|
|
||
| `xpack.alerting.rules.apiKeyType`  |
Contributor
There was a problem hiding this comment.
We are not going to support UIAM in ECH, it is only for Serverless. And users won't have access to change these setting.
florent-leborgne
approved these changes
Feb 6, 2026
Member
florent-leborgne
left a comment
florent-leborgne
left a comment
There was a problem hiding this comment.
LGTM for docs! Thanks
| max: 5 | ||
| ``` | ||
|
|
||
| `xpack.alerting.rules.apiKeyType` |
Member
There was a problem hiding this comment.
Suggested change
| `xpack.alerting.rules.apiKeyType` | |
| `xpack.alerting.rules.apiKeyType` {applies_to}`serverless:` {applies_to}`stack: unavailable` |
As discussed on Slack, this should do it
Contributor
💔 Build Failed
Failed CI StepsTest Failures
Metrics [docs]
History
|
Dosant
pushed a commit
to Dosant/kibana
that referenced
this pull request
Feb 9, 2026
…tic#251899) ## 📄 Summary - Adds validation schemas and docs metadata for the new `xpack.alerting.rules.apiKeyType` kibana.yml configuration value - Reads the config value and makes it accessible as part of the `TaskRunnerContext` ## ⏪ Backport rationale New functionality, no need to backport ## 🔗 References Closes elastic/response-ops-team#516 ## ☑️ Checklist - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. --------- Co-authored-by: Dima Arnautov <arnautov.dima@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📄 Summary
xpack.alerting.rules.apiKeyTypekibana.yml configuration valueTaskRunnerContext⏪ Backport rationale
New functionality, no need to backport
🔗 References
Closes https://github.com/elastic/response-ops-team/issues/543
☑️ Checklist
release_note:*label is applied per the guidelinesbackport:*labels.