Skip to content

[8.18] [DOCS] Add minimal task manager health APIs (#213862) #215988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lcawl merged 2 commits into from
Mar 26, 2025
Merged

[8.18] [DOCS] Add minimal task manager health APIs (#213862) #215988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
617f1ca
[DOCS] Add minimal task manager health APIs (#213862)
lcawl Mar 26, 2025
e191440
[CI] Auto-commit changed files from 'make api-docs'
kibanamachine Mar 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
352 changes: 352 additions & 0 deletions oas_docs/output/kibana.serverless.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,11 @@ tags:
x-displayName: System
description: |
Get information about the system status, resource usage, and installed plugins.
- externalDocs:
description: Task manager
url: https://www.elastic.co/guide/en/kibana/current/task-manager-production-considerations.html
name: task manager
x-displayName: Task manager
paths:
/api/actions/connector_types:
get:
Expand Down Expand Up @@ -42589,7 +42594,28 @@ paths:
tags:
- streams
x-state: Technical Preview
<<<<<<< HEAD
>>>>>>> bce77d761a3 ([DOCS] Removes Serverless API x-beta overlay (#215587))
=======
/api/task_manager/_health:
get:
description: |
Get the health status of the Kibana task manager.
operationId: task-manager-health
responses:
'200':
content:
application/json:
examples:
taskManagerHealthResponse1:
$ref: '#/components/examples/Task_manager_health_Serverless_APIs_health_200response_serverless'
schema:
$ref: '#/components/schemas/Task_manager_health_Serverless_APIs_health_response_serverless'
description: Indicates a successful call
summary: Get the task manager health
tags:
- task manager
>>>>>>> c9bfa082a07 ([DOCS] Add minimal task manager health APIs (#213862))
/api/timeline:
delete:
description: Delete one or more Timelines or Timeline templates.
Expand Down Expand Up @@ -45316,6 +45342,305 @@ components:
icon: indexPatternApp
title: Kibana Sample Data Logs
type: index-pattern
Task_manager_health_Serverless_APIs_health_200response_serverless:
description: A successful response from `GET api/task_manager/_health`.
value: |-
{
"id": "b44483e1-3ba2-4f28-93d0-1d96c69c32c1",
"timestamp": "2025-03-21T21:49:50.409Z",
"status": "OK",
"last_update": "2025-03-21T21:48:53.996Z",
"stats": {
"configuration": {
"timestamp": "2025-03-21T21:47:51.663Z",
"value": {
"request_capacity": 1000,
"monitored_aggregated_stats_refresh_rate": 60000,
"monitored_stats_running_average_window": 50,
"monitored_task_execution_thresholds": {
"custom": {},
"default": {
"error_threshold": 90,
"warn_threshold": 80
}
},
"claim_strategy": "mget",
"poll_interval": 500,
"capacity": {
"config": 10,
"as_workers": 10,
"as_cost": 20
}
},
"status": "OK"
},
"workload": {
"timestamp": "2025-03-21T21:48:53.996Z",
"value": {
"count": 21,
"cost": 42,
"task_types": {
"Fleet-Metrics-Task": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"Fleet-Usage-Logger": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"Fleet-Usage-Sender": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"ML:saved-objects-sync": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"actions:connector_usage_reporting": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"actions_telemetry": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"alerting_health_check": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"alerting_telemetry": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"alerts_invalidate_api_keys": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"cases-telemetry-task": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"dashboard_telemetry": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"fleet:automatic-agent-upgrade-task": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"fleet:check-deleted-files-task": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"fleet:delete-unenrolled-agents-task": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"fleet:sync-integrations-task": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"fleet:unenroll-inactive-agents-task": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"fleet:upgrade-agentless-deployments-task": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"logs-data-telemetry": {
"count": 1,
"cost": 2,
"status": {
"running": 1
}
},
"session_cleanup": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"task_manager:delete_inactive_background_task_nodes": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
},
"task_manager:mark_removed_tasks_as_unrecognized": {
"count": 1,
"cost": 2,
"status": {
"idle": 1
}
}
},
"non_recurring": 1,
"non_recurring_cost": 2,
"schedule": [
[
"1m",
2
],
[
"5m",
2
],
[
"10m",
1
],
[
"15m",
1
],
[
"30m",
1
],
[
"1h",
5
],
[
"3600s",
1
],
[
"60m",
1
],
[
"720m",
1
],
[
"1d",
4
],
[
"1440m",
1
]
],
"overdue": 0,
"overdue_cost": 0,
"overdue_non_recurring": 0,
"estimated_schedule_density": [
0,
0,
1,
0,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"capacity_requirements": {
"per_minute": 2,
"per_hour": 43,
"per_day": 7
}
},
"status": "OK"
}
}
}
get_connector_types_generativeai_response:
summary: A list of connector types for the `generativeAI` feature.
value:
Expand Down Expand Up @@ -60079,6 +60404,33 @@ components:
$ref: '#/components/schemas/SLOs_time_window'
title: Update SLO request
type: object
Task_manager_health_Serverless_APIs_configuration:
description: |
This object summarizes the current configuration of Task Manager. This includes dynamic configurations that change over time, such as `poll_interval` and `max_workers`, which can adjust in reaction to changing load on the system.
type: object
Task_manager_health_Serverless_APIs_health_response_serverless:
title: Task health response properties
type: object
properties:
id:
type: string
last_update:
type: string
stats:
type: object
properties:
configuration:
$ref: '#/components/schemas/Task_manager_health_Serverless_APIs_configuration'
workload:
$ref: '#/components/schemas/Task_manager_health_Serverless_APIs_workload'
status:
type: string
timestamp:
type: string
Task_manager_health_Serverless_APIs_workload:
description: |
This object summarizes the work load across the cluster, including the tasks in the system, their types, and current status.
type: object
bedrock_config:
title: Connector request properties for an Amazon Bedrock connector
description: Defines properties for connectors when type is `.bedrock`.
Expand Down
Loading