[8.10] Exclude disabled tasks from task manager health API and Stack Monitoring (#164444) (#164620)

# Backport This will backport the following commits from `main` to `8.10`: - [Exclude disabled tasks from task manager health API and Stack Monitoring (#164444)](https://github.com/elastic/kibana/pull/164444)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Mike Côté <mikecote@users.noreply.github.com>
2025-04-23 09:19:04 -04:00 · 2023-08-23 15:33:19 -04:00 · 2023-08-23 15:33:19 -04:00 · ecaaa6abaf
commit ecaaa6abaf
parent f02c4c3d81
6 changed files with 53 additions and 6 deletions
--- a/x-pack/plugins/task_manager/server/task_store.test.ts
+++ b/x-pack/plugins/task_manager/server/task_store.test.ts
@ -381,7 +381,9 @@ describe('TaskStore', () => {
        index: 'tasky',
        body: {
          size: 0,
-          query: { bool: { filter: [{ term: { type: 'task' } }] } },
+          query: {
+            bool: { filter: [{ term: { type: 'task' } }, { term: { 'task.enabled': true } }] },
+          },
          aggs: { testAgg: { terms: { field: 'task.taskType' } } },
        },
      });
@ -401,7 +403,11 @@ describe('TaskStore', () => {
          query: {
            bool: {
              must: [
-                { bool: { filter: [{ term: { type: 'task' } }] } },
+                {
+                  bool: {
+                    filter: [{ term: { type: 'task' } }, { term: { 'task.enabled': true } }],
+                  },
+                },
                { term: { 'task.taskType': 'bar' } },
              ],
            },
@ -420,7 +426,9 @@ describe('TaskStore', () => {
      expect(args).toMatchObject({
        body: {
          size: 0,
-          query: { bool: { filter: [{ term: { type: 'task' } }] } },
+          query: {
+            bool: { filter: [{ term: { type: 'task' } }, { term: { 'task.enabled': true } }] },
+          },
          aggs: { testAgg: { terms: { field: 'task.taskType' } } },
          runtime_mappings: { testMapping: { type: 'long', script: { source: `` } } },
        },
--- a/x-pack/plugins/task_manager/server/task_store.ts
+++ b/x-pack/plugins/task_manager/server/task_store.ts
@ -477,7 +477,7 @@ export class TaskStore {
      index: this.index,
      ignore_unavailable: true,
      track_total_hits: true,
-      body: ensureAggregationOnlyReturnsTaskObjects({
+      body: ensureAggregationOnlyReturnsEnabledTaskObjects({
        query,
        aggs,
        runtime_mappings,
@ -595,11 +595,11 @@ function ensureQueryOnlyReturnsTaskObjects(opts: SearchOpts): SearchOpts {
  };
 }

-function ensureAggregationOnlyReturnsTaskObjects(opts: AggregationOpts): AggregationOpts {
+function ensureAggregationOnlyReturnsEnabledTaskObjects(opts: AggregationOpts): AggregationOpts {
  const originalQuery = opts.query;
  const filterToOnlyTasks = {
    bool: {
-      filter: [{ term: { type: 'task' } }],
+      filter: [{ term: { type: 'task' } }, { term: { 'task.enabled': true } }],
    },
  };
  const query = originalQuery
--- a/x-pack/test/plugin_api_integration/plugins/sample_task_plugin/server/init_routes.ts
+++ b/x-pack/test/plugin_api_integration/plugins/sample_task_plugin/server/init_routes.ts
@ -51,6 +51,7 @@ export function initRoutes(
      validate: {
        body: schema.object({
          task: schema.object({
+            enabled: schema.boolean({ defaultValue: true }),
            taskType: schema.string(),
            schedule: schema.maybe(
              schema.object({
--- a/x-pack/test/plugin_api_integration/plugins/sample_task_plugin/server/plugin.ts
+++ b/x-pack/test/plugin_api_integration/plugins/sample_task_plugin/server/plugin.ts
@ -233,6 +233,15 @@ export class SampleTaskManagerFixturePlugin
          },
        }),
      },
+      taskToDisable: {
+        title: 'Task used for testing it being disabled',
+        description: '',
+        maxAttempts: 1,
+        paramsSchema: schema.object({}),
+        createTaskRunner: () => ({
+          async run() {},
+        }),
+      },
    });

    const taskWithTiming = {
--- a/x-pack/test/plugin_api_integration/test_suites/task_manager/check_registered_task_types.ts
+++ b/x-pack/test/plugin_api_integration/test_suites/task_manager/check_registered_task_types.ts
@ -34,6 +34,7 @@ export default function ({ getService }: FtrProviderContext) {
    'sampleRecurringTaskWithInvalidIndirectParam',
    'sampleOneTimeTaskWithInvalidIndirectParam',
    'sampleTaskWithParamsSchema',
+    'taskToDisable',
  ];

  // This test is meant to fail when any change is made in task manager registered types.
--- a/x-pack/test/plugin_api_integration/test_suites/task_manager/health_route.ts
+++ b/x-pack/test/plugin_api_integration/test_suites/task_manager/health_route.ts
@ -307,5 +307,33 @@ export default function ({ getService }: FtrProviderContext) {
        'number'
      );
    });
+
+    it('should exclude disabled tasks', async () => {
+      const interval = '9s';
+      await scheduleTask({
+        enabled: false,
+        taskType: 'taskToDisable',
+        schedule: { interval },
+      });
+
+      const timestamp = new Date();
+
+      const health = await retry.try(async () => {
+        const result = await getHealth();
+        expect(new Date(result.stats.runtime.timestamp).getTime()).to.be.greaterThan(
+          timestamp.getTime()
+        );
+        expect(new Date(result.stats.workload.timestamp).getTime()).to.be.greaterThan(
+          timestamp.getTime()
+        );
+        return result;
+      });
+
+      expect(health.stats.runtime.value.execution.duration.taskToDisable).to.eql(undefined);
+      expect(health.stats.workload.value.task_types.taskToDisable).to.eql(undefined);
+      expect(health.stats.workload.value.schedule.find(([val]) => val === interval)).to.eql(
+        undefined
+      );
+    });
  });
 }