@perses-dev/tempo-plugin 0.52.0 → 0.53.0

package/lib/cjs/components/AttributeFilters.js

@@ -0,0 +1,274 @@
+// 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
+//
+// 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, "AttributeFilters", {
+    enumerable: true,
+    get: function() {
+        return AttributeFilters;
+    }
+});
+const _jsxruntime = require("react/jsx-runtime");
+const _react = require("react");
+const _material = require("@mui/material");
+const _core = require("@perses-dev/core");
+const _pluginsystem = require("@perses-dev/plugin-system");
+const _reactquery = require("@tanstack/react-query");
+const _CheckboxOutline = /*#__PURE__*/ _interop_require_default(require("mdi-material-ui/CheckboxOutline"));
+const _CheckboxBlankOutline = /*#__PURE__*/ _interop_require_default(require("mdi-material-ui/CheckboxBlankOutline"));
+const _filter_to_traceql = require("./filter/filter_to_traceql");
+const _traceql_to_filter = require("./filter/traceql_to_filter");
+const _filter = require("./filter/filter");
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+const statusOptions = [
+    'unset',
+    'ok',
+    'error'
+];
+function AttributeFilters(props) {
+    const { client, query, setQuery } = props;
+    const filter = (0, _traceql_to_filter.traceQLToFilter)(query);
+    const setFilter = (filter)=>{
+        setQuery((0, _filter_to_traceql.filterToTraceQL)(filter));
+    };
+    const { timeRange } = (0, _pluginsystem.useTimeRange)();
+    const absTimeRange = !(0, _core.isAbsoluteTimeRange)(timeRange) ? (0, _core.toAbsoluteTimeRange)(timeRange) : timeRange;
+    const startTime = Math.round(absTimeRange.start.getTime() / 1000);
+    const endTime = Math.round(absTimeRange.end.getTime() / 1000);
+    const { data: serviceNameOptions } = useTagValues(client, 'resource.service.name', (0, _filter_to_traceql.filterToTraceQL)({
+        ...filter,
+        serviceName: []
+    }), startTime, endTime);
+    const { data: spanNameOptions } = useTagValues(client, 'name', (0, _filter_to_traceql.filterToTraceQL)({
+        ...filter,
+        spanName: []
+    }), startTime, endTime);
+    return /*#__PURE__*/ (0, _jsxruntime.jsxs)(_jsxruntime.Fragment, {
+        children: [
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(StringAttributeFilter, {
+                label: "Service Name",
+                options: serviceNameOptions ?? [],
+                value: filter.serviceName,
+                setValue: (x)=>setFilter({
+                        ...filter,
+                        serviceName: x
+                    })
+            }),
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(StringAttributeFilter, {
+                label: "Span Name",
+                options: spanNameOptions ?? [],
+                value: filter.spanName,
+                setValue: (x)=>setFilter({
+                        ...filter,
+                        spanName: x
+                    })
+            }),
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(StringAttributeFilter, {
+                label: "Status",
+                width: 210,
+                options: statusOptions ?? [],
+                value: filter.status,
+                setValue: (x)=>setFilter({
+                        ...filter,
+                        status: x
+                    })
+            }),
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(DurationAttributeFilter, {
+                label: "Trace Duration",
+                value: filter.traceDuration,
+                setValue: (value)=>setFilter({
+                        ...filter,
+                        traceDuration: value
+                    })
+            }),
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(CustomAttributesFilter, {
+                label: "Custom Attributes",
+                value: filter.customMatchers,
+                setValue: (value)=>setFilter({
+                        ...filter,
+                        customMatchers: value
+                    })
+            })
+        ]
+    });
+}
+const checkboxBlankIcon = /*#__PURE__*/ (0, _jsxruntime.jsx)(_CheckboxBlankOutline.default, {
+    fontSize: "small"
+});
+const checkedMarkedIcon = /*#__PURE__*/ (0, _jsxruntime.jsx)(_CheckboxOutline.default, {
+    fontSize: "small"
+});
+function StringAttributeFilter(props) {
+    const { label, width, options, value, setValue } = props;
+    return /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.Autocomplete, {
+        multiple: true,
+        size: "small",
+        limitTags: 1,
+        disableCloseOnSelect: true,
+        value: value,
+        onChange: (_event, newValue)=>setValue(newValue),
+        options: options,
+        renderOption: (props, option, { selected })=>{
+            const { key, ...optionProps } = props;
+            return /*#__PURE__*/ (0, _jsxruntime.jsxs)("li", {
+                ...optionProps,
+                children: [
+                    /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.Checkbox, {
+                        icon: checkboxBlankIcon,
+                        checkedIcon: checkedMarkedIcon,
+                        style: {
+                            marginRight: 8
+                        },
+                        checked: selected
+                    }),
+                    option
+                ]
+            }, key);
+        },
+        renderInput: (params)=>/*#__PURE__*/ (0, _jsxruntime.jsx)(_material.TextField, {
+                ...params,
+                label: label
+            }),
+        // Reduce the size of the chips to make space for the <input> element, the +X text and the X button to avoid a line break.
+        // See https://github.com/mui/material-ui/issues/38835 for more details.
+        slotProps: {
+            chip: {
+                sx: {
+                    maxWidth: 'calc(100% - 45px) !important'
+                }
+            }
+        },
+        // Reduce the size of the <input> field
+        sx: {
+            width: width ?? 250,
+            '& input': {
+                minWidth: '5px !important'
+            }
+        }
+    });
+}
+function DurationAttributeFilter(props) {
+    const { label, value, setValue } = props;
+    const { min, max } = value;
+    return /*#__PURE__*/ (0, _jsxruntime.jsxs)(_material.Stack, {
+        direction: "row",
+        gap: 0.5,
+        children: [
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(DurationTextInput, {
+                label: `Min ${label}`,
+                value: min ?? '',
+                setValue: (min)=>setValue({
+                        min,
+                        max
+                    })
+            }),
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(DurationTextInput, {
+                label: `Max ${label}`,
+                value: max ?? '',
+                setValue: (max)=>setValue({
+                        min,
+                        max
+                    })
+            })
+        ]
+    });
+}
+const durationFormatRegex = /^([0-9]+\.)?[0-9]+(ns|ms|s|m|h)$/;
+function DurationTextInput(props) {
+    const { label, value, setValue } = props;
+    return /*#__PURE__*/ (0, _jsxruntime.jsx)(LazyTextInput, {
+        label: label,
+        size: "small",
+        value: value,
+        setValue: setValue,
+        validationRegex: durationFormatRegex,
+        validationFailedMessage: "Invalid format. Accepted format e.g. 100ms, accepted units: ns, ms, s, m, h",
+        sx: {
+            width: 150
+        }
+    });
+}
+function CustomAttributesFilter(props) {
+    const { label, value, setValue } = props;
+    return /*#__PURE__*/ (0, _jsxruntime.jsx)(LazyTextInput, {
+        label: label,
+        size: "small",
+        placeholder: 'span.http.status_code=200 span.http.method="GET"',
+        value: value.join(' '),
+        setValue: (x)=>setValue((0, _filter.splitByUnquotedWhitespace)(x)),
+        sx: {
+            flexGrow: 1
+        }
+    });
+}
+/** A <TextField> which calls props.setValue when the input field is blurred and the validation passes. */ function LazyTextInput(props) {
+    const { validationRegex, validationFailedMessage, value, setValue, ...otherProps } = props;
+    const [draftValue, setDraftValue] = (0, _react.useState)(value);
+    const isValidInput = draftValue == '' || validationRegex == undefined || validationRegex.test(draftValue);
+    (0, _react.useEffect)(()=>{
+        setDraftValue(value);
+    }, [
+        value,
+        setDraftValue
+    ]);
+    const handleChange = (0, _react.useCallback)((event)=>{
+        setDraftValue(event.target.value);
+    }, []);
+    const handleBlur = (0, _react.useCallback)(()=>{
+        if (isValidInput) {
+            setValue(draftValue);
+        }
+    }, [
+        isValidInput,
+        setValue,
+        draftValue
+    ]);
+    return /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.TextField, {
+        ...otherProps,
+        error: !isValidInput,
+        helperText: isValidInput ? undefined : validationFailedMessage,
+        value: draftValue,
+        onChange: handleChange,
+        onBlur: handleBlur
+    });
+}
+function useTagValues(client, tag, query, start, end) {
+    return (0, _reactquery.useQuery)({
+        queryKey: [
+            'useTagValues',
+            client,
+            tag,
+            query,
+            start,
+            end
+        ],
+        enabled: !!client,
+        queryFn: async function() {
+            if (!client) return;
+            const values = await client.searchTagValues({
+                tag,
+                q: query,
+                start,
+                end
+            });
+            return values.tagValues.map((tagValue)=>tagValue.value ?? '').sort();
+        },
+        staleTime: 60 * 1000
+    });
+}

package/lib/cjs/components/TraceQLEditor.js

@@ -25,6 +25,7 @@ const _react = require("react");
 const _material = require("@mui/material");
 const _reactcodemirror = /*#__PURE__*/ _interop_require_wildcard(require("@uiw/react-codemirror"));
 const _core = require("@perses-dev/core");
+const _pluginsystem = require("@perses-dev/plugin-system");
 const _TraceQLExtension = require("./TraceQLExtension");
 function _getRequireWildcardCache(nodeInterop) {
     if (typeof WeakMap !== "function") return null;
@@ -67,13 +68,18 @@ function _interop_require_wildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-function TraceQLEditor({ completionConfig, ...rest }) {
+function TraceQLEditor({ client, ...rest }) {
     const theme = (0, _material.useTheme)();
     const isDarkMode = theme.palette.mode === 'dark';
+    const { timeRange } = (0, _pluginsystem.useTimeRange)();
     const traceQLExtension = (0, _react.useMemo)(()=>{
-        return (0, _TraceQLExtension.TraceQLExtension)(completionConfig);
+        return (0, _TraceQLExtension.TraceQLExtension)({
+            client,
+            timeRange
+        });
     }, [
-        completionConfig
+        client,
+        timeRange
     ]);
     const codemirrorTheme = (0, _react.useMemo)(()=>{
         // https://github.com/mui/material-ui/blob/v5.16.7/packages/mui-material/src/OutlinedInput/OutlinedInput.js#L43

package/lib/cjs/components/complete.js

@@ -21,6 +21,9 @@ function _export(target, all) {
     });
 }
 _export(exports, {
+    applyQuotedCompletion: function() {
+        return applyQuotedCompletion;
+    },
     complete: function() {
         return complete;
     },
@@ -32,6 +35,11 @@ const _autocomplete = require("@codemirror/autocomplete");
 const _language = require("@codemirror/language");
 const _lezertraceql = require("@grafana/lezer-traceql");
 const _core = require("@perses-dev/core");
+const quoteChars = [
+    '"',
+    '`'
+];
+const defaultQuoteChar = '"';
 async function complete(completionCfg, { state, pos }) {
     // First, identify the completion scopes, for example Scopes() and TagName(scope=intrinsic)
     const completions = identifyCompletions(state, pos, (0, _language.syntaxTree)(state));
@@ -223,7 +231,7 @@ function identifyCompletions(state, pos, tree) {
                 const fieldExpr = node.parent.firstChild;
                 const attribute = state.sliceDoc(fieldExpr.from, fieldExpr.to);
                 // ignore leading " in { name="HT
-                const from = state.sliceDoc(node.from, node.from + 1) === '"' ? node.from + 1 : node.from;
+                const from = quoteChars.includes(state.sliceDoc(node.from, node.from + 1)) ? node.from + 1 : node.from;
                 return {
                     scopes: [
                         {
@@ -311,19 +319,27 @@ async function completeTagName(completionCfg, scope) {
             label: tag
         }));
 }
-/**
- * Add quotes to the completion text in case quotes are not present already.
- * This handles the following cases:
- * { name=HTTP
- * { name="x
- * { name="x" where cursor is after the 'x'
- */ function applyQuotedCompletion(view, completion, from, to) {
-    let insertText = completion.label;
-    if (view.state.sliceDoc(from - 1, from) !== '"') {
-        insertText = '"' + insertText;
+function escapeString(input, quoteChar) {
+    let escaped = input;
+    escaped = escaped.replaceAll('\\', '\\\\');
+    if (quoteChar == '"') {
+        escaped = escaped.replaceAll('"', '\\"');
+    }
+    return escaped;
+}
+function applyQuotedCompletion(view, completion, from, to) {
+    let quoteChar = defaultQuoteChar;
+    if (quoteChars.includes(view.state.sliceDoc(from - 1, from))) {
+        quoteChar = view.state.sliceDoc(from - 1, from);
+    } else if (quoteChars.includes(view.state.sliceDoc(to, to + 1))) {
+        quoteChar = view.state.sliceDoc(to, to + 1);
+    }
+    let insertText = escapeString(completion.label, quoteChar);
+    if (view.state.sliceDoc(from - 1, from) !== quoteChar) {
+        insertText = quoteChar + insertText;
     }
-    if (view.state.sliceDoc(to, to + 1) !== '"') {
-        insertText = insertText + '"';
+    if (view.state.sliceDoc(to, to + 1) !== quoteChar) {
+        insertText = insertText + quoteChar;
     }
     view.dispatch((0, _autocomplete.insertCompletionText)(view.state, insertText, from, to));
 }

package/lib/cjs/components/filter/filter.js

@@ -0,0 +1,25 @@
+/** A model of a filter bar for common tracing attributes. All attributes are combined with AND, the values of an attribute are combined with OR. */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "splitByUnquotedWhitespace", {
+    enumerable: true,
+    get: function() {
+        return splitByUnquotedWhitespace;
+    }
+});
+function splitByUnquotedWhitespace(x) {
+    let quote = false;
+    let from = 0;
+    const chunks = [];
+    for(let i = 0; i < x.length; i++){
+        if (x[i] == '"' && x[i - 1] != '\\') {
+            quote = !quote;
+        } else if (x[i] == ' ' && !quote) {
+            chunks.push(x.slice(from, i));
+            from = i + 1;
+        }
+    }
+    chunks.push(x.slice(from, x.length));
+    return chunks.filter((x)=>x);
+}

package/lib/cjs/components/filter/filter_to_traceql.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "filterToTraceQL", {
+    enumerable: true,
+    get: function() {
+        return filterToTraceQL;
+    }
+});
+function filterToTraceQL(filter) {
+    const matchers = [
+        ...stringMatcher('resource.service.name', filter.serviceName),
+        ...stringMatcher('name', filter.spanName),
+        ...stringMatcher('resource.k8s.namespace.name', filter.namespace),
+        ...intrinsicMatcher('status', filter.status),
+        ...durationMatcher('duration', filter.spanDuration),
+        ...durationMatcher('traceDuration', filter.traceDuration),
+        ...customMatcher(filter.customMatchers)
+    ];
+    if (matchers.length === 0) {
+        return '{}';
+    }
+    return `{ ${matchers.join(' && ')} }`;
+}
+function escape(q) {
+    return q.replaceAll('\\', '\\\\').replaceAll('"', '\\"');
+}
+function stringMatcher(attribute, values) {
+    const escapedValues = values.map(escape);
+    if (escapedValues.length > 1) {
+        return [
+            `${attribute} =~ "${escapedValues.join('|')}"`
+        ];
+    } else if (escapedValues.length == 1) {
+        return [
+            `${attribute} = "${escapedValues[0]}"`
+        ];
+    }
+    return [];
+}
+function intrinsicMatcher(attribute, values) {
+    const orConds = values.map((x)=>`${attribute} = ${x}`);
+    if (orConds.length > 1) {
+        return [
+            '(' + orConds.join(' || ') + ')'
+        ];
+    } else if (orConds.length === 1) {
+        return orConds;
+    } else {
+        return [];
+    }
+}
+function durationMatcher(attribute, value) {
+    const matchers = [];
+    if (value.min) {
+        matchers.push(`${attribute} >= ${value.min}`);
+    }
+    if (value.max) {
+        matchers.push(`${attribute} <= ${value.max}`);
+    }
+    return matchers;
+}
+function customMatcher(customMatchers) {
+    return customMatchers;
+}

package/lib/cjs/components/filter/index.js

@@ -0,0 +1,32 @@
+// 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
+//
+// 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("./filter"), exports);
+_export_star(require("./filter_to_traceql"), exports);
+_export_star(require("./traceql_to_filter"), 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/components/filter/traceql_to_filter.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "traceQLToFilter", {
+    enumerable: true,
+    get: function() {
+        return traceQLToFilter;
+    }
+});
+const _lezertraceql = require("@grafana/lezer-traceql");
+function traceQLToFilter(query) {
+    const matchers = parseQuery(query);
+    return {
+        serviceName: reverseStringMatcher(matchers['resource.service.name']),
+        spanName: reverseStringMatcher(matchers['name']),
+        namespace: reverseStringMatcher(matchers['resource.k8s.namespace.name']),
+        status: reverseIntrinsicMatcher(matchers['status']),
+        spanDuration: reverseDurationMatcher(matchers['duration']),
+        traceDuration: reverseDurationMatcher(matchers['traceDuration']),
+        customMatchers: reverseCustomMatcher(matchers, new Set([
+            'resource.service.name',
+            'name',
+            'resource.k8s.namespace.name',
+            'status',
+            'duration',
+            'traceDuration'
+        ]))
+    };
+}
+function parseQuery(query) {
+    const matchers = {};
+    let attribute = '';
+    let operator = '';
+    let value = '';
+    const syntaxTree = _lezertraceql.parser.parse(query);
+    syntaxTree.iterate({
+        enter (node) {
+            switch(node.type.id){
+                case _lezertraceql.AttributeField:
+                    attribute = query.slice(node.from, node.to);
+                    return false;
+                case _lezertraceql.IntrinsicField:
+                    attribute = query.slice(node.from, node.to);
+                    return false;
+                case _lezertraceql.FieldOp:
+                    operator = query.slice(node.from, node.to);
+                    return false;
+                case _lezertraceql.Static:
+                    value = query.slice(node.from, node.to);
+                    return false;
+            }
+        },
+        leave (node) {
+            if (node.type.id === _lezertraceql.FieldExpression && node.node.getChild(_lezertraceql.FieldOp)) {
+                const newMatchers = matchers[attribute] ?? [];
+                newMatchers.push({
+                    operator,
+                    value
+                });
+                matchers[attribute] = newMatchers;
+            }
+        }
+    });
+    return matchers;
+}
+function unescape(q) {
+    return q.replaceAll('\\"', '"').replaceAll('\\\\', '\\');
+}
+function reverseStringMatcher(matches) {
+    const values = [];
+    for (const { operator, value } of matches ?? []){
+        const unescaped = unescape(value.slice(1, -1));
+        if (operator == '=') {
+            values.push(unescaped);
+        } else if (operator == '=~') {
+            values.push(...unescaped.split('|'));
+        }
+    }
+    return values;
+}
+function reverseIntrinsicMatcher(matches) {
+    const values = [];
+    for (const { operator, value } of matches ?? []){
+        if (operator == '=') {
+            values.push(value);
+        }
+    }
+    return values;
+}
+function reverseDurationMatcher(matches) {
+    const duration = {};
+    for (const { operator, value } of matches ?? []){
+        if (operator == '>=') {
+            duration.min = value;
+        } else if (operator == '<=') {
+            duration.max = value;
+        }
+    }
+    return duration;
+}
+function reverseCustomMatcher(matchers, skipAttrs) {
+    const customMatchers = [];
+    for (const [attribute, matches] of Object.entries(matchers)){
+        if (skipAttrs.has(attribute)) {
+            continue;
+        }
+        for (const { operator, value } of matches){
+            customMatchers.push(`${attribute}${operator}${value}`);
+        }
+    }
+    return customMatchers;
+}

package/lib/cjs/components/index.js

@@ -14,6 +14,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+_export_star(require("./filter"), exports);
 _export_star(require("./TraceQLEditor"), exports);
 _export_star(require("./TraceQLExtension"), exports);
 function _export_star(from, to) {