web-console/src/druid-models/compaction-dynamic-config/compaction-dynamic-config.tsx

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { Code } from '@blueprintjs/core';

import type { Field } from '../../components';
import { deepGet } from '../../utils';

export interface CompactionDynamicConfig {
  compactionTaskSlotRatio: number;
  maxCompactionTaskSlots: number;
  compactionPolicy: { type: 'newestSegmentFirst'; priorityDatasource?: string | null };
  useSupervisors: boolean;
  engine: 'native' | 'msq';
}

export const COMPACTION_DYNAMIC_CONFIG_DEFAULT_RATIO = 0.1;
export const COMPACTION_DYNAMIC_CONFIG_DEFAULT_MAX = 2147483647;
export const COMPACTION_DYNAMIC_CONFIG_FIELDS: Field<CompactionDynamicConfig>[] = [
  {
    name: 'useSupervisors',
    label: 'Use supervisors',
    experimental: true,
    type: 'boolean',
    defaultValue: false,
    info: (
      <>
        <p>
          Whether compaction should be run on Overlord using supervisors instead of Coordinator
          duties.
        </p>
        <p>Supervisor based compaction is an experimental feature.</p>
      </>
    ),
  },
  {
    name: 'engine',
    type: 'string',
    defined: config => Boolean(config.useSupervisors),
    defaultValue: 'native',
    suggestions: ['native', 'msq'],
    info: 'Engine to use for running compaction tasks, native or MSQ.',
  },
  {
    name: 'compactionTaskSlotRatio',
    type: 'ratio',
    defaultValue: COMPACTION_DYNAMIC_CONFIG_DEFAULT_RATIO,
    info: <>The ratio of the total task slots to the compaction task slots.</>,
  },
  {
    name: 'maxCompactionTaskSlots',
    type: 'number',
    defaultValue: COMPACTION_DYNAMIC_CONFIG_DEFAULT_MAX,
    info: <>The maximum number of task slots for compaction tasks</>,
    min: 0,
  },
  {
    name: 'compactionPolicy.type',
    label: 'Compaction search policy',
    type: 'string',
    suggestions: ['newestSegmentFirst'],
    info: (
      <>
        Currently, the only supported policy is <Code>newestSegmentFirst</Code>, which prioritizes
        segments with more recent intervals for compaction.
      </>
    ),
  },
  {
    name: 'compactionPolicy.priorityDatasource',
    type: 'string',
    defined: config => deepGet(config, 'compactionPolicy.type') === 'newestSegmentFirst',
    placeholder: '(none)',
    info: (
      <>
        Datasource to prioritize for compaction. The intervals of this datasource are chosen for
        compaction before the intervals of any other datasource. Within this datasource, the
        intervals are prioritized based on the chosen compaction policy.
      </>
    ),
  },
];