@perses-dev/prometheus-plugin 0.8.0 → 0.9.0

package/plugin.json

@@ -7,35 +7,43 @@
     "plugins": [
       {
         "pluginType": "Variable",
-        "kind": "PrometheusLabelNames",
+        "kind": "StaticListVariable",
         "display": {
-          "name": "Prometheus Label Names",
-          "description": ""
+          "name": "Static List Variable",
+          "description": "Static list variables allow you to define an array of values"
         }
       },
       {
         "pluginType": "Variable",
-        "kind": "PrometheusLabelValues",
+        "kind": "PrometheusLabelValuesVariable",
         "display": {
-          "name": "Prometheus Label Values",
+          "name": "PrometheusLabelValuesVariable",
           "description": ""
         }
       },
       {
         "pluginType": "Variable",
-        "kind": "Interval",
+        "kind": "PrometheusLabelNamesVariable",
         "display": {
-          "name": "Time Duration",
+          "name": "PrometheusLabelNamesVariable",
           "description": ""
         }
       },
       {
-        "pluginType": "GraphQuery",
-        "kind": "PrometheusGraphQuery",
+        "pluginType": "TimeSeriesQuery",
+        "kind": "PrometheusTimeSeriesQuery",
         "display": {
           "name": "Prometheus Range Query",
           "description": ""
         }
+      },
+      {
+        "pluginType": "Datasource",
+        "kind": "PrometheusDatasource",
+        "display": {
+          "name": "Prometheus Datasource",
+          "description": ""
+        }
       }
     ]
   }

package/dist/cjs/model/datasource.js

@@ -1,36 +0,0 @@
-"use strict";
-// Copyright 2021 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.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.usePrometheusConfig = void 0;
-const plugin_system_1 = require("@perses-dev/plugin-system");
-function isPrometheusDatasource(def) {
-    return def.kind === 'Prometheus';
-}
-function usePrometheusConfig(selector) {
-    const datasources = (0, plugin_system_1.useDatasources)();
-    const models = selector === undefined ? [datasources.defaultDatasource] : datasources.getDatasources(selector);
-    if (models.length > 1) {
-        throw new Error('More than one Datasource found');
-    }
-    const model = models[0];
-    if (model === undefined) {
-        throw new Error('Datasource not found');
-    }
-    const spec = model.spec;
-    if (isPrometheusDatasource(spec)) {
-        return { ...model, spec };
-    }
-    throw new Error('Datasource is not a valid Prometheus Datasource');
-}
-exports.usePrometheusConfig = usePrometheusConfig;

package/dist/cjs/plugins/graph-query.js

@@ -1,84 +0,0 @@
-"use strict";
-// Copyright 2022 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.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrometheusGraphQuery = void 0;
-const core_1 = require("@perses-dev/core");
-const date_fns_1 = require("date-fns");
-const react_1 = require("react");
-const parse_sample_values_1 = require("../model/parse-sample-values");
-const prometheus_client_1 = require("../model/prometheus-client");
-const templating_1 = require("../model/templating");
-const time_1 = require("../model/time");
-function usePrometheusGraphQuery(definition, hookOptions) {
-    const minStep = (0, time_1.getDurationStringSeconds)(definition.options.min_step);
-    const timeRange = (0, time_1.useDashboardPrometheusTimeRange)();
-    const step = (0, time_1.usePanelRangeStep)(timeRange, minStep, undefined, hookOptions === null || hookOptions === void 0 ? void 0 : hookOptions.suggestedStepMs);
-    // Align the time range so that it's a multiple of the step (TODO: we may
-    // ultimately want to return this from the hook so that charts will know what
-    // time range was actually used?)
-    const { start, end } = (0, core_1.useMemoized)(() => {
-        const { start, end } = timeRange;
-        const utcOffsetSec = new Date().getTimezoneOffset() * 60;
-        const alignedEnd = Math.floor((end + utcOffsetSec) / step) * step - utcOffsetSec;
-        const alignedStart = Math.floor((start + utcOffsetSec) / step) * step - utcOffsetSec;
-        return {
-            start: alignedStart,
-            end: alignedEnd,
-        };
-    }, [timeRange, step]);
-    const query = (0, templating_1.useReplaceTemplateString)(definition.options.query.replace('$__rate_interval', `15s`));
-    const request = {
-        query,
-        start,
-        end,
-        step,
-    };
-    const { data: response, isLoading: loading, error, } = (0, prometheus_client_1.useRangeQuery)(request, {
-        enabled: true,
-    });
-    const data = (0, react_1.useMemo)(() => {
-        if (response === undefined)
-            return undefined;
-        if (response.status === 'error')
-            return undefined;
-        // TODO: Maybe do a proper Iterable implementation that defers some of this
-        // processing until its needed
-        const chartData = {
-            timeRange: { start: (0, date_fns_1.fromUnixTime)(start), end: (0, date_fns_1.fromUnixTime)(end) },
-            stepMs: step * 1000,
-            series: response.data.result.map((value) => {
-                const { metric, values } = value;
-                // Name the series after the metric labels or if no metric, just use the
-                // overall query
-                let name = Object.entries(metric)
-                    .map(([labelName, labelValue]) => `${labelName}="${labelValue}"`)
-                    .join(', ');
-                if (name === '')
-                    name = query;
-                return {
-                    name,
-                    values: values.map(parse_sample_values_1.parseValueTuple),
-                };
-            }),
-        };
-        return chartData;
-    }, [response, start, end, step, query]);
-    return { data, loading, error: error !== null && error !== void 0 ? error : undefined };
-}
-/**
- * The core Prometheus GraphQuery plugin for Perses.
- */
-exports.PrometheusGraphQuery = {
-    useGraphQuery: usePrometheusGraphQuery,
-};

package/dist/model/datasource.d.ts

@@ -1,11 +0,0 @@
-import { DatasourceSelector, DatasourceSpecDefinition, HTTPConfig } from '@perses-dev/core';
-export interface PrometheusSpecDatasource extends DatasourceSpecDefinition {
-    kind: 'Prometheus';
-    http: HTTPConfig;
-}
-export declare function usePrometheusConfig(selector?: DatasourceSelector): {
-    spec: PrometheusSpecDatasource;
-    kind: "GlobalDatasource";
-    metadata: import("@perses-dev/core").Metadata;
-};
-//# sourceMappingURL=datasource.d.ts.map

package/dist/model/datasource.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"datasource.d.ts","sourceRoot":"","sources":["../../src/model/datasource.ts"],"names":[],"mappings":"AAaA,OAAO,EAEL,kBAAkB,EAClB,wBAAwB,EACxB,UAAU,EACX,MAAM,kBAAkB,CAAC;AAG1B,MAAM,WAAW,wBAAyB,SAAQ,wBAAwB;IACxE,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;CAClB;AAMD,wBAAgB,mBAAmB,CAAC,QAAQ,CAAC,EAAE,kBAAkB;;;;EAmBhE"}

package/dist/model/datasource.js

@@ -1 +0,0 @@
-import{useDatasources}from"@perses-dev/plugin-system";function isPrometheusDatasource(e){return"Prometheus"===e.kind}export function usePrometheusConfig(e){const o=useDatasources(),r=void 0===e?[o.defaultDatasource]:o.getDatasources(e);if(r.length>1)throw new Error("More than one Datasource found");const t=r[0];if(void 0===t)throw new Error("Datasource not found");const s=t.spec;if(isPrometheusDatasource(s))return{...t,spec:s};throw new Error("Datasource is not a valid Prometheus Datasource")}

package/dist/plugins/graph-query.d.ts

@@ -1,14 +0,0 @@
-import { DurationString, JsonObject } from '@perses-dev/core';
-import { GraphQueryPlugin } from '@perses-dev/plugin-system';
-import { TemplateString } from '../model/templating';
-interface PrometheusGraphQueryOptions extends JsonObject {
-    query: TemplateString;
-    min_step?: DurationString;
-    resolution?: number;
-}
-/**
- * The core Prometheus GraphQuery plugin for Perses.
- */
-export declare const PrometheusGraphQuery: GraphQueryPlugin<PrometheusGraphQueryOptions>;
-export {};
-//# sourceMappingURL=graph-query.d.ts.map

package/dist/plugins/graph-query.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"graph-query.d.ts","sourceRoot":"","sources":["../../src/plugins/graph-query.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAe,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAGL,gBAAgB,EAGjB,MAAM,2BAA2B,CAAC;AAMnC,OAAO,EAAE,cAAc,EAA4B,MAAM,qBAAqB,CAAC;AAG/E,UAAU,2BAA4B,SAAQ,UAAU;IACtD,KAAK,EAAE,cAAc,CAAC;IACtB,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AA2ED;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,gBAAgB,CAAC,2BAA2B,CAE9E,CAAC"}

package/dist/plugins/graph-query.js

@@ -1 +0,0 @@
-import{useMemoized}from"@perses-dev/core";import{fromUnixTime}from"date-fns";import{useMemo}from"react";import{parseValueTuple}from"../model/parse-sample-values";import{useRangeQuery}from"../model/prometheus-client";import{useReplaceTemplateString}from"../model/templating";import{getDurationStringSeconds,useDashboardPrometheusTimeRange,usePanelRangeStep}from"../model/time";function usePrometheusGraphQuery(e,r){const t=getDurationStringSeconds(e.options.min_step),o=useDashboardPrometheusTimeRange(),s=usePanelRangeStep(o,t,void 0,null==r?void 0:r.suggestedStepMs),{start:a,end:n}=useMemoized((()=>{const{start:e,end:r}=o,t=60*(new Date).getTimezoneOffset(),a=Math.floor((r+t)/s)*s-t;return{start:Math.floor((e+t)/s)*s-t,end:a}}),[o,s]),m=useReplaceTemplateString(e.options.query.replace("$__rate_interval","15s")),u={query:m,start:a,end:n,step:s},{data:i,isLoading:p,error:l}=useRangeQuery(u,{enabled:!0});return{data:useMemo((()=>{if(void 0!==i&&"error"!==i.status)return{timeRange:{start:fromUnixTime(a),end:fromUnixTime(n)},stepMs:1e3*s,series:i.data.result.map((e=>{const{metric:r,values:t}=e;let o=Object.entries(r).map((([e,r])=>`${e}="${r}"`)).join(", ");return""===o&&(o=m),{name:o,values:t.map(parseValueTuple)}}))}}),[i,a,n,s,m]),loading:p,error:null!=l?l:void 0}}export const PrometheusGraphQuery={useGraphQuery:usePrometheusGraphQuery};