Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.6] [Profiling] Add APIs to clear frame and executable caches (#145499) #145525

Merged
merged 1 commit into from
Nov 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions x-pack/plugins/profiling/common/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ export function getRoutePaths() {
TopNThreads: `${BASE_ROUTE_PATH}/topn/threads`,
TopNTraces: `${BASE_ROUTE_PATH}/topn/traces`,
Flamechart: `${BASE_ROUTE_PATH}/flamechart`,
CacheExecutables: `${BASE_ROUTE_PATH}/cache/executables`,
CacheStackFrames: `${BASE_ROUTE_PATH}/cache/stackframes`,
};
}

Expand Down
53 changes: 53 additions & 0 deletions x-pack/plugins/profiling/server/routes/cache.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* 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 { RouteRegisterParameters } from '.';
import { getRoutePaths } from '../../common';
import { handleRouteHandlerError } from '../utils/handle_route_error_handler';
import { clearExecutableCache, clearStackFrameCache } from './stacktrace';

export function registerCacheExecutablesRoute({ router, logger }: RouteRegisterParameters) {
const paths = getRoutePaths();
router.delete(
{
path: paths.CacheExecutables,
validate: {},
},
async (context, request, response) => {
try {
logger.info(`clearing executable cache`);
const numDeleted = clearExecutableCache();
logger.info(`removed ${numDeleted} executables from cache`);

return response.ok({});
} catch (error) {
return handleRouteHandlerError({ error, logger, response });
}
}
);
}

export function registerCacheStackFramesRoute({ router, logger }: RouteRegisterParameters) {
const paths = getRoutePaths();
router.delete(
{
path: paths.CacheStackFrames,
validate: {},
},
async (context, request, response) => {
try {
logger.info(`clearing stackframe cache`);
const numDeleted = clearStackFrameCache();
logger.info(`removed ${numDeleted} stackframes from cache`);

return response.ok({});
} catch (error) {
return handleRouteHandlerError({ error, logger, response });
}
}
);
}
4 changes: 4 additions & 0 deletions x-pack/plugins/profiling/server/routes/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import {
ProfilingRequestHandlerContext,
} from '../types';

import { registerCacheExecutablesRoute, registerCacheStackFramesRoute } from './cache';

import { registerFlameChartSearchRoute } from './flamechart';
import { registerTopNFunctionsSearchRoute } from './functions';

Expand All @@ -33,6 +35,8 @@ export interface RouteRegisterParameters {
}

export function registerRoutes(params: RouteRegisterParameters) {
registerCacheExecutablesRoute(params);
registerCacheStackFramesRoute(params);
registerFlameChartSearchRoute(params);
registerTopNFunctionsSearchRoute(params);
registerTraceEventsTopNContainersSearchRoute(params);
Expand Down
14 changes: 14 additions & 0 deletions x-pack/plugins/profiling/server/routes/stacktrace.ts
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,13 @@ const frameLRU = new LRUCache<StackFrameID, StackFrame>({
maxAge: CACHE_TTL_MILLISECONDS,
});

// clearStackFrameCache clears the entire cache and returns the number of deleted items
export function clearStackFrameCache(): number {
const numDeleted = frameLRU.length;
frameLRU.reset();
return numDeleted;
}

export async function mgetStackFrames({
logger,
client,
Expand Down Expand Up @@ -350,6 +357,13 @@ const executableLRU = new LRUCache<FileID, Executable>({
maxAge: CACHE_TTL_MILLISECONDS,
});

// clearExecutableCache clears the entire cache and returns the number of deleted items
export function clearExecutableCache(): number {
const numDeleted = executableLRU.length;
executableLRU.reset();
return numDeleted;
}

export async function mgetExecutables({
logger,
client,
Expand Down