@perses-dev/greptimedb-plugin 0.1.0-beta.0

package/lib/cjs/queries/greptimedb-log-query/GreptimeDBLogQueryEditor.js

@@ -0,0 +1,108 @@
+// Copyright 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, "GreptimeDBLogQueryEditor", {
+    enumerable: true,
+    get: function() {
+        return GreptimeDBLogQueryEditor;
+    }
+});
+const _jsxruntime = require("react/jsx-runtime");
+const _pluginsystem = require("@perses-dev/plugin-system");
+const _react = require("react");
+const _immer = require("immer");
+const _material = require("@mui/material");
+const _constants = require("../constants");
+const _components = require("../../components");
+const _constants1 = require("../../components/constants");
+const _queryeditormodel = require("../query-editor-model");
+function GreptimeDBLogQueryEditor(props) {
+    const theme = (0, _material.useTheme)();
+    const { onChange, value } = props;
+    const { datasource } = value;
+    const selectedDatasource = datasource ?? _constants.DEFAULT_DATASOURCE;
+    const { query, handleQueryChange, handleQueryBlur } = (0, _queryeditormodel.useQueryState)(props);
+    const handleDatasourceChange = (newDatasourceSelection)=>{
+        if (!(0, _pluginsystem.isVariableDatasource)(newDatasourceSelection) && newDatasourceSelection.kind === _constants.DATASOURCE_KIND) {
+            onChange((0, _immer.produce)(value, (draft)=>{
+                draft.datasource = newDatasourceSelection;
+            }));
+            return;
+        }
+        throw new Error('Got unexpected non GreptimeDB datasource selection');
+    };
+    const handleQueryExecute = (queryValue)=>{
+        onChange((0, _immer.produce)(value, (draft)=>{
+            draft.query = queryValue;
+        }));
+    };
+    const handleGreptimeDBQueryChange = (0, _react.useCallback)((e)=>{
+        handleQueryChange(e);
+    }, [
+        handleQueryChange
+    ]);
+    const examplesStyle = {
+        fontSize: '11px',
+        color: theme.palette.text.secondary,
+        backgroundColor: theme.palette.background.code,
+        padding: '8px',
+        borderRadius: '4px',
+        fontFamily: 'Monaco, Menlo, "Ubuntu Mono", monospace',
+        whiteSpace: 'pre-wrap',
+        lineHeight: '1.3'
+    };
+    return /*#__PURE__*/ (0, _jsxruntime.jsxs)(_material.Stack, {
+        spacing: 1.5,
+        children: [
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(_pluginsystem.DatasourceSelect, {
+                datasourcePluginKind: _constants.DATASOURCE_KIND,
+                value: selectedDatasource,
+                onChange: handleDatasourceChange,
+                label: "GreptimeDB Datasource",
+                notched: true
+            }),
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(_components.GreptimeDBQLEditor, {
+                value: query,
+                onChange: handleGreptimeDBQueryChange,
+                onBlur: handleQueryBlur,
+                onKeyDown: (event)=>{
+                    if (event.key === 'Enter' && (event.ctrlKey || event.metaKey)) {
+                        event.preventDefault();
+                        handleQueryExecute(query);
+                    }
+                },
+                placeholder: "Enter GreptimeDB SQL query"
+            }),
+            /*#__PURE__*/ (0, _jsxruntime.jsxs)("details", {
+                children: [
+                    /*#__PURE__*/ (0, _jsxruntime.jsx)("summary", {
+                        style: {
+                            cursor: 'pointer',
+                            fontSize: '12px',
+                            color: theme.palette.text.secondary,
+                            marginBottom: '8px'
+                        },
+                        children: "Query Examples"
+                    }),
+                    /*#__PURE__*/ (0, _jsxruntime.jsx)("div", {
+                        style: examplesStyle,
+                        children: _constants1.queryExample
+                    })
+                ]
+            })
+        ]
+    });
+}

package/lib/cjs/queries/greptimedb-log-query/get-greptimedb-log-data.js

@@ -0,0 +1,103 @@
+// Copyright 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, "getGreptimeDBLogData", {
+    enumerable: true,
+    get: function() {
+        return getGreptimeDBLogData;
+    }
+});
+const _constants = require("../constants");
+const _greptimedbquerydatamodel = require("../greptimedb-query-data-model");
+function buildLogs(records) {
+    const columnSchemas = records?.schema?.column_schemas ?? [];
+    const rows = records?.rows ?? [];
+    if (!columnSchemas.length || !rows.length) {
+        return {
+            entries: [],
+            totalCount: 0
+        };
+    }
+    const timeIndex = (0, _greptimedbquerydatamodel.findTimeColumnIndex)(columnSchemas);
+    if (timeIndex === -1) {
+        return {
+            entries: [],
+            totalCount: 0
+        };
+    }
+    const entries = rows.map((row)=>{
+        const tsMs = (0, _greptimedbquerydatamodel.toTimestampMs)(row?.[timeIndex], columnSchemas[timeIndex]?.data_type);
+        if (tsMs === null) {
+            return null;
+        }
+        const labels = {};
+        const lineParts = [];
+        columnSchemas.forEach((col, index)=>{
+            if (index === timeIndex) {
+                return;
+            }
+            const value = row?.[index];
+            const stringValue = value === null || value === undefined ? '' : String(value);
+            labels[col.name] = stringValue;
+            lineParts.push(`${col.name}=${stringValue === '' ? '--' : stringValue}`);
+        });
+        return {
+            timestamp: Math.floor(tsMs / 1000),
+            labels,
+            line: lineParts.join(' ')
+        };
+    }).filter((entry)=>entry !== null);
+    return {
+        entries,
+        totalCount: entries.length
+    };
+}
+const getGreptimeDBLogData = async (spec, context)=>{
+    if (!spec.query) {
+        return {
+            logs: {
+                entries: [],
+                totalCount: 0
+            },
+            timeRange: {
+                start: context.timeRange.start,
+                end: context.timeRange.end
+            }
+        };
+    }
+    const { start, end } = context.timeRange;
+    const query = (0, _greptimedbquerydatamodel.replaceQueryVariables)(spec.query, context.variableState, context.timeRange);
+    const client = await context.datasourceStore.getDatasourceClient(spec.datasource ?? _constants.DEFAULT_DATASOURCE);
+    const response = await client.query({
+        start: start.getTime().toString(),
+        end: end.getTime().toString(),
+        query
+    });
+    if (response.status === 'error') {
+        throw new Error(response.error ?? 'GreptimeDB query failed');
+    }
+    const records = (0, _greptimedbquerydatamodel.normalizeRecords)(response.data);
+    return {
+        timeRange: {
+            start,
+            end
+        },
+        logs: buildLogs(records),
+        metadata: {
+            executedQueryString: query
+        }
+    };
+};

package/lib/cjs/queries/greptimedb-log-query/greptimedb-log-query-types.js

@@ -0,0 +1,16 @@
+// Copyright 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
+});

package/lib/cjs/queries/greptimedb-log-query/index.js

@@ -0,0 +1,33 @@
+// Copyright 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
+});
+_export_star(require("./GreptimeDBLogQuery"), exports);
+_export_star(require("./GreptimeDBLogQueryEditor"), exports);
+_export_star(require("./get-greptimedb-log-data"), exports);
+_export_star(require("./greptimedb-log-query-types"), 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/queries/greptimedb-log-query/log-query-plugin-interface.js

@@ -0,0 +1,16 @@
+// Copyright 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
+});

package/lib/cjs/queries/greptimedb-query-data-model.js

@@ -0,0 +1,152 @@
+// Copyright 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: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get findTimeColumnIndex () {
+        return findTimeColumnIndex;
+    },
+    get normalizeRecords () {
+        return normalizeRecords;
+    },
+    get replaceQueryVariables () {
+        return replaceQueryVariables;
+    },
+    get toTimestampMs () {
+        return toTimestampMs;
+    }
+});
+const _pluginsystem = require("@perses-dev/plugin-system");
+function replaceQueryVariables(query, variableState, timeRange) {
+    const { start, end } = timeRange;
+    const rangeMs = end.valueOf() - start.valueOf();
+    const builtinState = {
+        __from: {
+            value: start.valueOf().toString(),
+            loading: false
+        },
+        __to: {
+            value: end.valueOf().toString(),
+            loading: false
+        },
+        __range_ms: {
+            value: rangeMs.toString(),
+            loading: false
+        },
+        __range_s: {
+            value: Math.floor(rangeMs / 1000).toString(),
+            loading: false
+        },
+        __range: {
+            value: formatDuration(rangeMs),
+            loading: false
+        }
+    };
+    // User-defined variables take precedence over builtins (matching framework behaviour).
+    return (0, _pluginsystem.replaceVariables)(query, {
+        ...builtinState,
+        ...variableState
+    });
+}
+/** Format a millisecond duration as a human-readable Prometheus-style string, e.g. "1h5m30s". */ function formatDuration(ms) {
+    const totalSeconds = Math.floor(ms / 1000);
+    const hours = Math.floor(totalSeconds / 3600);
+    const minutes = Math.floor(totalSeconds % 3600 / 60);
+    const seconds = totalSeconds % 60;
+    let result = '';
+    if (hours > 0) result += `${hours}h`;
+    if (minutes > 0) result += `${minutes}m`;
+    if (seconds > 0 || result === '') result += `${seconds}s`;
+    return result;
+}
+function normalizeTimestampType(dataType) {
+    if (!dataType) {
+        return null;
+    }
+    return dataType.toLowerCase();
+}
+function toTimestampMs(value, dataType) {
+    if (value === null || value === undefined) {
+        return null;
+    }
+    const normalizedType = normalizeTimestampType(dataType);
+    if (typeof value === 'number') {
+        if (normalizedType) {
+            if (normalizedType.includes('nanosecond')) {
+                return Math.floor(value / 1_000_000);
+            }
+            if (normalizedType.includes('microsecond')) {
+                return Math.floor(value / 1_000);
+            }
+            if (normalizedType.includes('millisecond')) {
+                return value;
+            }
+            if (normalizedType.includes('second')) {
+                return value * 1000;
+            }
+        }
+        if (value > 1_000_000_000_000_000) {
+            return Math.floor(value / 1_000_000);
+        }
+        if (value > 1_000_000_000_000) {
+            return value;
+        }
+        if (value > 1_000_000_000) {
+            return value * 1000;
+        }
+        return value;
+    }
+    if (typeof value === 'string') {
+        const asNumber = Number(value);
+        if (!Number.isNaN(asNumber)) {
+            return toTimestampMs(asNumber, dataType);
+        }
+    }
+    const asDate = new Date(value);
+    const ts = asDate.getTime();
+    return Number.isNaN(ts) ? null : ts;
+}
+function normalizeRecords(payload) {
+    if (!payload || typeof payload !== 'object') return undefined;
+    return payload.output?.[0]?.records;
+}
+function findTimeColumnIndex(columnSchemas) {
+    let timeIndex = -1;
+    const timestampColumns = columnSchemas.filter((col)=>{
+        const normalizedType = normalizeTimestampType(col.data_type);
+        return normalizedType !== null && normalizedType.startsWith('timestamp');
+    });
+    if (timestampColumns.length > 0) {
+        const semanticTimestamp = timestampColumns.find((col)=>col.semantic_type?.toLowerCase() === 'timestamp');
+        const selectedColumn = semanticTimestamp ?? timestampColumns[0];
+        timeIndex = columnSchemas.findIndex((col)=>col.name === selectedColumn.name);
+    }
+    if (timeIndex === -1) {
+        const fallbackColumns = [
+            'greptime_timestamp',
+            'timestamp',
+            'ts',
+            'time'
+        ];
+        timeIndex = columnSchemas.findIndex((col)=>fallbackColumns.includes(col.name.toLowerCase()));
+    }
+    return timeIndex;
+}

package/lib/cjs/queries/greptimedb-time-series-query/GreptimeDBQuery.js

@@ -0,0 +1,43 @@
+// Copyright 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, "GreptimeDBTimeSeriesQuery", {
+    enumerable: true,
+    get: function() {
+        return GreptimeDBTimeSeriesQuery;
+    }
+});
+const _pluginsystem = require("@perses-dev/plugin-system");
+const _getgreptimedbdata = require("./get-greptimedb-data");
+const _GreptimeDBQueryEditor = require("./GreptimeDBQueryEditor");
+const GreptimeDBTimeSeriesQuery = {
+    getTimeSeriesData: _getgreptimedbdata.getTimeSeriesData,
+    OptionsEditorComponent: _GreptimeDBQueryEditor.GreptimeDBTimeSeriesQueryEditor,
+    createInitialOptions: ()=>({
+            query: ''
+        }),
+    dependsOn: (spec)=>{
+        const queryVariables = (0, _pluginsystem.parseVariables)(spec.query);
+        const allVariables = [
+            ...new Set([
+                ...queryVariables
+            ])
+        ];
+        return {
+            variables: allVariables
+        };
+    }
+};

package/lib/cjs/queries/greptimedb-time-series-query/GreptimeDBQueryEditor.js

@@ -0,0 +1,107 @@
+// Copyright 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, "GreptimeDBTimeSeriesQueryEditor", {
+    enumerable: true,
+    get: function() {
+        return GreptimeDBTimeSeriesQueryEditor;
+    }
+});
+const _jsxruntime = require("react/jsx-runtime");
+const _pluginsystem = require("@perses-dev/plugin-system");
+const _react = require("react");
+const _immer = require("immer");
+const _material = require("@mui/material");
+const _constants = require("../constants");
+const _components = require("../../components");
+const _constants1 = require("../../components/constants");
+const _queryeditormodel = require("../query-editor-model");
+function GreptimeDBTimeSeriesQueryEditor(props) {
+    const { onChange, value } = props;
+    const { datasource } = value;
+    const selectedDatasource = datasource ?? _constants.DEFAULT_DATASOURCE;
+    const { query, handleQueryChange, handleQueryBlur } = (0, _queryeditormodel.useQueryState)(props);
+    const handleDatasourceChange = (newDatasourceSelection)=>{
+        if (!(0, _pluginsystem.isVariableDatasource)(newDatasourceSelection) && newDatasourceSelection.kind === _constants.DATASOURCE_KIND) {
+            onChange((0, _immer.produce)(value, (draft)=>{
+                draft.datasource = newDatasourceSelection;
+            }));
+            return;
+        }
+        throw new Error('Got unexpected non GreptimeDB datasource selection');
+    };
+    const handleQueryExecute = (queryValue)=>{
+        onChange((0, _immer.produce)(value, (draft)=>{
+            draft.query = queryValue;
+        }));
+    };
+    const handleGreptimeDBQueryChange = (0, _react.useCallback)((e)=>{
+        handleQueryChange(e);
+    }, [
+        handleQueryChange
+    ]);
+    const examplesStyle = {
+        fontSize: '11px',
+        color: '#777',
+        backgroundColor: '#f5f5f5',
+        padding: '8px',
+        borderRadius: '4px',
+        fontFamily: 'Monaco, Menlo, "Ubuntu Mono", monospace',
+        whiteSpace: 'pre-wrap',
+        lineHeight: '1.3'
+    };
+    return /*#__PURE__*/ (0, _jsxruntime.jsxs)(_material.Stack, {
+        spacing: 1.5,
+        children: [
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(_pluginsystem.DatasourceSelect, {
+                datasourcePluginKind: _constants.DATASOURCE_KIND,
+                value: selectedDatasource,
+                onChange: handleDatasourceChange,
+                label: "GreptimeDB Datasource",
+                notched: true
+            }),
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(_components.GreptimeDBQLEditor, {
+                value: query,
+                onChange: handleGreptimeDBQueryChange,
+                onBlur: handleQueryBlur,
+                onKeyDown: (event)=>{
+                    if (event.key === 'Enter' && (event.ctrlKey || event.metaKey)) {
+                        event.preventDefault();
+                        handleQueryExecute(query);
+                    }
+                },
+                placeholder: "Enter GreptimeDB SQL query"
+            }),
+            /*#__PURE__*/ (0, _jsxruntime.jsxs)("details", {
+                children: [
+                    /*#__PURE__*/ (0, _jsxruntime.jsx)("summary", {
+                        style: {
+                            cursor: 'pointer',
+                            fontSize: '12px',
+                            color: '#666',
+                            marginBottom: '8px'
+                        },
+                        children: "Query Examples"
+                    }),
+                    /*#__PURE__*/ (0, _jsxruntime.jsx)("div", {
+                        style: examplesStyle,
+                        children: _constants1.queryExample
+                    })
+                ]
+            })
+        ]
+    });
+}