@perses-dev/prometheus-plugin 0.50.2 → 0.51.0-beta.2

package/lib/cjs/explore/PrometheusMetricsFinder/utils.js

@@ -0,0 +1,203 @@
+// Copyright 2024 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    useLabelValues: function() {
+        return useLabelValues;
+    },
+    useLabels: function() {
+        return useLabels;
+    },
+    useMetricMetadata: function() {
+        return useMetricMetadata;
+    },
+    useSeriesStates: function() {
+        return useSeriesStates;
+    }
+});
+const _pluginsystem = require("@perses-dev/plugin-system");
+const _reactquery = require("@tanstack/react-query");
+const _react = require("react");
+const _types = require("./types");
+function useMetricMetadata(metricName, datasource, enabled) {
+    const { data: client } = (0, _pluginsystem.useDatasourceClient)(datasource);
+    // histograms and summaries timeseries desc are not always added to prefixed timeseries
+    const name = metricName.replace(/(_count|_sum|_bucket)$/, '');
+    const { data, isLoading, error } = (0, _reactquery.useQuery)({
+        enabled: !!client && enabled,
+        queryKey: [
+            'metricMetadata',
+            name
+        ],
+        queryFn: async ()=>{
+            const params = {
+                metric: name
+            };
+            return await client.metricMetadata(params);
+        }
+    });
+    // Find the first result with help text
+    const metadata = (0, _react.useMemo)(()=>{
+        for (const metric of data?.data?.[name] ?? []){
+            if (metric.help.length > 0) {
+                return metric;
+            }
+        }
+        return undefined;
+    }, [
+        data,
+        name
+    ]);
+    return {
+        metadata,
+        isLoading,
+        error
+    };
+}
+function useLabels(filters, datasource) {
+    const { absoluteTimeRange: { start, end } } = (0, _pluginsystem.useTimeRange)();
+    const { data: client } = (0, _pluginsystem.useDatasourceClient)(datasource);
+    return (0, _reactquery.useQuery)({
+        enabled: !!client,
+        queryKey: [
+            'labels',
+            'datasource',
+            datasource.name,
+            'start',
+            start,
+            'end',
+            end,
+            'filters',
+            ...filters
+        ],
+        queryFn: async ()=>{
+            const params = {
+                start: start.valueOf() / 1000,
+                end: end.valueOf() / 1000
+            };
+            if (filters.length) {
+                params['match[]'] = [
+                    `{${(0, _types.computeFilterExpr)(filters)}}`
+                ];
+            }
+            return await client.labelNames(params);
+        }
+    });
+}
+function useLabelValues(labelName, filters, datasource) {
+    const { absoluteTimeRange: { start, end } } = (0, _pluginsystem.useTimeRange)();
+    const { data: client } = (0, _pluginsystem.useDatasourceClient)(datasource);
+    return (0, _reactquery.useQuery)({
+        enabled: !!client,
+        queryKey: [
+            'labelValues',
+            labelName,
+            'datasource',
+            datasource.name,
+            'start',
+            start,
+            'end',
+            'filters',
+            ...filters
+        ],
+        queryFn: async ()=>{
+            const params = {
+                labelName: labelName,
+                start: start.valueOf() / 1000,
+                end: end.valueOf() / 1000
+            };
+            if (filters.length) {
+                params['match[]'] = [
+                    `{${(0, _types.computeFilterExpr)(filters)}}`
+                ];
+            }
+            return await client.labelValues(params);
+        }
+    });
+}
+function useSeriesStates(metricName, filters, datasource) {
+    const { absoluteTimeRange: { start, end } } = (0, _pluginsystem.useTimeRange)();
+    const { data: client } = (0, _pluginsystem.useDatasourceClient)(datasource);
+    const { data: seriesData, isLoading, isError, error } = (0, _reactquery.useQuery)({
+        enabled: !!client,
+        queryKey: [
+            'series',
+            metricName,
+            'datasource',
+            datasource,
+            'start',
+            start,
+            'end',
+            'filters',
+            ...filters
+        ],
+        queryFn: async ()=>{
+            const params = {
+                'match[]': [
+                    `{${(0, _types.computeFilterExpr)(filters)}}`
+                ],
+                start: start.valueOf() / 1000,
+                end: end.valueOf() / 1000
+            };
+            return await client.series(params);
+        }
+    });
+    const labelValueCounters = (0, _react.useMemo)(()=>{
+        const result = new Map();
+        if (seriesData?.data === undefined) {
+            return result;
+        }
+        for (const series of seriesData.data){
+            for (const [label, value] of Object.entries(series)){
+                const labelCounters = result.get(label);
+                if (labelCounters === undefined) {
+                    result.set(label, [
+                        {
+                            labelValue: value,
+                            counter: 1
+                        }
+                    ]);
+                    continue;
+                }
+                const labelValueCounter = labelCounters.find((counter)=>counter.labelValue === value);
+                if (labelValueCounter === undefined) {
+                    labelCounters.push({
+                        labelValue: value,
+                        counter: 1
+                    });
+                } else {
+                    labelValueCounter.counter += 1;
+                }
+            }
+        }
+        return result;
+    }, [
+        seriesData
+    ]);
+    return {
+        series: seriesData?.data,
+        labelValueCounters,
+        isLoading,
+        isError,
+        error
+    };
+}

package/lib/cjs/explore/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./PrometheusMetricsFinder"), exports);
+_export_star(require("./PrometheusExplorer"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}

package/lib/cjs/getPluginModule.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "getPluginModule", {
+    enumerable: true,
+    get: function() {
+        return getPluginModule;
+    }
+});
+const _packagejson = /*#__PURE__*/ _interop_require_default(require("../package.json"));
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function getPluginModule() {
+    const { name, version, perses } = _packagejson.default;
+    return {
+        kind: 'PluginModule',
+        metadata: {
+            name,
+            version
+        },
+        spec: perses
+    };
+}

package/lib/cjs/index-federation.js

@@ -0,0 +1,55 @@
+// Copyright 2024 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+"use strict";
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interop_require_wildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {
+        __proto__: null
+    };
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+Promise.resolve().then(()=>/*#__PURE__*/ _interop_require_wildcard(require("./bootstrap")));

package/lib/cjs/index.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "getPluginModule", {
+    enumerable: true,
+    get: function() {
+        return _getPluginModule.getPluginModule;
+    }
+});
+_export_star(require("./components"), exports);
+_export_star(require("./explore"), exports);
+const _getPluginModule = require("./getPluginModule");
+_export_star(require("./model"), exports);
+_export_star(require("./plugins"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}

package/{dist → lib}/cjs/model/api-types.js

@@ -1,4 +1,4 @@
-// Copyright 2023 The Perses Authors
+// Copyright 2025 The Perses Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at

package/{dist → lib}/cjs/model/prometheus-client.js

@@ -58,7 +58,7 @@ function healthCheck(queryOptions) {
                 headers: queryOptions.headers
             });
             return resp.status === 200;
-        } catch (e) {
+        } catch  {
             return false;
         }
     };

package/lib/cjs/plugins/PrometheusDatasourceEditor.js

@@ -0,0 +1,109 @@
+// Copyright 2023 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "PrometheusDatasourceEditor", {
+    enumerable: true,
+    get: function() {
+        return PrometheusDatasourceEditor;
+    }
+});
+const _jsxruntime = require("react/jsx-runtime");
+const _pluginsystem = require("@perses-dev/plugin-system");
+const _material = require("@mui/material");
+const _react = /*#__PURE__*/ _interop_require_default(require("react"));
+const _types = require("./types");
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function PrometheusDatasourceEditor(props) {
+    const { value, onChange, isReadonly } = props;
+    const initialSpecDirect = {
+        directUrl: ''
+    };
+    const initialSpecProxy = {
+        proxy: {
+            kind: 'HTTPProxy',
+            spec: {
+                allowedEndpoints: [
+                    // list of standard endpoints suggested by default
+                    {
+                        endpointPattern: '/api/v1/labels',
+                        method: 'POST'
+                    },
+                    {
+                        endpointPattern: '/api/v1/series',
+                        method: 'POST'
+                    },
+                    {
+                        endpointPattern: '/api/v1/metadata',
+                        method: 'GET'
+                    },
+                    {
+                        endpointPattern: '/api/v1/query',
+                        method: 'POST'
+                    },
+                    {
+                        endpointPattern: '/api/v1/query_range',
+                        method: 'POST'
+                    },
+                    {
+                        endpointPattern: '/api/v1/label/([a-zA-Z0-9_-]+)/values',
+                        method: 'GET'
+                    },
+                    {
+                        endpointPattern: '/api/v1/parse_query',
+                        method: 'POST'
+                    }
+                ],
+                url: ''
+            }
+        }
+    };
+    return /*#__PURE__*/ (0, _jsxruntime.jsxs)(_jsxruntime.Fragment, {
+        children: [
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.Typography, {
+                variant: "h4",
+                mb: 2,
+                children: "General Settings"
+            }),
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.TextField, {
+                fullWidth: true,
+                label: "Scrape Interval",
+                value: value.scrapeInterval || '',
+                placeholder: `Default: ${_types.DEFAULT_SCRAPE_INTERVAL}`,
+                InputProps: {
+                    readOnly: isReadonly
+                },
+                InputLabelProps: {
+                    shrink: isReadonly ? true : undefined
+                },
+                onChange: (e)=>onChange({
+                        ...value,
+                        scrapeInterval: e.target.value
+                    })
+            }),
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(_pluginsystem.HTTPSettingsEditor, {
+                value: value,
+                onChange: onChange,
+                isReadonly: isReadonly,
+                initialSpecDirect: initialSpecDirect,
+                initialSpecProxy: initialSpecProxy
+            })
+        ]
+    });
+}

package/lib/cjs/plugins/PrometheusLabelNamesVariable.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "PrometheusLabelNamesVariable", {
+    enumerable: true,
+    get: function() {
+        return PrometheusLabelNamesVariable;
+    }
+});
+const _pluginsystem = require("@perses-dev/plugin-system");
+const _model = require("../model");
+const _prometheusvariables = require("./prometheus-variables");
+const PrometheusLabelNamesVariable = {
+    getVariableOptions: async (spec, ctx)=>{
+        const client = await ctx.datasourceStore.getDatasourceClient(spec.datasource ?? _model.DEFAULT_PROM);
+        const match = spec.matchers ? spec.matchers.map((m)=>(0, _pluginsystem.replaceVariables)(m, ctx.variables)) : undefined;
+        const timeRange = (0, _model.getPrometheusTimeRange)(ctx.timeRange);
+        const { data: options } = await client.labelNames({
+            'match[]': match,
+            ...timeRange
+        });
+        return {
+            data: (0, _prometheusvariables.stringArrayToVariableOptions)(options)
+        };
+    },
+    dependsOn: (spec)=>{
+        return {
+            variables: spec.matchers?.map((m)=>(0, _pluginsystem.parseVariables)(m)).flat() || []
+        };
+    },
+    OptionsEditorComponent: _prometheusvariables.PrometheusLabelNamesVariableEditor,
+    createInitialOptions: ()=>({})
+};

package/lib/cjs/plugins/PrometheusLabelValuesVariable.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "PrometheusLabelValuesVariable", {
+    enumerable: true,
+    get: function() {
+        return PrometheusLabelValuesVariable;
+    }
+});
+const _pluginsystem = require("@perses-dev/plugin-system");
+const _model = require("../model");
+const _prometheusvariables = require("./prometheus-variables");
+const PrometheusLabelValuesVariable = {
+    getVariableOptions: async (spec, ctx)=>{
+        const pluginDef = spec;
+        const client = await ctx.datasourceStore.getDatasourceClient(spec.datasource ?? _model.DEFAULT_PROM);
+        const match = pluginDef.matchers ? pluginDef.matchers.map((m)=>(0, _pluginsystem.replaceVariables)(m, ctx.variables)) : undefined;
+        const timeRange = (0, _model.getPrometheusTimeRange)(ctx.timeRange);
+        const { data: options } = await client.labelValues({
+            labelName: (0, _pluginsystem.replaceVariables)(pluginDef.labelName, ctx.variables),
+            'match[]': match,
+            ...timeRange
+        });
+        return {
+            data: (0, _prometheusvariables.stringArrayToVariableOptions)(options)
+        };
+    },
+    dependsOn: (spec)=>{
+        return {
+            variables: spec.matchers?.map((m)=>(0, _pluginsystem.parseVariables)(m)).flat().concat((0, _pluginsystem.parseVariables)(spec.labelName)) || []
+        };
+    },
+    OptionsEditorComponent: _prometheusvariables.PrometheusLabelValuesVariableEditor,
+    createInitialOptions: ()=>({
+            labelName: ''
+        })
+};

package/lib/cjs/plugins/PrometheusPromQLVariable.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "PrometheusPromQLVariable", {
+    enumerable: true,
+    get: function() {
+        return PrometheusPromQLVariable;
+    }
+});
+const _pluginsystem = require("@perses-dev/plugin-system");
+const _model = require("../model");
+const _prometheusvariables = require("./prometheus-variables");
+const PrometheusPromQLVariable = {
+    getVariableOptions: async (spec, ctx)=>{
+        const client = await ctx.datasourceStore.getDatasourceClient(spec.datasource ?? _model.DEFAULT_PROM);
+        // TODO we may want to manage a range query as well.
+        const { data: options } = await client.instantQuery({
+            query: (0, _pluginsystem.replaceVariables)(spec.expr, ctx.variables)
+        });
+        const labelName = (0, _pluginsystem.replaceVariables)(spec.labelName, ctx.variables);
+        let values = [];
+        if (options?.resultType === 'matrix') {
+            values = (0, _prometheusvariables.capturingMatrix)(options, labelName);
+        } else if (options?.resultType === 'vector') {
+            values = (0, _prometheusvariables.capturingVector)(options, labelName);
+        }
+        return {
+            data: (0, _prometheusvariables.stringArrayToVariableOptions)(values)
+        };
+    },
+    dependsOn: (spec)=>{
+        return {
+            variables: (0, _pluginsystem.parseVariables)(spec.expr).concat((0, _pluginsystem.parseVariables)(spec.labelName))
+        };
+    },
+    OptionsEditorComponent: _prometheusvariables.PrometheusPromQLVariableEditor,
+    createInitialOptions: ()=>({
+            expr: '',
+            labelName: ''
+        })
+};

package/lib/cjs/plugins/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./MatcherEditor"), exports);
+_export_star(require("./prometheus-datasource"), exports);
+_export_star(require("./prometheus-time-series-query"), exports);
+_export_star(require("./prometheus-variables"), exports);
+_export_star(require("./PrometheusDatasourceEditor"), exports);
+_export_star(require("./PrometheusLabelNamesVariable"), exports);
+_export_star(require("./PrometheusPromQLVariable"), exports);
+_export_star(require("./types"), exports);
+_export_star(require("./variable"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}

package/{dist → lib}/cjs/plugins/prometheus-datasource.js

@@ -28,11 +28,11 @@ const _PrometheusDatasourceEditor = require("./PrometheusDatasourceEditor");
     const { directUrl, proxy } = spec;
     const { proxyUrl } = options;
     // Use the direct URL if specified, but fallback to the proxyUrl by default if not specified
-    const datasourceUrl = directUrl !== null && directUrl !== void 0 ? directUrl : proxyUrl;
+    const datasourceUrl = directUrl ?? proxyUrl;
     if (datasourceUrl === undefined) {
         throw new Error('No URL specified for Prometheus client. You can use directUrl in the spec to configure it.');
     }
-    const specHeaders = proxy === null || proxy === void 0 ? void 0 : proxy.spec.headers;
+    const specHeaders = proxy?.spec.headers;
     // Could think about this becoming a class, although it definitely doesn't have to be
     return {
         options: {
@@ -44,31 +44,31 @@ const _PrometheusDatasourceEditor = require("./PrometheusDatasourceEditor");
         }),
         instantQuery: (params, headers)=>(0, _model.instantQuery)(params, {
                 datasourceUrl,
-                headers: headers !== null && headers !== void 0 ? headers : specHeaders
+                headers: headers ?? specHeaders
             }),
         rangeQuery: (params, headers)=>(0, _model.rangeQuery)(params, {
                 datasourceUrl,
-                headers: headers !== null && headers !== void 0 ? headers : specHeaders
+                headers: headers ?? specHeaders
             }),
         labelNames: (params, headers)=>(0, _model.labelNames)(params, {
                 datasourceUrl,
-                headers: headers !== null && headers !== void 0 ? headers : specHeaders
+                headers: headers ?? specHeaders
             }),
         labelValues: (params, headers)=>(0, _model.labelValues)(params, {
                 datasourceUrl,
-                headers: headers !== null && headers !== void 0 ? headers : specHeaders
+                headers: headers ?? specHeaders
             }),
         metricMetadata: (params, headers)=>(0, _model.metricMetadata)(params, {
                 datasourceUrl,
-                headers: headers !== null && headers !== void 0 ? headers : specHeaders
+                headers: headers ?? specHeaders
             }),
         series: (params, headers)=>(0, _model.series)(params, {
                 datasourceUrl,
-                headers: headers !== null && headers !== void 0 ? headers : specHeaders
+                headers: headers ?? specHeaders
             }),
         parseQuery: (params, headers)=>(0, _model.parseQuery)(params, {
                 datasourceUrl,
-                headers: headers !== null && headers !== void 0 ? headers : specHeaders
+                headers: headers ?? specHeaders
             })
     };
 };