This is an automated email from the ASF dual-hosted git repository.
pierrejeambrun pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new fc36d002fc Add TriggererStatus to OpenAPI spec (#31579)
fc36d002fc is described below
commit fc36d002fccaad65718f42994747600c14f10263
Author: Pierre Jeambrun <[email protected]>
AuthorDate: Mon May 29 12:08:39 2023 +0200
Add TriggererStatus to OpenAPI spec (#31579)
* Add TriggererStatus to OpenAPI spec to health endpoint
* Update spec
* Update description
---
airflow/api_connexion/openapi/v1.yaml | 25 +++++++++++++++++++---
airflow/www/static/js/types/api-generated.ts | 31 +++++++++++++++++++++-------
2 files changed, 46 insertions(+), 10 deletions(-)
diff --git a/airflow/api_connexion/openapi/v1.yaml
b/airflow/api_connexion/openapi/v1.yaml
index 9784ddafb4..2e9d3d2405 100644
--- a/airflow/api_connexion/openapi/v1.yaml
+++ b/airflow/api_connexion/openapi/v1.yaml
@@ -2050,8 +2050,8 @@ paths:
get:
summary: Get instance status
description: |
- Get the status of Airflow's metadatabase and scheduler. It includes
info about
- metadatabase and last heartbeat of scheduler.
+ Get the status of Airflow's metadatabase, triggerer and scheduler. It
includes info about
+ metadatabase and last heartbeat of scheduler and triggerer.
x-openapi-router-controller:
airflow.api_connexion.endpoints.health_endpoint
operationId: get_health
tags: [Monitoring]
@@ -3082,6 +3082,8 @@ components:
$ref: '#/components/schemas/MetadatabaseStatus'
scheduler:
$ref: '#/components/schemas/SchedulerStatus'
+ triggerer:
+ $ref: '#/components/schemas/TriggererStatus'
MetadatabaseStatus:
type: object
@@ -3097,7 +3099,23 @@ components:
status:
$ref: '#/components/schemas/HealthStatus'
latest_scheduler_heartbeat:
- description: The time the scheduler last do a heartbeat.
+ description: The time the scheduler last did a heartbeat.
+ type: string
+ format: datetime
+ readOnly: true
+ nullable: true
+
+ TriggererStatus:
+ type: object
+ description: |
+ The status and the latest triggerer heartbeat.
+
+ *New in version 2.6.2*
+ properties:
+ status:
+ $ref: '#/components/schemas/HealthStatus'
+ latest_triggerer_heartbeat:
+ description: The time the triggerer last did a heartbeat.
type: string
format: datetime
readOnly: true
@@ -4658,6 +4676,7 @@ components:
HealthStatus:
description: Health status
type: string
+ nullable: true
enum:
- healthy
- unhealthy
diff --git a/airflow/www/static/js/types/api-generated.ts
b/airflow/www/static/js/types/api-generated.ts
index 4f2977fb27..fa986f8e26 100644
--- a/airflow/www/static/js/types/api-generated.ts
+++ b/airflow/www/static/js/types/api-generated.ts
@@ -646,8 +646,8 @@ export interface paths {
};
"/health": {
/**
- * Get the status of Airflow's metadatabase and scheduler. It includes
info about
- * metadatabase and last heartbeat of scheduler.
+ * Get the status of Airflow's metadatabase, triggerer and scheduler. It
includes info about
+ * metadatabase and last heartbeat of scheduler and triggerer.
*/
get: operations["get_health"];
};
@@ -1191,6 +1191,7 @@ export interface components {
HealthInfo: {
metadatabase?: components["schemas"]["MetadatabaseStatus"];
scheduler?: components["schemas"]["SchedulerStatus"];
+ triggerer?: components["schemas"]["TriggererStatus"];
};
/** @description The status of the metadatabase. */
MetadatabaseStatus: {
@@ -1201,10 +1202,23 @@ export interface components {
status?: components["schemas"]["HealthStatus"];
/**
* Format: datetime
- * @description The time the scheduler last do a heartbeat.
+ * @description The time the scheduler last did a heartbeat.
*/
latest_scheduler_heartbeat?: string | null;
};
+ /**
+ * @description The status and the latest triggerer heartbeat.
+ *
+ * *New in version 2.6.2*
+ */
+ TriggererStatus: {
+ status?: components["schemas"]["HealthStatus"];
+ /**
+ * Format: datetime
+ * @description The time the triggerer last did a heartbeat.
+ */
+ latest_triggerer_heartbeat?: string | null;
+ };
/** @description The pool */
Pool: {
/** @description The name of pool. */
@@ -2154,9 +2168,9 @@ export interface components {
WeightRule: "downstream" | "upstream" | "absolute";
/**
* @description Health status
- * @enum {string}
+ * @enum {string|null}
*/
- HealthStatus: "healthy" | "unhealthy";
+ HealthStatus: ("healthy" | "unhealthy") | null;
};
responses: {
/** Client specified an invalid argument. */
@@ -4221,8 +4235,8 @@ export interface operations {
};
};
/**
- * Get the status of Airflow's metadatabase and scheduler. It includes info
about
- * metadatabase and last heartbeat of scheduler.
+ * Get the status of Airflow's metadatabase, triggerer and scheduler. It
includes info about
+ * metadatabase and last heartbeat of scheduler and triggerer.
*/
get_health: {
responses: {
@@ -4650,6 +4664,9 @@ export type MetadatabaseStatus = CamelCasedPropertiesDeep<
export type SchedulerStatus = CamelCasedPropertiesDeep<
components["schemas"]["SchedulerStatus"]
>;
+export type TriggererStatus = CamelCasedPropertiesDeep<
+ components["schemas"]["TriggererStatus"]
+>;
export type Pool = CamelCasedPropertiesDeep<components["schemas"]["Pool"]>;
export type PoolCollection = CamelCasedPropertiesDeep<
components["schemas"]["PoolCollection"]
