1
0
mirror of https://github.com/lensapp/lens.git synced 2024-08-16 04:40:24 +03:00

chore: extract prometheus from core

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
This commit is contained in:
Jari Kolehmainen 2023-05-26 13:05:20 +03:00 committed by Sebastian Malton
parent 7274cdde50
commit f602ce8f46
23 changed files with 275 additions and 82 deletions

View File

@ -206,6 +206,7 @@
"@k8slens/messaging-for-renderer": "^1.0.0",
"@k8slens/metrics": "^6.5.0",
"@k8slens/node-fetch": "^6.5.0",
"@k8slens/prometheus": "^1.0.0",
"@k8slens/random": "^1.0.0",
"@k8slens/react-application": "^1.0.0",
"@k8slens/resizing-anchor": "^1.0.0",

View File

@ -14,6 +14,7 @@ import { messagingFeatureForMain } from "@k8slens/messaging-for-main";
import { loggerFeature } from "@k8slens/logger";
import { randomFeature } from "@k8slens/random";
import { kubeApiSpecificsFeature } from "@k8slens/kube-api-specifics";
import { prometheusFeature } from "@k8slens/prometheus";
const environment = "main";
@ -26,12 +27,10 @@ registerMobX(di);
runInAction(() => {
registerLensCore(di, environment);
registerFeature(di,
loggerFeature,
);
registerFeature(
di,
loggerFeature,
prometheusFeature,
applicationFeature,
applicationFeatureForElectronMain,
messagingFeatureForMain,

49
package-lock.json generated
View File

@ -3831,6 +3831,10 @@
"resolved": "packages/node-fetch",
"link": true
},
"node_modules/@k8slens/prometheus": {
"resolved": "packages/technical-features/prometheus",
"link": true
},
"node_modules/@k8slens/random": {
"resolved": "packages/random-id",
"link": true
@ -33993,6 +33997,7 @@
"@k8slens/messaging-for-renderer": "^1.0.0",
"@k8slens/metrics": "^6.5.0",
"@k8slens/node-fetch": "^6.5.0",
"@k8slens/prometheus": "^1.0.0",
"@k8slens/random": "^1.0.0",
"@k8slens/react-application": "^1.0.0",
"@k8slens/resizing-anchor": "^1.0.0",
@ -34335,6 +34340,7 @@
"@k8slens/messaging-for-renderer": "^1.0.0-alpha.1",
"@k8slens/metrics": "^6.5.0-alpha.7",
"@k8slens/node-fetch": "^6.5.0-alpha.3",
"@k8slens/prometheus": "^1.0.0",
"@k8slens/random": "^1.0.0",
"@k8slens/react-application": "^1.0.0-alpha.5",
"@k8slens/resizing-anchor": "^1.0.0-alpha.5",
@ -35248,6 +35254,28 @@
"url": "https://opencollective.com/node-fetch"
}
},
"packages/prometheus": {
"name": "@k8slens/prometheus",
"version": "1.0.0",
"extraneous": true,
"license": "MIT",
"devDependencies": {
"@k8slens/eslint-config": "^6.5.0-alpha.3",
"@k8slens/jest": "^6.5.0-alpha.5",
"@k8slens/typescript": "^6.5.0-alpha.3",
"@k8slens/webpack": "^6.5.0-alpha.9"
},
"peerDependencies": {
"@k8slens/application": "^6.5.0-alpha.2",
"@k8slens/feature-core": "^6.5.0-alpha.0",
"@k8slens/utilities": "^1.0.0-alpha.7",
"@kubernetes/client-node": "^0.18.1",
"@ogre-tools/fp": "^16.1.0",
"@ogre-tools/injectable": "^16.1.0",
"@ogre-tools/injectable-extension-for-auto-registration": "^16.1.0",
"@ogre-tools/injectable-extension-for-mobx": "^16.1.0"
}
},
"packages/random-id": {
"name": "@k8slens/random",
"version": "1.0.0",
@ -35517,6 +35545,27 @@
"mobx": "^6.9.0"
}
},
"packages/technical-features/prometheus": {
"name": "@k8slens/prometheus",
"version": "1.0.0",
"license": "MIT",
"devDependencies": {
"@k8slens/eslint-config": "^6.5.0-alpha.3",
"@k8slens/jest": "^6.5.0-alpha.5",
"@k8slens/typescript": "^6.5.0-alpha.3",
"@k8slens/webpack": "^6.5.0-alpha.9"
},
"peerDependencies": {
"@k8slens/application": "^6.5.0-alpha.2",
"@k8slens/feature-core": "^6.5.0-alpha.0",
"@k8slens/utilities": "^1.0.0-alpha.7",
"@kubernetes/client-node": "^0.18.1",
"@ogre-tools/fp": "^17.2.0",
"@ogre-tools/injectable": "^17.2.0",
"@ogre-tools/injectable-extension-for-auto-registration": "^17.2.0",
"@ogre-tools/injectable-extension-for-mobx": "^17.2.0"
}
},
"packages/technical-features/react-application": {
"name": "@k8slens/react-application",
"version": "1.0.0",

View File

@ -228,6 +228,7 @@
"@k8slens/messaging-for-renderer": "^1.0.0-alpha.1",
"@k8slens/metrics": "^6.5.0-alpha.7",
"@k8slens/node-fetch": "^6.5.0-alpha.3",
"@k8slens/prometheus": "^1.0.0",
"@k8slens/react-application": "^1.0.0-alpha.5",
"@k8slens/random": "^1.0.0",
"@k8slens/resizing-anchor": "^1.0.0-alpha.5",

View File

@ -7,8 +7,8 @@ import { getDiForUnitTesting } from "../getDiForUnitTesting";
import { Cluster } from "../../common/cluster/cluster";
import type { DiContainer } from "@ogre-tools/injectable";
import { getInjectable } from "@ogre-tools/injectable";
import type { PrometheusProvider } from "../prometheus/provider";
import { prometheusProviderInjectionToken } from "../prometheus/provider";
import type { PrometheusProvider } from "@k8slens/prometheus";
import { prometheusProviderInjectionToken } from "@k8slens/prometheus";
import { runInAction } from "mobx";
import prometheusHandlerInjectable from "../cluster/prometheus-handler/prometheus-handler.injectable";
import directoryForTempInjectable from "../../common/app-paths/directory-for-temp/directory-for-temp.injectable";

View File

@ -3,7 +3,7 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import type { PrometheusProvider, PrometheusService } from "../../prometheus/provider";
import type { PrometheusProvider, PrometheusService } from "@k8slens/prometheus";
import type { ClusterPrometheusPreferences } from "../../../common/cluster-types";
import type { Cluster } from "../../../common/cluster/cluster";
import { CoreV1Api } from "@kubernetes/client-node";

View File

@ -4,7 +4,7 @@
*/
import { getInjectable } from "@ogre-tools/injectable";
import { matches } from "lodash/fp";
import type { PrometheusProvider } from "./provider";
import type { PrometheusProvider } from "@k8slens/prometheus";
import prometheusProvidersInjectable from "./providers.injectable";
export type GetPrometheusProviderByKind = (kind: string) => PrometheusProvider;

View File

@ -4,7 +4,7 @@
*/
import { getInjectable } from "@ogre-tools/injectable";
import { computedInjectManyInjectable } from "@ogre-tools/injectable-extension-for-mobx";
import { prometheusProviderInjectionToken } from "./provider";
import { prometheusProviderInjectionToken } from "@k8slens/prometheus";
const prometheusProvidersInjectable = getInjectable({
id: "prometheus-providers",

View File

@ -0,0 +1,6 @@
module.exports = {
extends: "@k8slens/eslint-config/eslint",
parserOptions: {
project: "./tsconfig.json",
},
};

View File

@ -0,0 +1 @@
"@k8slens/eslint-config/prettier"

View File

@ -0,0 +1,4 @@
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

View File

@ -0,0 +1,7 @@
/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
export { prometheusFeature } from "./src/feature";
export * from "./src/provider";

View File

@ -0,0 +1 @@
module.exports = require("@k8slens/jest").monorepoPackageConfig(__dirname).configForNode;

View File

@ -0,0 +1,50 @@
{
"name": "@k8slens/prometheus",
"private": false,
"version": "1.0.0",
"description": "Prometheus support for Lens",
"type": "commonjs",
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
},
"files": [
"dist"
],
"repository": {
"type": "git",
"url": "git+https://github.com/lensapp/lens.git"
},
"main": "dist/index.js",
"types": "dist/index.d.ts",
"author": {
"name": "OpenLens Authors",
"email": "info@k8slens.dev"
},
"license": "MIT",
"homepage": "https://github.com/lensapp/lens",
"scripts": {
"build": "lens-webpack-build",
"clean": "rimraf dist/",
"dev": "webpack --mode=development --watch",
"test": "jest --coverage --runInBand",
"lint": "lens-lint",
"lint:fix": "lens-lint --fix"
},
"peerDependencies": {
"@k8slens/application": "^6.5.0-alpha.2",
"@k8slens/feature-core": "^6.5.0-alpha.0",
"@k8slens/utilities": "^1.0.0-alpha.7",
"@kubernetes/client-node": "^0.18.1",
"@ogre-tools/fp": "^17.2.0",
"@ogre-tools/injectable": "^17.2.0",
"@ogre-tools/injectable-extension-for-auto-registration": "^17.2.0",
"@ogre-tools/injectable-extension-for-mobx": "^17.2.0"
},
"devDependencies": {
"@k8slens/eslint-config": "^6.5.0-alpha.3",
"@k8slens/jest": "^6.5.0-alpha.5",
"@k8slens/typescript": "^6.5.0-alpha.3",
"@k8slens/webpack": "^6.5.0-alpha.9"
}
}

View File

@ -0,0 +1,17 @@
import { getFeature } from "@k8slens/feature-core";
import { autoRegister } from "@ogre-tools/injectable-extension-for-auto-registration";
import { applicationFeature } from "@k8slens/application";
export const prometheusFeature = getFeature({
id: "prometheus",
register: (di) => {
autoRegister({
di,
targetModule: module,
getRequireContexts: () => [require.context("./", true, /\.injectable\.(ts|tsx)$/)],
});
},
dependencies: [applicationFeature],
});

View File

@ -9,15 +9,15 @@ import { getInjectable } from "@ogre-tools/injectable";
const helm14PrometheusProviderInjectable = getInjectable({
id: "helm14-prometheus-provider",
instantiate: () => createPrometheusProvider({
kind: "helm14",
name: "Helm 14.x",
isConfigurable: true,
getQuery: getLensLikeQueryFor({ rateAccuracy: "5m" }),
getService: (client) => findFirstNamespacedService(client, "app=prometheus,component=server,heritage=Helm"),
}),
instantiate: () =>
createPrometheusProvider({
kind: "helm14",
name: "Helm 14.x",
isConfigurable: true,
getQuery: getLensLikeQueryFor({ rateAccuracy: "5m" }),
getService: (client) => findFirstNamespacedService(client, "app=prometheus,component=server,heritage=Helm"),
}),
injectionToken: prometheusProviderInjectionToken,
});
export default helm14PrometheusProviderInjectable;

View File

@ -4,16 +4,25 @@
*/
import type { PrometheusProvider } from "./provider";
import { createPrometheusProvider, bytesSent, findFirstNamespacedService, prometheusProviderInjectionToken } from "./provider";
import {
createPrometheusProvider,
bytesSent,
findFirstNamespacedService,
prometheusProviderInjectionToken,
} from "./provider";
import { getInjectable } from "@ogre-tools/injectable";
export const getHelmLikeQueryFor = ({ rateAccuracy }: { rateAccuracy: string }): PrometheusProvider["getQuery"] => (
export const getHelmLikeQueryFor =
({ rateAccuracy }: { rateAccuracy: string }): PrometheusProvider["getQuery"] =>
(opts, queryName) => {
switch(opts.category) {
switch (opts.category) {
case "cluster":
switch (queryName) {
case "memoryUsage":
return `sum(node_memory_MemTotal_bytes - (node_memory_MemFree_bytes + node_memory_Buffers_bytes + node_memory_Cached_bytes)) by (component)`.replace(/_bytes/g, `_bytes{node=~"${opts.nodes}"}`);
return `sum(node_memory_MemTotal_bytes - (node_memory_MemFree_bytes + node_memory_Buffers_bytes + node_memory_Cached_bytes)) by (component)`.replace(
/_bytes/g,
`_bytes{node=~"${opts.nodes}"}`,
);
case "workloadMemoryUsage":
return `sum(container_memory_working_set_bytes{container!="POD",container!="",instance=~"${opts.nodes}"}) by (component)`;
case "memoryRequests":
@ -127,20 +136,19 @@ export const getHelmLikeQueryFor = ({ rateAccuracy }: { rateAccuracy: string }):
}
throw new Error(`Unknown queryName="${queryName}" for category="${opts.category}"`);
}
);
};
const helmPrometheusProviderInjectable = getInjectable({
id: "helm-prometheus-provider",
instantiate: () => createPrometheusProvider({
kind: "helm",
name: "Helm",
isConfigurable: true,
getQuery: getHelmLikeQueryFor({ rateAccuracy: "5m" }),
getService: (client) => findFirstNamespacedService(client, "app=prometheus,component=server,heritage=Helm"),
}),
instantiate: () =>
createPrometheusProvider({
kind: "helm",
name: "Helm",
isConfigurable: true,
getQuery: getHelmLikeQueryFor({ rateAccuracy: "5m" }),
getService: (client) => findFirstNamespacedService(client, "app=prometheus,component=server,heritage=Helm"),
}),
injectionToken: prometheusProviderInjectionToken,
});
export default helmPrometheusProviderInjectable;

View File

@ -3,17 +3,26 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { bytesSent, prometheusProviderInjectionToken, findNamespacedService, createPrometheusProvider } from "./provider";
import type { PrometheusProvider } from "./provider";
import {
bytesSent,
prometheusProviderInjectionToken,
findNamespacedService,
createPrometheusProvider,
} from "./provider";
import type { PrometheusProvider } from "./provider";
import { getInjectable } from "@ogre-tools/injectable";
export const getLensLikeQueryFor = ({ rateAccuracy }: { rateAccuracy: string }): PrometheusProvider["getQuery"] => (
export const getLensLikeQueryFor =
({ rateAccuracy }: { rateAccuracy: string }): PrometheusProvider["getQuery"] =>
(opts, queryName) => {
switch(opts.category) {
switch (opts.category) {
case "cluster":
switch (queryName) {
case "memoryUsage":
return `sum(node_memory_MemTotal_bytes - (node_memory_MemFree_bytes + node_memory_Buffers_bytes + node_memory_Cached_bytes)) by (kubernetes_name)`.replace(/_bytes/g, `_bytes{kubernetes_node=~"${opts.nodes}"}`);
return `sum(node_memory_MemTotal_bytes - (node_memory_MemFree_bytes + node_memory_Buffers_bytes + node_memory_Cached_bytes)) by (kubernetes_name)`.replace(
/_bytes/g,
`_bytes{kubernetes_node=~"${opts.nodes}"}`,
);
case "workloadMemoryUsage":
return `sum(container_memory_working_set_bytes{container!="POD",container!="",instance=~"${opts.nodes}"}) by (component)`;
case "memoryRequests":
@ -127,20 +136,19 @@ export const getLensLikeQueryFor = ({ rateAccuracy }: { rateAccuracy: string }):
}
throw new Error(`Unknown queryName="${queryName}" for category="${opts.category}"`);
}
);
};
const lensPrometheusProviderInjectable = getInjectable({
id: "lens-prometheus-provider",
instantiate: () => createPrometheusProvider({
kind: "lens",
name: "Lens",
isConfigurable: false,
getQuery: getLensLikeQueryFor({ rateAccuracy: "1m" }),
getService: (client) => findNamespacedService(client, "prometheus", "lens-metrics"),
}),
instantiate: () =>
createPrometheusProvider({
kind: "lens",
name: "Lens",
isConfigurable: false,
getQuery: getLensLikeQueryFor({ rateAccuracy: "1m" }),
getService: (client) => findNamespacedService(client, "prometheus", "lens-metrics"),
}),
injectionToken: prometheusProviderInjectionToken,
});
export default lensPrometheusProviderInjectable;

View File

@ -4,16 +4,25 @@
*/
import type { PrometheusProvider } from "./provider";
import { bytesSent, createPrometheusProvider, findFirstNamespacedService, prometheusProviderInjectionToken } from "./provider";
import {
bytesSent,
createPrometheusProvider,
findFirstNamespacedService,
prometheusProviderInjectionToken,
} from "./provider";
import { getInjectable } from "@ogre-tools/injectable";
export const getOperatorLikeQueryFor = ({ rateAccuracy }: { rateAccuracy: string }): PrometheusProvider["getQuery"] => (
export const getOperatorLikeQueryFor =
({ rateAccuracy }: { rateAccuracy: string }): PrometheusProvider["getQuery"] =>
(opts, queryName) => {
switch(opts.category) {
switch (opts.category) {
case "cluster":
switch (queryName) {
case "memoryUsage":
return `sum(node_memory_MemTotal_bytes - (node_memory_MemFree_bytes + node_memory_Buffers_bytes + node_memory_Cached_bytes))`.replace(/_bytes/g, `_bytes * on (pod,namespace) group_left(node) kube_pod_info{node=~"${opts.nodes}"}`);
return `sum(node_memory_MemTotal_bytes - (node_memory_MemFree_bytes + node_memory_Buffers_bytes + node_memory_Cached_bytes))`.replace(
/_bytes/g,
`_bytes * on (pod,namespace) group_left(node) kube_pod_info{node=~"${opts.nodes}"}`,
);
case "workloadMemoryUsage":
return `sum(container_memory_working_set_bytes{container!="", instance=~"${opts.nodes}"}) by (component)`;
case "memoryRequests":
@ -127,20 +136,19 @@ export const getOperatorLikeQueryFor = ({ rateAccuracy }: { rateAccuracy: string
}
throw new Error(`Unknown queryName="${queryName}" for category="${opts.category}"`);
}
);
};
const operatorPrometheusProviderInjectable = getInjectable({
id: "operator-prometheus-provider",
instantiate: () => createPrometheusProvider({
kind: "operator",
name: "Prometheus Operator",
isConfigurable: true,
getService: (client) => findFirstNamespacedService(client, "operated-prometheus=true"),
getQuery: getOperatorLikeQueryFor({ rateAccuracy: "1m" }),
}),
instantiate: () =>
createPrometheusProvider({
kind: "operator",
name: "Prometheus Operator",
isConfigurable: true,
getService: (client) => findFirstNamespacedService(client, "operated-prometheus=true"),
getQuery: getOperatorLikeQueryFor({ rateAccuracy: "1m" }),
}),
injectionToken: prometheusProviderInjectionToken,
});
export default operatorPrometheusProviderInjectable;

View File

@ -35,13 +35,16 @@ export interface CreatePrometheusProviderOpts {
getService(client: CoreV1Api): Promise<PrometheusServiceInfo>;
}
export const createPrometheusProvider = ({ getService, ...opts }: CreatePrometheusProviderOpts): PrometheusProvider => ({
export const createPrometheusProvider = ({
getService,
...opts
}: CreatePrometheusProviderOpts): PrometheusProvider => ({
...opts,
getPrometheusService: async (client) => {
try {
return {
kind: opts.kind,
...await getService(client),
...(await getService(client)),
};
} catch (error) {
throw new Error(`Failed to find Prometheus provider for "${opts.name}"`, { cause: error });
@ -49,10 +52,17 @@ export const createPrometheusProvider = ({ getService, ...opts }: CreatePromethe
},
});
export async function findFirstNamespacedService(client: CoreV1Api, ...selectors: string[]): Promise<PrometheusServiceInfo> {
export async function findFirstNamespacedService(
client: CoreV1Api,
...selectors: string[]
): Promise<PrometheusServiceInfo> {
try {
for (const selector of selectors) {
const { body: { items: [service] }} = await client.listServiceForAllNamespaces(undefined, undefined, undefined, selector);
const {
body: {
items: [service],
},
} = await client.listServiceForAllNamespaces(undefined, undefined, undefined, selector);
if (service?.metadata?.namespace && service.metadata.name && service.spec?.ports) {
return {
@ -63,13 +73,19 @@ export async function findFirstNamespacedService(client: CoreV1Api, ...selectors
}
}
} catch (error) {
throw new Error(`Failed to list services in all namespaces: ${isRequestError(error) ? error.response?.body.message : error}`);
throw new Error(
`Failed to list services in all namespaces: ${isRequestError(error) ? error.response?.body.message : error}`,
);
}
throw new Error(`No service found from any namespace`);
}
export async function findNamespacedService(client: CoreV1Api, name: string, namespace: string): Promise<PrometheusServiceInfo> {
export async function findNamespacedService(
client: CoreV1Api,
name: string,
namespace: string,
): Promise<PrometheusServiceInfo> {
try {
const { body: service } = await client.readNamespacedService(name, namespace);
@ -82,8 +98,12 @@ export async function findNamespacedService(client: CoreV1Api, name: string, nam
service: service.metadata.name,
port: service.spec.ports[0].port,
};
} catch(error) {
throw new Error(`Failed to list services in namespace="${namespace}": ${isRequestError(error) ? error.response?.body.message : error}`);
} catch (error) {
throw new Error(
`Failed to list services in namespace="${namespace}": ${
isRequestError(error) ? error.response?.body.message : error
}`,
);
}
}

View File

@ -4,16 +4,25 @@
*/
import type { PrometheusProvider } from "./provider";
import { bytesSent, createPrometheusProvider, findFirstNamespacedService, prometheusProviderInjectionToken } from "./provider";
import {
bytesSent,
createPrometheusProvider,
findFirstNamespacedService,
prometheusProviderInjectionToken,
} from "./provider";
import { getInjectable } from "@ogre-tools/injectable";
export const getStacklightLikeQueryFor = ({ rateAccuracy }: { rateAccuracy: string }): PrometheusProvider["getQuery"] => (
export const getStacklightLikeQueryFor =
({ rateAccuracy }: { rateAccuracy: string }): PrometheusProvider["getQuery"] =>
(opts, queryName) => {
switch(opts.category) {
switch (opts.category) {
case "cluster":
switch (queryName) {
case "memoryUsage":
return `sum(node_memory_MemTotal_bytes - (node_memory_MemFree_bytes + node_memory_Buffers_bytes + node_memory_Cached_bytes)) by (kubernetes_name)`.replace(/_bytes/g, `_bytes{node=~"${opts.nodes}"}`);
return `sum(node_memory_MemTotal_bytes - (node_memory_MemFree_bytes + node_memory_Buffers_bytes + node_memory_Cached_bytes)) by (kubernetes_name)`.replace(
/_bytes/g,
`_bytes{node=~"${opts.nodes}"}`,
);
case "workloadMemoryUsage":
return `sum(container_memory_working_set_bytes{container!="POD",container!="",instance=~"${opts.nodes}"}) by (component)`;
case "memoryRequests":
@ -127,20 +136,19 @@ export const getStacklightLikeQueryFor = ({ rateAccuracy }: { rateAccuracy: stri
}
throw new Error(`Unknown queryName="${queryName}" for category="${opts.category}"`);
}
);
};
const stacklightPrometheusProviderInjectable = getInjectable({
id: "stacklight-prometheus-provider",
instantiate: () => createPrometheusProvider({
kind: "stacklight",
name: "Stacklight",
isConfigurable: true,
getService: (client) => findFirstNamespacedService(client, "prometheus-server", "stacklight"),
getQuery: getStacklightLikeQueryFor({ rateAccuracy: "1m" }),
}),
instantiate: () =>
createPrometheusProvider({
kind: "stacklight",
name: "Stacklight",
isConfigurable: true,
getService: (client) => findFirstNamespacedService(client, "prometheus-server", "stacklight"),
getQuery: getStacklightLikeQueryFor({ rateAccuracy: "1m" }),
}),
injectionToken: prometheusProviderInjectionToken,
});
export default stacklightPrometheusProviderInjectable;

View File

@ -0,0 +1,4 @@
{
"extends": "@k8slens/typescript/config/base.json",
"include": ["**/*.ts"]
}

View File

@ -0,0 +1 @@
module.exports = require("@k8slens/webpack").configForNode;