@djangocfg/api 1.2.19 → 1.2.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +11846 -9936
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +5466 -3236
- package/dist/index.d.ts +5466 -3236
- package/dist/index.mjs +11859 -9975
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
- package/src/cfg/generated/_utils/fetchers/cfg__rq__rq_jobs.ts +105 -0
- package/src/cfg/generated/_utils/fetchers/cfg__rq__rq_monitoring.ts +77 -0
- package/src/cfg/generated/_utils/fetchers/{cfg__dashboard.ts → cfg__rq__rq_queues.ts} +21 -20
- package/src/cfg/generated/_utils/fetchers/cfg__rq__rq_registries.ts +132 -0
- package/src/cfg/generated/_utils/fetchers/cfg__rq__rq_schedules.ts +92 -0
- package/src/cfg/generated/_utils/fetchers/cfg__rq__rq_testing.ts +120 -0
- package/src/cfg/generated/_utils/fetchers/cfg__rq__rq_workers.ts +62 -0
- package/src/cfg/generated/_utils/fetchers/index.ts +7 -2
- package/src/cfg/generated/_utils/hooks/cfg__rq__rq_jobs.ts +106 -0
- package/src/cfg/generated/_utils/hooks/cfg__rq__rq_monitoring.ts +65 -0
- package/src/cfg/generated/_utils/hooks/cfg__rq__rq_queues.ts +82 -0
- package/src/cfg/generated/_utils/hooks/cfg__rq__rq_registries.ts +132 -0
- package/src/cfg/generated/_utils/hooks/cfg__rq__rq_schedules.ts +89 -0
- package/src/cfg/generated/_utils/hooks/cfg__rq__rq_testing.ts +124 -0
- package/src/cfg/generated/_utils/hooks/cfg__rq__rq_workers.ts +50 -0
- package/src/cfg/generated/_utils/hooks/index.ts +7 -2
- package/src/cfg/generated/_utils/schemas/JobActionResponse.schema.ts +26 -0
- package/src/cfg/generated/_utils/schemas/JobDetail.schema.ts +40 -0
- package/src/cfg/generated/_utils/schemas/JobList.schema.ts +28 -0
- package/src/cfg/generated/_utils/schemas/QueueDetail.schema.ts +34 -0
- package/src/cfg/generated/_utils/schemas/QueueStats.schema.ts +31 -0
- package/src/cfg/generated/_utils/schemas/RQConfig.schema.ts +29 -0
- package/src/cfg/generated/_utils/schemas/RunDemoRequestRequest.schema.ts +24 -0
- package/src/cfg/generated/_utils/schemas/ScheduleActionResponse.schema.ts +22 -0
- package/src/cfg/generated/_utils/schemas/ScheduleCreateRequest.schema.ts +39 -0
- package/src/cfg/generated/_utils/schemas/ScheduledJob.schema.ts +32 -0
- package/src/cfg/generated/_utils/schemas/StressTestRequestRequest.schema.ts +23 -0
- package/src/cfg/generated/_utils/schemas/TestScenario.schema.ts +25 -0
- package/src/cfg/generated/_utils/schemas/TestingActionResponse.schema.ts +23 -0
- package/src/cfg/generated/_utils/schemas/Worker.schema.ts +31 -0
- package/src/cfg/generated/_utils/schemas/WorkerStats.schema.ts +31 -0
- package/src/cfg/generated/_utils/schemas/index.ts +15 -10
- package/src/cfg/generated/cfg__dashboard__dashboard_overview/models.ts +3 -1
- package/src/cfg/generated/cfg__rq__rq_jobs/client.ts +76 -0
- package/src/cfg/generated/cfg__rq__rq_jobs/models.ts +62 -0
- package/src/cfg/generated/cfg__rq__rq_monitoring/client.ts +45 -0
- package/src/cfg/generated/cfg__rq__rq_monitoring/models.ts +39 -0
- package/src/cfg/generated/cfg__rq__rq_queues/client.ts +78 -0
- package/src/cfg/generated/cfg__rq__rq_queues/index.ts +2 -0
- package/src/cfg/generated/cfg__rq__rq_queues/models.ts +33 -0
- package/src/cfg/generated/cfg__rq__rq_registries/client.ts +161 -0
- package/src/cfg/generated/cfg__rq__rq_registries/index.ts +2 -0
- package/src/cfg/generated/cfg__rq__rq_registries/models.ts +17 -0
- package/src/cfg/generated/cfg__rq__rq_schedules/client.ts +91 -0
- package/src/cfg/generated/cfg__rq__rq_schedules/index.ts +2 -0
- package/src/cfg/generated/cfg__rq__rq_schedules/models.ts +84 -0
- package/src/cfg/generated/cfg__rq__rq_testing/client.ts +96 -0
- package/src/cfg/generated/cfg__rq__rq_testing/index.ts +2 -0
- package/src/cfg/generated/cfg__rq__rq_testing/models.ts +68 -0
- package/src/cfg/generated/cfg__rq__rq_workers/client.ts +46 -0
- package/src/cfg/generated/cfg__rq__rq_workers/index.ts +2 -0
- package/src/cfg/generated/cfg__rq__rq_workers/models.ts +52 -0
- package/src/cfg/generated/client.ts +21 -6
- package/src/cfg/generated/enums.ts +40 -60
- package/src/cfg/generated/index.ts +35 -10
- package/src/cfg/generated/schema.ts +6160 -5035
- package/src/cfg/generated/_utils/fetchers/cfg__tasks.ts +0 -123
- package/src/cfg/generated/_utils/hooks/cfg__dashboard.ts +0 -77
- package/src/cfg/generated/_utils/hooks/cfg__tasks.ts +0 -111
- package/src/cfg/generated/_utils/schemas/PaginatedTaskLogListList.schema.ts +0 -24
- package/src/cfg/generated/_utils/schemas/TaskLog.schema.ts +0 -42
- package/src/cfg/generated/_utils/schemas/TaskLogDetail.schema.ts +0 -50
- package/src/cfg/generated/_utils/schemas/TaskLogList.schema.ts +0 -35
- package/src/cfg/generated/_utils/schemas/TaskLogOverview.schema.ts +0 -43
- package/src/cfg/generated/_utils/schemas/TaskLogStats.schema.ts +0 -30
- package/src/cfg/generated/_utils/schemas/TaskLogTimeline.schema.ts +0 -28
- package/src/cfg/generated/_utils/schemas/TaskLogTimelineItem.schema.ts +0 -28
- package/src/cfg/generated/_utils/schemas/TasksByQueue.schema.ts +0 -24
- package/src/cfg/generated/_utils/schemas/TasksByStatus.schema.ts +0 -24
- package/src/cfg/generated/cfg__dashboard/client.ts +0 -48
- package/src/cfg/generated/cfg__dashboard/models.ts +0 -0
- package/src/cfg/generated/cfg__tasks/client.ts +0 -104
- package/src/cfg/generated/cfg__tasks/models.ts +0 -285
- /package/src/cfg/generated/{cfg__dashboard → cfg__rq__rq_jobs}/index.ts +0 -0
- /package/src/cfg/generated/{cfg__tasks → cfg__rq__rq_monitoring}/index.ts +0 -0
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
import * as Models from "./models";
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* API endpoints for Dashboard.
|
|
6
|
-
*/
|
|
7
|
-
export class CfgDashboard {
|
|
8
|
-
private client: any;
|
|
9
|
-
|
|
10
|
-
constructor(client: any) {
|
|
11
|
-
this.client = client;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
* Get complete Django-Q2 summary. GET /api/django_q2/ Returns status,
|
|
16
|
-
* schedules, and recent tasks.
|
|
17
|
-
*/
|
|
18
|
-
async apiDjangoQ2Retrieve(): Promise<any> {
|
|
19
|
-
const response = await this.client.request('GET', "/cfg/dashboard/api/django_q2/");
|
|
20
|
-
return response;
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* Get all scheduled tasks. GET /api/django_q2/schedules/
|
|
25
|
-
*/
|
|
26
|
-
async apiDjangoQ2SchedulesRetrieve(): Promise<any> {
|
|
27
|
-
const response = await this.client.request('GET', "/cfg/dashboard/api/django_q2/schedules/");
|
|
28
|
-
return response;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* Get Django-Q2 cluster status. GET /api/django_q2/status/
|
|
33
|
-
*/
|
|
34
|
-
async apiDjangoQ2StatusRetrieve(): Promise<any> {
|
|
35
|
-
const response = await this.client.request('GET', "/cfg/dashboard/api/django_q2/status/");
|
|
36
|
-
return response;
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
/**
|
|
40
|
-
* Get recent task executions. GET /api/django_q2/tasks/ Query params: -
|
|
41
|
-
* limit: Number of tasks to return (default: 20)
|
|
42
|
-
*/
|
|
43
|
-
async apiDjangoQ2TasksRetrieve(): Promise<any> {
|
|
44
|
-
const response = await this.client.request('GET', "/cfg/dashboard/api/django_q2/tasks/");
|
|
45
|
-
return response;
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
}
|
|
File without changes
|
|
@@ -1,104 +0,0 @@
|
|
|
1
|
-
import * as Models from "./models";
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* API endpoints for Tasks.
|
|
6
|
-
*/
|
|
7
|
-
export class CfgTasks {
|
|
8
|
-
private client: any;
|
|
9
|
-
|
|
10
|
-
constructor(client: any) {
|
|
11
|
-
this.client = client;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
async logsList(created_after?: string, created_before?: string, duration_max?: number, duration_min?: number, end_time?: string, enqueue_after?: string, enqueue_before?: string, finish_after?: string, finish_before?: string, has_error?: boolean, is_completed?: boolean, is_failed?: boolean, is_successful?: boolean, job_id?: string, job_retries_max?: number, job_retries_min?: number, ordering?: string, page?: number, page_size?: number, queue_name?: string, queue_name_in?: any[], search?: string, start_after?: string, start_before?: string, start_time?: string, status?: string, status_in?: any[], success?: boolean, task?: string, task_name?: string, task_name_exact?: string, worker?: string, worker_id?: string): Promise<Models.PaginatedTaskLogListList>;
|
|
15
|
-
async logsList(params?: { created_after?: string; created_before?: string; duration_max?: number; duration_min?: number; end_time?: string; enqueue_after?: string; enqueue_before?: string; finish_after?: string; finish_before?: string; has_error?: boolean; is_completed?: boolean; is_failed?: boolean; is_successful?: boolean; job_id?: string; job_retries_max?: number; job_retries_min?: number; ordering?: string; page?: number; page_size?: number; queue_name?: string; queue_name_in?: any[]; search?: string; start_after?: string; start_before?: string; start_time?: string; status?: string; status_in?: any[]; success?: boolean; task?: string; task_name?: string; task_name_exact?: string; worker?: string; worker_id?: string }): Promise<Models.PaginatedTaskLogListList>;
|
|
16
|
-
|
|
17
|
-
/**
|
|
18
|
-
* Complete ViewSet for TaskLog monitoring. Provides read-only access to
|
|
19
|
-
* task execution logs with filtering, searching, and statistics.
|
|
20
|
-
* Endpoints: GET /api/tasks/logs/ - List all task logs GET
|
|
21
|
-
* /api/tasks/logs/{id}/ - Get task log details GET
|
|
22
|
-
* /api/tasks/logs/{id}/related/ - Get related task logs GET
|
|
23
|
-
* /api/tasks/logs/stats/ - Get aggregated statistics GET
|
|
24
|
-
* /api/tasks/logs/timeline/ - Get task execution timeline GET
|
|
25
|
-
* /api/tasks/logs/overview/ - Get summary overview Mixins: -
|
|
26
|
-
* TaskLogStatsMixin: Aggregated statistics - TaskLogTimelineMixin:
|
|
27
|
-
* Time-series data - TaskLogOverviewMixin: High-level summary -
|
|
28
|
-
* TaskLogRelatedMixin: Related task lookup - TaskLogBaseViewSet: Base CRUD
|
|
29
|
-
* operations
|
|
30
|
-
*/
|
|
31
|
-
async logsList(...args: any[]): Promise<Models.PaginatedTaskLogListList> {
|
|
32
|
-
const isParamsObject = args.length === 1 && typeof args[0] === 'object' && args[0] !== null && !Array.isArray(args[0]);
|
|
33
|
-
|
|
34
|
-
let params;
|
|
35
|
-
if (isParamsObject) {
|
|
36
|
-
params = args[0];
|
|
37
|
-
} else {
|
|
38
|
-
params = { created_after: args[0], created_before: args[1], duration_max: args[2], duration_min: args[3], end_time: args[4], enqueue_after: args[5], enqueue_before: args[6], finish_after: args[7], finish_before: args[8], has_error: args[9], is_completed: args[10], is_failed: args[11], is_successful: args[12], job_id: args[13], job_retries_max: args[14], job_retries_min: args[15], ordering: args[16], page: args[17], page_size: args[18], queue_name: args[19], queue_name_in: args[20], search: args[21], start_after: args[22], start_before: args[23], start_time: args[24], status: args[25], status_in: args[26], success: args[27], task: args[28], task_name: args[29], task_name_exact: args[30], worker: args[31], worker_id: args[32] };
|
|
39
|
-
}
|
|
40
|
-
const response = await this.client.request('GET', "/cfg/tasks/logs/", { params });
|
|
41
|
-
return response;
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
/**
|
|
45
|
-
* Complete ViewSet for TaskLog monitoring. Provides read-only access to
|
|
46
|
-
* task execution logs with filtering, searching, and statistics.
|
|
47
|
-
* Endpoints: GET /api/tasks/logs/ - List all task logs GET
|
|
48
|
-
* /api/tasks/logs/{id}/ - Get task log details GET
|
|
49
|
-
* /api/tasks/logs/{id}/related/ - Get related task logs GET
|
|
50
|
-
* /api/tasks/logs/stats/ - Get aggregated statistics GET
|
|
51
|
-
* /api/tasks/logs/timeline/ - Get task execution timeline GET
|
|
52
|
-
* /api/tasks/logs/overview/ - Get summary overview Mixins: -
|
|
53
|
-
* TaskLogStatsMixin: Aggregated statistics - TaskLogTimelineMixin:
|
|
54
|
-
* Time-series data - TaskLogOverviewMixin: High-level summary -
|
|
55
|
-
* TaskLogRelatedMixin: Related task lookup - TaskLogBaseViewSet: Base CRUD
|
|
56
|
-
* operations
|
|
57
|
-
*/
|
|
58
|
-
async logsRetrieve(id: number): Promise<Models.TaskLogDetail> {
|
|
59
|
-
const response = await this.client.request('GET', `/cfg/tasks/logs/${id}/`);
|
|
60
|
-
return response;
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
/**
|
|
64
|
-
* Get related task logs (same job_id or task_name). Returns tasks that
|
|
65
|
-
* share the same job_id or are retries of the same task. Returns: Array of
|
|
66
|
-
* related TaskLog objects (up to 10 most recent)
|
|
67
|
-
*/
|
|
68
|
-
async logsRelatedRetrieve(id: number): Promise<Models.TaskLog> {
|
|
69
|
-
const response = await this.client.request('GET', `/cfg/tasks/logs/${id}/related/`);
|
|
70
|
-
return response;
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
/**
|
|
74
|
-
* Task System Overview
|
|
75
|
-
*
|
|
76
|
-
* Get high-level summary statistics for the entire task system
|
|
77
|
-
*/
|
|
78
|
-
async logsOverviewRetrieve(): Promise<Models.TaskLogOverview> {
|
|
79
|
-
const response = await this.client.request('GET', "/cfg/tasks/logs/overview/");
|
|
80
|
-
return response;
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
/**
|
|
84
|
-
* Task Execution Statistics
|
|
85
|
-
*
|
|
86
|
-
* Get aggregated statistics about task execution (success/failure rates,
|
|
87
|
-
* duration)
|
|
88
|
-
*/
|
|
89
|
-
async logsStatsRetrieve(): Promise<Models.TaskLogStats> {
|
|
90
|
-
const response = await this.client.request('GET', "/cfg/tasks/logs/stats/");
|
|
91
|
-
return response;
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
/**
|
|
95
|
-
* Task Execution Timeline
|
|
96
|
-
*
|
|
97
|
-
* Get time-series data of task executions grouped by time intervals
|
|
98
|
-
*/
|
|
99
|
-
async logsTimelineRetrieve(): Promise<Models.TaskLogTimeline> {
|
|
100
|
-
const response = await this.client.request('GET', "/cfg/tasks/logs/timeline/");
|
|
101
|
-
return response;
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
}
|
|
@@ -1,285 +0,0 @@
|
|
|
1
|
-
import * as Enums from "../enums";
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
*
|
|
5
|
-
* Response model (includes read-only fields).
|
|
6
|
-
*/
|
|
7
|
-
export interface PaginatedTaskLogListList {
|
|
8
|
-
/** Total number of items across all pages */
|
|
9
|
-
count: number;
|
|
10
|
-
/** Current page number (1-based) */
|
|
11
|
-
page: number;
|
|
12
|
-
/** Total number of pages */
|
|
13
|
-
pages: number;
|
|
14
|
-
/** Number of items per page */
|
|
15
|
-
page_size: number;
|
|
16
|
-
/** Whether there is a next page */
|
|
17
|
-
has_next: boolean;
|
|
18
|
-
/** Whether there is a previous page */
|
|
19
|
-
has_previous: boolean;
|
|
20
|
-
/** Next page number (null if no next page) */
|
|
21
|
-
next_page?: number | null;
|
|
22
|
-
/** Previous page number (null if no previous page) */
|
|
23
|
-
previous_page?: number | null;
|
|
24
|
-
/** Array of items for current page */
|
|
25
|
-
results: Array<TaskLogList>;
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* Detailed TaskLog serializer. Includes all fields including args, kwargs,
|
|
30
|
-
* result, error messages. Combines ReArq Job + JobResult data.
|
|
31
|
-
*
|
|
32
|
-
* Response model (includes read-only fields).
|
|
33
|
-
*/
|
|
34
|
-
export interface TaskLogDetail {
|
|
35
|
-
id: number;
|
|
36
|
-
/** Unique job identifier from ReArq */
|
|
37
|
-
job_id: string;
|
|
38
|
-
/** Name of the task function */
|
|
39
|
-
task_name: string;
|
|
40
|
-
/** Queue where task was executed */
|
|
41
|
-
queue_name: string;
|
|
42
|
-
/** Current task status
|
|
43
|
-
|
|
44
|
-
* `deferred` - Deferred
|
|
45
|
-
* `queued` - Queued
|
|
46
|
-
* `in_progress` - In Progress
|
|
47
|
-
* `success` - Success
|
|
48
|
-
* `failed` - Failed
|
|
49
|
-
* `expired` - Expired
|
|
50
|
-
* `canceled` - Canceled */
|
|
51
|
-
status: Enums.TaskLogDetailStatus;
|
|
52
|
-
status_display: string;
|
|
53
|
-
/** Whether task completed successfully (null = not finished) */
|
|
54
|
-
success: boolean | null;
|
|
55
|
-
/** Positional arguments passed to task */
|
|
56
|
-
args: string;
|
|
57
|
-
/** Keyword arguments passed to task */
|
|
58
|
-
kwargs: string;
|
|
59
|
-
/** Task result (JSON string) */
|
|
60
|
-
result: string | null;
|
|
61
|
-
/** Error message if task failed */
|
|
62
|
-
error_message: string | null;
|
|
63
|
-
/** Task execution duration in milliseconds */
|
|
64
|
-
duration_ms: number | null;
|
|
65
|
-
/** Convert duration from ms to seconds. */
|
|
66
|
-
duration_seconds: number;
|
|
67
|
-
/** Maximum number of retries allowed (from task definition) */
|
|
68
|
-
job_retry: number;
|
|
69
|
-
/** Number of retries performed so far */
|
|
70
|
-
job_retries: number;
|
|
71
|
-
/** Seconds to wait before retry */
|
|
72
|
-
job_retry_after: number;
|
|
73
|
-
/** ID of worker that processed the task */
|
|
74
|
-
worker_id: string | null;
|
|
75
|
-
/** When job was enqueued to ReArq (from Job.enqueue_time) */
|
|
76
|
-
enqueue_time: string;
|
|
77
|
-
/** When job will expire (from Job.expire_time) */
|
|
78
|
-
expire_time: string | null;
|
|
79
|
-
/** When task execution started (from JobResult.start_time) */
|
|
80
|
-
start_time: string | null;
|
|
81
|
-
/** When task execution finished (from JobResult.finish_time) */
|
|
82
|
-
finish_time: string | null;
|
|
83
|
-
/** When TaskLog record was created in Django DB */
|
|
84
|
-
created_at: string;
|
|
85
|
-
/** When TaskLog record was last updated */
|
|
86
|
-
updated_at: string;
|
|
87
|
-
/** User who triggered the task (if applicable) */
|
|
88
|
-
user: number | null;
|
|
89
|
-
/** Get user display name. */
|
|
90
|
-
user_display: string;
|
|
91
|
-
}
|
|
92
|
-
|
|
93
|
-
/**
|
|
94
|
-
* Basic TaskLog serializer. Used for list views with essential fields only.
|
|
95
|
-
* Includes computed properties matching ReArq response format.
|
|
96
|
-
*
|
|
97
|
-
* Response model (includes read-only fields).
|
|
98
|
-
*/
|
|
99
|
-
export interface TaskLog {
|
|
100
|
-
id: number;
|
|
101
|
-
/** Unique job identifier from ReArq */
|
|
102
|
-
job_id: string;
|
|
103
|
-
/** Name of the task function */
|
|
104
|
-
task_name: string;
|
|
105
|
-
/** Queue where task was executed */
|
|
106
|
-
queue_name: string;
|
|
107
|
-
/** Current task status
|
|
108
|
-
|
|
109
|
-
* `deferred` - Deferred
|
|
110
|
-
* `queued` - Queued
|
|
111
|
-
* `in_progress` - In Progress
|
|
112
|
-
* `success` - Success
|
|
113
|
-
* `failed` - Failed
|
|
114
|
-
* `expired` - Expired
|
|
115
|
-
* `canceled` - Canceled */
|
|
116
|
-
status: Enums.TaskLogStatus;
|
|
117
|
-
/** Whether task completed successfully (null = not finished) */
|
|
118
|
-
success: boolean | null;
|
|
119
|
-
/** Task execution duration in milliseconds */
|
|
120
|
-
duration_ms: number | null;
|
|
121
|
-
/** Convert duration from ms to seconds. */
|
|
122
|
-
duration_seconds: number;
|
|
123
|
-
/** Maximum number of retries allowed (from task definition) */
|
|
124
|
-
job_retry: number;
|
|
125
|
-
/** Number of retries performed so far */
|
|
126
|
-
job_retries: number;
|
|
127
|
-
/** When job was enqueued to ReArq (from Job.enqueue_time) */
|
|
128
|
-
enqueue_time: string;
|
|
129
|
-
/** When job will expire (from Job.expire_time) */
|
|
130
|
-
expire_time: string | null;
|
|
131
|
-
/** When task execution started (from JobResult.start_time) */
|
|
132
|
-
start_time: string | null;
|
|
133
|
-
/** When task execution finished (from JobResult.finish_time) */
|
|
134
|
-
finish_time: string | null;
|
|
135
|
-
is_completed: boolean;
|
|
136
|
-
is_successful: boolean;
|
|
137
|
-
is_failed: boolean;
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
/**
|
|
141
|
-
* Overview of task system with proper structure. Provides high-level
|
|
142
|
-
* statistics about the entire task system: - Total tasks count (all-time) -
|
|
143
|
-
* Active queues list - Recent failures (last 24h) - Tasks distribution by
|
|
144
|
-
* queue (as array) - Tasks distribution by status (as array) Used by
|
|
145
|
-
* /cfg/tasks/logs/overview/ endpoint.
|
|
146
|
-
*
|
|
147
|
-
* Response model (includes read-only fields).
|
|
148
|
-
*/
|
|
149
|
-
export interface TaskLogOverview {
|
|
150
|
-
/** Total number of tasks all-time */
|
|
151
|
-
total_tasks: number;
|
|
152
|
-
/** List of active queue names */
|
|
153
|
-
active_queues: Array<string>;
|
|
154
|
-
/** Failed tasks in last 24 hours */
|
|
155
|
-
recent_failures: number;
|
|
156
|
-
/** Tasks grouped by queue name */
|
|
157
|
-
tasks_by_queue: Array<TasksByQueue>;
|
|
158
|
-
/** Tasks grouped by status */
|
|
159
|
-
tasks_by_status: Array<TasksByStatus>;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* Statistics serializer for task metrics. Not tied to a model - used for
|
|
164
|
-
* aggregated data.
|
|
165
|
-
*
|
|
166
|
-
* Response model (includes read-only fields).
|
|
167
|
-
*/
|
|
168
|
-
export interface TaskLogStats {
|
|
169
|
-
/** Total number of task executions */
|
|
170
|
-
total: number;
|
|
171
|
-
/** Number of successful executions */
|
|
172
|
-
successful: number;
|
|
173
|
-
/** Number of failed executions */
|
|
174
|
-
failed: number;
|
|
175
|
-
/** Number of tasks currently running */
|
|
176
|
-
in_progress: number;
|
|
177
|
-
/** Success rate percentage */
|
|
178
|
-
success_rate: number;
|
|
179
|
-
/** Average duration in milliseconds */
|
|
180
|
-
avg_duration_ms: number;
|
|
181
|
-
/** Average duration in seconds */
|
|
182
|
-
avg_duration_seconds: number;
|
|
183
|
-
/** Statistics period in hours */
|
|
184
|
-
period_hours?: number;
|
|
185
|
-
}
|
|
186
|
-
|
|
187
|
-
/**
|
|
188
|
-
* Timeline response wrapper. Returns timeline data as array of time-bucketed
|
|
189
|
-
* statistics. Used by /cfg/tasks/logs/timeline/ endpoint.
|
|
190
|
-
*
|
|
191
|
-
* Response model (includes read-only fields).
|
|
192
|
-
*/
|
|
193
|
-
export interface TaskLogTimeline {
|
|
194
|
-
/** Time period covered in hours */
|
|
195
|
-
period_hours: number;
|
|
196
|
-
/** Time bucket interval (hour/day) */
|
|
197
|
-
interval: string;
|
|
198
|
-
/** Timeline data points */
|
|
199
|
-
data: Array<TaskLogTimelineItem>;
|
|
200
|
-
}
|
|
201
|
-
|
|
202
|
-
/**
|
|
203
|
-
* Compact serializer for list views. Minimal fields for performance, matching
|
|
204
|
-
* ReArq Job list format.
|
|
205
|
-
*
|
|
206
|
-
* Response model (includes read-only fields).
|
|
207
|
-
*/
|
|
208
|
-
export interface TaskLogList {
|
|
209
|
-
id: number;
|
|
210
|
-
/** Unique job identifier from ReArq */
|
|
211
|
-
job_id: string;
|
|
212
|
-
/** Name of the task function */
|
|
213
|
-
task_name: string;
|
|
214
|
-
/** Queue where task was executed */
|
|
215
|
-
queue_name: string;
|
|
216
|
-
/** Current task status
|
|
217
|
-
|
|
218
|
-
* `deferred` - Deferred
|
|
219
|
-
* `queued` - Queued
|
|
220
|
-
* `in_progress` - In Progress
|
|
221
|
-
* `success` - Success
|
|
222
|
-
* `failed` - Failed
|
|
223
|
-
* `expired` - Expired
|
|
224
|
-
* `canceled` - Canceled */
|
|
225
|
-
status: Enums.TaskLogListStatus;
|
|
226
|
-
status_display: string;
|
|
227
|
-
/** Whether task completed successfully (null = not finished) */
|
|
228
|
-
success: boolean | null;
|
|
229
|
-
/** Number of retries performed so far */
|
|
230
|
-
job_retries: number;
|
|
231
|
-
/** Task execution duration in milliseconds */
|
|
232
|
-
duration_ms: number | null;
|
|
233
|
-
/** When job was enqueued to ReArq (from Job.enqueue_time) */
|
|
234
|
-
enqueue_time: string;
|
|
235
|
-
/** When task execution started (from JobResult.start_time) */
|
|
236
|
-
start_time: string | null;
|
|
237
|
-
/** When task execution finished (from JobResult.finish_time) */
|
|
238
|
-
finish_time: string | null;
|
|
239
|
-
}
|
|
240
|
-
|
|
241
|
-
/**
|
|
242
|
-
* Tasks count by queue. Used in overview endpoint for tasks_by_queue list.
|
|
243
|
-
*
|
|
244
|
-
* Response model (includes read-only fields).
|
|
245
|
-
*/
|
|
246
|
-
export interface TasksByQueue {
|
|
247
|
-
/** Queue name */
|
|
248
|
-
queue_name: string;
|
|
249
|
-
/** Number of tasks in this queue */
|
|
250
|
-
count: number;
|
|
251
|
-
}
|
|
252
|
-
|
|
253
|
-
/**
|
|
254
|
-
* Tasks count by status. Used in overview endpoint for tasks_by_status list.
|
|
255
|
-
*
|
|
256
|
-
* Response model (includes read-only fields).
|
|
257
|
-
*/
|
|
258
|
-
export interface TasksByStatus {
|
|
259
|
-
/** Task status */
|
|
260
|
-
status: string;
|
|
261
|
-
/** Number of tasks with this status */
|
|
262
|
-
count: number;
|
|
263
|
-
}
|
|
264
|
-
|
|
265
|
-
/**
|
|
266
|
-
* Single timeline data point. Represents aggregated task statistics for a
|
|
267
|
-
* specific time period.
|
|
268
|
-
*
|
|
269
|
-
* Response model (includes read-only fields).
|
|
270
|
-
*/
|
|
271
|
-
export interface TaskLogTimelineItem {
|
|
272
|
-
/** Time bucket start */
|
|
273
|
-
timestamp: string;
|
|
274
|
-
/** Total tasks in this period */
|
|
275
|
-
total: number;
|
|
276
|
-
/** Successful tasks */
|
|
277
|
-
successful: number;
|
|
278
|
-
/** Failed tasks */
|
|
279
|
-
failed: number;
|
|
280
|
-
/** Tasks currently in progress */
|
|
281
|
-
in_progress?: number;
|
|
282
|
-
/** Average duration in milliseconds */
|
|
283
|
-
avg_duration_ms?: number;
|
|
284
|
-
}
|
|
285
|
-
|
|
File without changes
|
|
File without changes
|