github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

Remove alerting_framework_heath from the alerting framework health API response (#154276)

Browse source 
Resolves https://github.com/elastic/kibana/issues/135035.

In this PR, I'm removing the deprecated attribute
`alerting_framework_heath` from the alerting framework health API.

## To verify

1. Start Kibana.
2. Call `/api/alerting/_health`.
3. Notice `alerting_framework_heath` is no longer part of the HTTP API
response.

---------

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: lcawl <lcawley@elastic.co>
This commit is contained in:
Mike Côté 2023-04-20 07:16:27 -04:00 • committed by GitHub
parent d2c905bef5
commit 5a4dd3fccd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 5 additions and 319 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/api-generated/rules/rule-apis-passthru.asciidoc
View file

@ -589,21 +589,6 @@ Any modifications made to this file will be overwritten.
"timestamp" : "2023-01-13T01:28:00.28Z"
}
},
"alerting_framework_heath" : {
"_deprecated" : "This state property has a typo, use \"alerting_framework_health\" instead.",
"execution_health" : {
"status" : "ok",
"timestamp" : "2023-01-13T01:28:00.28Z"
},
"read_health" : {
"status" : "ok",
"timestamp" : "2023-01-13T01:28:00.28Z"
},
"decryption_health" : {
"status" : "ok",
"timestamp" : "2023-01-13T01:28:00.28Z"
}
},
"has_permanent_encryption_key" : true,
"is_sufficiently_secure" : true
}</code></pre>
@ -2127,8 +2112,6 @@ Any modifications made to this file will be overwritten.
<li><a href="#getAlertingHealth_200_response_alerting_framework_health_decryption_health"><code>getAlertingHealth_200_response_alerting_framework_health_decryption_health</code> - </a></li>
<li><a href="#getAlertingHealth_200_response_alerting_framework_health_execution_health"><code>getAlertingHealth_200_response_alerting_framework_health_execution_health</code> - </a></li>
<li><a href="#getAlertingHealth_200_response_alerting_framework_health_read_health"><code>getAlertingHealth_200_response_alerting_framework_health_read_health</code> - </a></li>
<li><a href="#getAlertingHealth_200_response_alerting_framework_heath"><code>getAlertingHealth_200_response_alerting_framework_heath</code> - </a></li>
<li><a href="#getAlertingHealth_200_response_alerting_framework_heath_decryption_health"><code>getAlertingHealth_200_response_alerting_framework_heath_decryption_health</code> - </a></li>
<li><a href="#getRuleTypes_200_response_inner"><code>getRuleTypes_200_response_inner</code> - </a></li>
<li><a href="#getRuleTypes_200_response_inner_action_groups_inner"><code>getRuleTypes_200_response_inner_action_groups_inner</code> - </a></li>
<li><a href="#getRuleTypes_200_response_inner_action_variables"><code>getRuleTypes_200_response_inner_action_variables</code> - </a></li>
@ -2343,8 +2326,7 @@ Any modifications made to this file will be overwritten.
<h3><a name="getAlertingHealth_200_response"><code>getAlertingHealth_200_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">alerting_framework_heath (optional)</div><div class="param-desc"><span class="param-type"><a href="#getAlertingHealth_200_response_alerting_framework_heath">getAlertingHealth_200_response_alerting_framework_heath</a></span> </div>
<div class="param">alerting_framework_health (optional)</div><div class="param-desc"><span class="param-type"><a href="#getAlertingHealth_200_response_alerting_framework_health">getAlertingHealth_200_response_alerting_framework_health</a></span> </div>
<div class="param">alerting_framework_health (optional)</div><div class="param-desc"><span class="param-type"><a href="#getAlertingHealth_200_response_alerting_framework_health">getAlertingHealth_200_response_alerting_framework_health</a></span> </div>
<div class="param">has_permanent_encryption_key (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> If <code>false</code>, the encrypted saved object plugin does not have a permanent encryption key. </div>
<div class="param">is_sufficiently_secure (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> If <code>false</code>, security is enabled but TLS is not. </div>
</div> <!-- field-items -->
@ -2385,24 +2367,6 @@ Any modifications made to this file will be overwritten.
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">error</div><div class="param-enum">ok</div><div class="param-enum">warn</div>
<div class="param">timestamp (optional)</div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> format: date-time</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="getAlertingHealth_200_response_alerting_framework_heath"><code>getAlertingHealth_200_response_alerting_framework_heath</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>This property has a typo. Use <code>alerting_framework_health</code> instead.</div>
<div class="field-items">
<div class="param">_deprecated (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">decryption_health (optional)</div><div class="param-desc"><span class="param-type"><a href="#getAlertingHealth_200_response_alerting_framework_heath_decryption_health">getAlertingHealth_200_response_alerting_framework_heath_decryption_health</a></span> </div>
<div class="param">execution_health (optional)</div><div class="param-desc"><span class="param-type"><a href="#getAlertingHealth_200_response_alerting_framework_heath_decryption_health">getAlertingHealth_200_response_alerting_framework_heath_decryption_health</a></span> </div>
<div class="param">read_health (optional)</div><div class="param-desc"><span class="param-type"><a href="#getAlertingHealth_200_response_alerting_framework_heath_decryption_health">getAlertingHealth_200_response_alerting_framework_heath_decryption_health</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="getAlertingHealth_200_response_alerting_framework_heath_decryption_health"><code>getAlertingHealth_200_response_alerting_framework_heath_decryption_health</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">timestamp (optional)</div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> format: date-time</div>
</div> <!-- field-items -->
</div>

16
docs/api/alerting/health.asciidoc
View file

@ -69,20 +69,6 @@ The API returns the following:
"status":"ok",
"timestamp":"2022-06-21T21:46:15.023Z"
}
},
"alerting_framework_heath":{ <4>
"_deprecated":"This state property has a typo, use \"alerting_framework_health\" instead.","decryption_health":{
"status":"ok",
"timestamp":"2022-06-21T21:46:15.023Z"
},
"execution_health":{
"status":"ok",
"timestamp":"2022-06-21T21:46:15.023Z"
},
"read_health":{
"status":"ok",
"timestamp":"2022-06-21T21:46:15.023Z"
}
}
}
--------------------------------------------------
@ -95,5 +81,3 @@ the alerting framework: `decryption_health`, `execution_health`, and
decryption: `ok`, `warn` or `error`. `execution_health` returns the timestamp
and status of the rule execution: `ok`, `warn` or `error`. `read_health` returns
the timestamp and status of the rule reading events: `ok`, `warn` or `error`.
<4> `alerting_framework_heath` has a typo, use `alerting_framework_health`
instead. deprecated:[8.0.0]

70
x-pack/plugins/alerting/docs/openapi/bundled.json
View file

@ -613,59 +613,6 @@
"schema": {
"type": "object",
"properties": {
"alerting_framework_heath": {
"type": "object",
"description": "This property has a typo. Use `alerting_framework_health` instead.",
"deprecated": true,
"properties": {
"_deprecated": {
"type": "string",
"example": "This state property has a typo, use \"alerting_framework_health\" instead."
},
"decryption_health": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "ok"
},
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2023-01-13T01:28:00.280Z"
}
}
},
"execution_health": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "ok"
},
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2023-01-13T01:28:00.280Z"
}
}
},
"read_health": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "ok"
},
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2023-01-13T01:28:00.280Z"
}
}
}
}
},
"alerting_framework_health": {
"type": "object",
"description": "Three substates identify the health of the alerting framework: `decryption_health`, `execution_health`, and `read_health`.\n",
@ -3408,21 +3355,6 @@
"status": "ok",
"timestamp": "2023-01-13T01:28:00.280Z"
}
},
"alerting_framework_heath": {
"_deprecated": "This state property has a typo, use \"alerting_framework_health\" instead.",
"decryption_health": {
"status": "ok",
"timestamp": "2023-01-13T01:28:00.280Z"
},
"execution_health": {
"status": "ok",
"timestamp": "2023-01-13T01:28:00.280Z"
},
"read_health": {
"status": "ok",
"timestamp": "2023-01-13T01:28:00.280Z"
}
}
}
},
@ -3568,4 +3500,4 @@
"apiKeyAuth": []
}
]
}
}

53
x-pack/plugins/alerting/docs/openapi/bundled.yaml
View file

@ -370,44 +370,6 @@ paths:
schema:
type: object
properties:
alerting_framework_heath:
type: object
description: This property has a typo. Use `alerting_framework_health` instead.
deprecated: true
properties:
_deprecated:
type: string
example: This state property has a typo, use "alerting_framework_health" instead.
decryption_health:
type: object
properties:
status:
type: string
example: ok
timestamp:
type: string
format: date-time
example: '2023-01-13T01:28:00.280Z'
execution_health:
type: object
properties:
status:
type: string
example: ok
timestamp:
type: string
format: date-time
example: '2023-01-13T01:28:00.280Z'
read_health:
type: object
properties:
status:
type: string
example: ok
timestamp:
type: string
format: date-time
example: '2023-01-13T01:28:00.280Z'
alerting_framework_health:
type: object
description: |
@ -719,7 +681,7 @@ paths:
summary: Mutes an alert.
operationId: muteAlert
description: |
You must have `all` privileges for the appropriate Kibana features, depending on the `consumer` and `rule_type_id` of the rule. For example, the **Management > Stack Rules** feature, **Analytics > Discover** and **Machine Learning** features, **Observability**, and **Security** features. If the rule has actions, you must also have `read` privileges for the **Management > Actions and Connectors** feature.
You must have `all` privileges for the appropriate Kibana features, depending on the `consumer` and `rule_type_id` of the rule. For example, the **Management > Stack Rules** feature, **Analytics > Discover** and **Machine Learning** features, **Observability**, and **Security** features. If the rule has actions, you must also have `read` privileges for the **Management > Actions and Connectors** feature.
tags:
- alerting
parameters:
@ -745,7 +707,7 @@ paths:
summary: Unmutes an alert.
operationId: unmuteAlert
description: |
You must have `all` privileges for the appropriate Kibana features, depending on the `consumer` and `rule_type_id` of the rule. For example, the **Management > Stack Rules** feature, **Analytics > Discover** and **Machine Learning** features, **Observability**, and **Security** features. If the rule has actions, you must also have `read` privileges for the **Management > Actions and Connectors** feature.
You must have `all` privileges for the appropriate Kibana features, depending on the `consumer` and `rule_type_id` of the rule. For example, the **Management > Stack Rules** feature, **Analytics > Discover** and **Machine Learning** features, **Observability**, and **Security** features. If the rule has actions, you must also have `read` privileges for the **Management > Actions and Connectors** feature.
tags:
- alerting
parameters:
@ -2312,17 +2274,6 @@ components:
read_health:
status: ok
timestamp: '2023-01-13T01:28:00.280Z'
alerting_framework_heath:
_deprecated: This state property has a typo, use "alerting_framework_health" instead.
decryption_health:
status: ok
timestamp: '2023-01-13T01:28:00.280Z'
execution_health:
status: ok
timestamp: '2023-01-13T01:28:00.280Z'
read_health:
status: ok
timestamp: '2023-01-13T01:28:00.280Z'
get_rule_types_response:
summary: Retrieve rule types associated with Kibana machine learning features
value:

11
x-pack/plugins/alerting/docs/openapi/components/examples/get_health_response.yaml
View file

@ -12,14 +12,3 @@ value:
read_health:
status: ok
timestamp: '2023-01-13T01:28:00.280Z'
alerting_framework_heath:
_deprecated: "This state property has a typo, use \"alerting_framework_health\" instead."
decryption_health:
status: ok
timestamp: '2023-01-13T01:28:00.280Z'
execution_health:
status: ok
timestamp: '2023-01-13T01:28:00.280Z'
read_health:
status: ok
timestamp: '2023-01-13T01:28:00.280Z'

40
x-pack/plugins/alerting/docs/openapi/paths/s@{spaceid}@api@alerting@_health.yaml
View file

@ -17,44 +17,6 @@ get:
schema:
type: object
properties:
alerting_framework_heath:
type: object
description: This property has a typo. Use `alerting_framework_health` instead.
deprecated: true
properties:
_deprecated:
type: string
example: "This state property has a typo, use \"alerting_framework_health\" instead."
decryption_health:
type: object
properties:
status:
type: string
example: ok
timestamp:
type: string
format: date-time
example: "2023-01-13T01:28:00.280Z"
execution_health:
type: object
properties:
status:
type: string
example: ok
timestamp:
type: string
format: date-time
example: "2023-01-13T01:28:00.280Z"
read_health:
type: object
properties:
status:
type: string
example: ok
timestamp:
type: string
format: date-time
example: "2023-01-13T01:28:00.280Z"
alerting_framework_health:
type: object
description: >
@ -123,4 +85,4 @@ get:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
- url: https://localhost:5601

80
x-pack/plugins/alerting/server/routes/health.test.ts
View file

@ -155,22 +155,6 @@ describe('healthRoute', () => {
expect(await handler(context, req, res)).toStrictEqual({
body: {
alerting_framework_heath: {
// Legacy: pre-v8.0 typo
_deprecated: 'This state property has a typo, use "alerting_framework_health" instead.',
decryption_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
execution_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
read_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
},
alerting_framework_health: {
decryption_health: {
status: HealthStatus.OK,
@ -213,22 +197,6 @@ describe('healthRoute', () => {
expect(await handler(context, req, res)).toStrictEqual({
body: {
alerting_framework_heath: {
// Legacy: pre-v8.0 typo
_deprecated: 'This state property has a typo, use "alerting_framework_health" instead.',
decryption_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
execution_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
read_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
},
alerting_framework_health: {
decryption_health: {
status: HealthStatus.OK,
@ -271,22 +239,6 @@ describe('healthRoute', () => {
expect(await handler(context, req, res)).toStrictEqual({
body: {
alerting_framework_heath: {
// Legacy: pre-v8.0 typo
_deprecated: 'This state property has a typo, use "alerting_framework_health" instead.',
decryption_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
execution_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
read_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
},
alerting_framework_health: {
decryption_health: {
status: HealthStatus.OK,
@ -329,22 +281,6 @@ describe('healthRoute', () => {
expect(await handler(context, req, res)).toStrictEqual({
body: {
alerting_framework_heath: {
// Legacy: pre-v8.0 typo
_deprecated: 'This state property has a typo, use "alerting_framework_health" instead.',
decryption_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
execution_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
read_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
},
alerting_framework_health: {
decryption_health: {
status: HealthStatus.OK,
@ -387,22 +323,6 @@ describe('healthRoute', () => {
expect(await handler(context, req, res)).toStrictEqual({
body: {
alerting_framework_heath: {
// Legacy: pre-v8.0 typo
_deprecated: 'This state property has a typo, use "alerting_framework_health" instead.',
decryption_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
execution_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
read_health: {
status: HealthStatus.OK,
timestamp: currentDate,
},
},
alerting_framework_health: {
decryption_health: {
status: HealthStatus.OK,

7
x-pack/plugins/alerting/server/routes/health.ts
View file

@ -30,13 +30,6 @@ const rewriteBodyRes: RewriteResponseCase<AlertingFrameworkHealth> = ({
execution_health: alertingFrameworkHealth.executionHealth,
read_health: alertingFrameworkHealth.readHealth,
},
alerting_framework_heath: {
// Legacy: pre-v8.0 typo
_deprecated: 'This state property has a typo, use "alerting_framework_health" instead.',
decryption_health: alertingFrameworkHealth.decryptionHealth,
execution_health: alertingFrameworkHealth.executionHealth,
read_health: alertingFrameworkHealth.readHealth,
},
});
export const healthRoute = (

9
x-pack/test/alerting_api_integration/security_and_spaces/group2/tests/alerting/health.ts
View file

@ -86,10 +86,6 @@ export default function createFindTests({ getService }: FtrProviderContext) {
expect(health.alerting_framework_health.decryption_health.status).to.eql('ok');
expect(health.alerting_framework_health.execution_health.status).to.eql('ok');
expect(health.alerting_framework_health.read_health.status).to.eql('ok');
// Legacy: pre-v8.0 typo
expect(health.alerting_framework_heath.decryption_health.status).to.eql('ok');
expect(health.alerting_framework_heath.execution_health.status).to.eql('ok');
expect(health.alerting_framework_heath.read_health.status).to.eql('ok');
}
});
@ -140,11 +136,6 @@ export default function createFindTests({ getService }: FtrProviderContext) {
expect(health.alerting_framework_health.execution_health.timestamp).to.eql(
ruleInErrorStatus.execution_status.last_execution_date
);
// Legacy: pre-v8.0 typo
expect(health.alerting_framework_heath.execution_health.status).to.eql('warn');
expect(health.alerting_framework_heath.execution_health.timestamp).to.eql(
ruleInErrorStatus.execution_status.last_execution_date
);
}
});
});