kibana/x-pack/plugins/reporting/server/usage/schema.ts

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */

import { MakeSchemaFrom } from '@kbn/usage-collection-plugin/server';
import {
  AppCounts,
  ExecutionTimes,
  AvailableTotal,
  ByAppCounts,
  JobTypes,
  LayoutCounts,
  MetricsPercentiles,
  MetricsStats,
  RangeStats,
  ReportingUsageType,
  SizePercentiles,
  QueueTimes,
} from './types';

const appCountsSchema: MakeSchemaFrom<AppCounts> = {
  search: { type: 'long' },
  'canvas workpad': { type: 'long' },
  dashboard: { type: 'long' },
  visualization: { type: 'long' },
};

const executionTimesSchema: MakeSchemaFrom<ExecutionTimes> = {
  min: { type: 'long' },
  max: { type: 'long' },
  avg: { type: 'float' },
};

const queueTimesSchema: MakeSchemaFrom<QueueTimes> = {
  min: { type: 'long' },
  max: { type: 'long' },
  avg: { type: 'float' },
};

const layoutCountsSchema: MakeSchemaFrom<LayoutCounts> = {
  canvas: { type: 'long' },
  print: { type: 'long' },
  preserve_layout: { type: 'long' },
};

const byAppCountsSchema: MakeSchemaFrom<ByAppCounts> = {
  csv_searchsource: appCountsSchema,
  csv_searchsource_immediate: appCountsSchema,
  csv_v2: appCountsSchema,
  PNG: appCountsSchema,
  PNGV2: appCountsSchema,
  printable_pdf: appCountsSchema,
  printable_pdf_v2: appCountsSchema,
};

const sizesSchema: MakeSchemaFrom<SizePercentiles> = {
  '1.0': { type: 'long' },
  '5.0': { type: 'long' },
  '25.0': { type: 'long' },
  '50.0': { type: 'long' },
  '75.0': { type: 'long' },
  '95.0': { type: 'long' },
  '99.0': { type: 'long' },
};

const metricsPercentilesSchema: MakeSchemaFrom<MetricsPercentiles> = {
  '50.0': { type: 'long' },
  '75.0': { type: 'long' },
  '95.0': { type: 'long' },
  '99.0': { type: 'long' },
};

const metricsSchemaCsv: MakeSchemaFrom<Pick<MetricsStats, 'csv_rows'>> = {
  csv_rows: metricsPercentilesSchema,
};

const metricsSchemaPng: MakeSchemaFrom<Pick<MetricsStats, 'png_cpu' | 'png_memory'>> = {
  png_cpu: metricsPercentilesSchema,
  png_memory: metricsPercentilesSchema,
};

const metricsSchemaPdf: MakeSchemaFrom<Pick<MetricsStats, 'pdf_cpu' | 'pdf_memory' | 'pdf_pages'>> =
  {
    pdf_cpu: metricsPercentilesSchema,
    pdf_memory: metricsPercentilesSchema,
    pdf_pages: metricsPercentilesSchema,
  };

const errorCodesSchemaCsv: MakeSchemaFrom<JobTypes['csv_searchsource']['error_codes']> = {
  authentication_expired_error: { type: 'long' },
  queue_timeout_error: { type: 'long' },
  unknown_error: { type: 'long' },
  kibana_shutting_down_error: { type: 'long' },
};
const errorCodesSchemaPng: MakeSchemaFrom<JobTypes['PNGV2']['error_codes']> = {
  authentication_expired_error: { type: 'long' },
  queue_timeout_error: { type: 'long' },
  unknown_error: { type: 'long' },
  kibana_shutting_down_error: { type: 'long' },
  browser_could_not_launch_error: { type: 'long' },
  browser_unexpectedly_closed_error: { type: 'long' },
  browser_screenshot_error: { type: 'long' },
  visual_reporting_soft_disabled_error: { type: 'long' },
  invalid_layout_parameters_error: { type: 'long' },
};
const errorCodesSchemaPdf: MakeSchemaFrom<JobTypes['printable_pdf_v2']['error_codes']> = {
  pdf_worker_out_of_memory_error: { type: 'long' },
  authentication_expired_error: { type: 'long' },
  queue_timeout_error: { type: 'long' },
  unknown_error: { type: 'long' },
  kibana_shutting_down_error: { type: 'long' },
  browser_could_not_launch_error: { type: 'long' },
  browser_unexpectedly_closed_error: { type: 'long' },
  browser_screenshot_error: { type: 'long' },
  visual_reporting_soft_disabled_error: { type: 'long' },
  invalid_layout_parameters_error: { type: 'long' },
};

const availableTotalSchema: MakeSchemaFrom<AvailableTotal> = {
  available: { type: 'boolean' },
  total: { type: 'long' },
  deprecated: { type: 'long' },
  output_size: sizesSchema,
  app: appCountsSchema,
  execution_times: executionTimesSchema,
};

const jobTypesSchema: MakeSchemaFrom<JobTypes> = {
  csv_searchsource: {
    ...availableTotalSchema,
    metrics: metricsSchemaCsv,
    error_codes: errorCodesSchemaCsv,
  },
  csv_searchsource_immediate: {
    ...availableTotalSchema,
    metrics: metricsSchemaCsv,
    error_codes: errorCodesSchemaCsv,
  },
  csv_v2: {
    ...availableTotalSchema,
    metrics: metricsSchemaCsv,
    error_codes: errorCodesSchemaCsv,
  },
  PNG: { ...availableTotalSchema, metrics: metricsSchemaPng, error_codes: errorCodesSchemaPng },
  PNGV2: { ...availableTotalSchema, metrics: metricsSchemaPng, error_codes: errorCodesSchemaPng },
  printable_pdf: {
    ...availableTotalSchema,
    layout: layoutCountsSchema,
    metrics: metricsSchemaPdf,
    error_codes: errorCodesSchemaPdf,
  },
  printable_pdf_v2: {
    ...availableTotalSchema,
    layout: layoutCountsSchema,
    metrics: metricsSchemaPdf,
    error_codes: errorCodesSchemaPdf,
  },
};

const rangeStatsSchema: MakeSchemaFrom<RangeStats> = {
  ...jobTypesSchema,
  _all: { type: 'long' },
  status: {
    completed: { type: 'long' },
    completed_with_warnings: { type: 'long' },
    failed: { type: 'long' },
    pending: { type: 'long' },
    processing: { type: 'long' },
  },
  statuses: {
    completed: byAppCountsSchema,
    completed_with_warnings: byAppCountsSchema,
    failed: byAppCountsSchema,
    pending: byAppCountsSchema,
    processing: byAppCountsSchema,
  },
  output_size: sizesSchema,
  queue_times: queueTimesSchema,
};

export const reportingSchema: MakeSchemaFrom<ReportingUsageType> = {
  ...rangeStatsSchema,
  available: { type: 'boolean' },
  enabled: { type: 'boolean' },
  last7Days: rangeStatsSchema,
};