/** * Copyright (c) 2021 OpenLens Authors * * Permission is hereby granted, free of charge, to any person obtaining a copy of * this software and associated documentation files (the "Software"), to deal in * the Software without restriction, including without limitation the rights to * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of * the Software, and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ import type { LensApiRequest } from "../router"; import { respondJson } from "../utils/http-responses"; import type { Cluster } from "../cluster"; import { ClusterMetadataKey, ClusterPrometheusMetadata } from "../../common/cluster-types"; import logger from "../logger"; import { getMetrics } from "../k8s-request"; import { PrometheusProviderRegistry } from "../prometheus"; export type IMetricsQuery = string | string[] | { [metricName: string]: string; }; // This is used for backoff retry tracking. const ATTEMPTS = [false, false, false, false, true]; // prometheus metrics loader async function loadMetrics(promQueries: string[], cluster: Cluster, prometheusPath: string, queryParams: Record): Promise { const queries = promQueries.map(p => p.trim()); const loaders = new Map>(); async function loadMetric(query: string): Promise { async function loadMetricHelper(): Promise { for (const [attempt, lastAttempt] of ATTEMPTS.entries()) { // retry try { return await getMetrics(cluster, prometheusPath, { query, ...queryParams }); } catch (error) { if (lastAttempt || (error?.statusCode >= 400 && error?.statusCode < 500)) { logger.error("[Metrics]: metrics not available", error); throw new Error("Metrics not available"); } await new Promise(resolve => setTimeout(resolve, (attempt + 1) * 1000)); // add delay before repeating request } } } return loaders.get(query) ?? loaders.set(query, loadMetricHelper()).get(query); } return Promise.all(queries.map(loadMetric)); } interface MetricProviderInfo { name: string; id: string; isConfigurable: boolean; } export class MetricsRoute { static async routeMetrics({ response, cluster, payload, query }: LensApiRequest) { const queryParams: IMetricsQuery = Object.fromEntries(query.entries()); const prometheusMetadata: ClusterPrometheusMetadata = {}; try { const [prometheusPath, prometheusProvider] = await Promise.all([ cluster.contextHandler.getPrometheusPath(), cluster.contextHandler.getPrometheusProvider(), ]); prometheusMetadata.provider = prometheusProvider?.id; prometheusMetadata.autoDetected = !cluster.preferences.prometheusProvider?.type; if (!prometheusPath) { prometheusMetadata.success = false; return respondJson(response, {}); } // return data in same structure as query if (typeof payload === "string") { const [data] = await loadMetrics([payload], cluster, prometheusPath, queryParams); respondJson(response, data); } else if (Array.isArray(payload)) { const data = await loadMetrics(payload, cluster, prometheusPath, queryParams); respondJson(response, data); } else { const queries = Object.entries>(payload) .map(([queryName, queryOpts]) => ( prometheusProvider.getQuery(queryOpts, queryName) )); const result = await loadMetrics(queries, cluster, prometheusPath, queryParams); const data = Object.fromEntries(Object.keys(payload).map((metricName, i) => [metricName, result[i]])); respondJson(response, data); } prometheusMetadata.success = true; } catch { prometheusMetadata.success = false; respondJson(response, {}); } finally { cluster.metadata[ClusterMetadataKey.PROMETHEUS] = prometheusMetadata; } } static async routeMetricsProviders({ response }: LensApiRequest) { const providers: MetricProviderInfo[] = []; for (const { name, id, isConfigurable } of PrometheusProviderRegistry.getInstance().providers.values()) { providers.push({ name, id, isConfigurable }); } respondJson(response, providers); } }