kibana/examples/v8_profiler_examples/server/routes/heap_profile.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 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

import { schema } from '@kbn/config-schema';
import { Logger, IRouter } from '@kbn/core/server';
import { startProfiling } from '../lib/heap_profile';
import { handleRoute } from './common';

const routeValidation = {
  query: schema.object({
    // seconds to run the profile
    duration: schema.number({ defaultValue: 5 }),
    // Average sample interval in bytes. The default value is 32768 bytes.
    interval: schema.number({ defaultValue: 32768 }),
    includeMajorGC: schema.boolean({ defaultValue: true }),
    includeMinorGC: schema.boolean({ defaultValue: true }),
  }),
};

const routeConfig = {
  path: '/_dev/heap_profile',
  validate: routeValidation,
};

export function registerRoute(logger: Logger, router: IRouter): void {
  router.get(routeConfig, async (context, request, response) => {
    const { duration, interval, includeMajorGC, includeMinorGC } = request.query;
    const args = {
      samplingInterval: interval,
      includeObjectsCollectedByMajorGC: includeMajorGC,
      includeObjectsCollectedByMinorGC: includeMinorGC,
    };

    return await handleRoute(startProfiling, args, logger, response, duration, 'heap');
  });
}