[FEATURE] Add GreptimeDB datasource Plugin by sunchanglong · Pull Request #629 · perses/plugins

sunchanglong · 2026-04-15T02:45:42Z

Description

This pull request adds a new GreptimeDB plugin to the plugins repository so Perses can query and visualize metrics & logs data from GreptimeDB.

The implementation covers the main GreptimeDB query workflows used in Perses dashboards:

querying time series data from GreptimeDB based on panel time range
converting GreptimeDB responses into the data format expected by Perses panels, so charts and related visual components can consume results without additional handling

A few points worth calling out for review:

GreptimeDB response data is normalized and mapped into Perses-compatible series/frames, including timestamps, values, and label dimensions
plugin schemas, SDK integration helpers, datasource configuration, query editor support, and tests are included in the same change
only files required for the GreptimeDB plugin and workspace/plugin registration were touched
This change is intended to address GreptimeDB datasource support discussed in the linked issue and related follow-up conversations.

Screenshots

Checklist

Pull request has a descriptive title and context useful to a reviewer.
Pull request title follows the [<catalog_entry>] <commit message> naming convention using one of the
following catalog_entry values: FEATURE, ENHANCEMENT, BUGFIX, BREAKINGCHANGE, DOC,IGNORE.
All commits have DCO signoffs.

UI Changes

Changes that impact the UI include screenshots and/or screencasts of the relevant changes.
Code follows the UI guidelines.

Signed-off-by: sun <[email protected]>

sunchanglong · 2026-04-17T03:30:53Z

The CI workflow failure seems unrelated to the changes in this PR.
Could you please try rerunning the job？

Signed-off-by: sun <[email protected]>

Fixgeneration

sunchanglong · 2026-04-30T08:50:13Z

Added GreptimeDBResponseData to refine the unknown types. This ensures better type safety and clarifies the expected data structure from GreptimeDB.

sunchanglong · 2026-05-13T08:41:22Z

Hi team, @jgbernalp we have addressed most review issues could you please check again.
We're using the Perses GreptimeDB plugin in our project: dashboard

Signed-off-by: sun <[email protected]>

Review1

Signed-off-by: sun <[email protected]>

chore: plugin version

sunchanglong · 2026-05-18T06:51:47Z

the CI error was caused by perses-dev peerDependencies upgration, should be fixed

jgbernalp · 2026-05-19T11:27:16Z

Code review

Found 1 issue:

Missing Trace Explorer plugin registration and export. The GreptimeDBTraceExplorer component is fully implemented in src/explore/ but is never exported from src/index.ts and not registered in package.json under perses.plugins with kind: "Explore". Without these, the explorer is inaccessible to users. Compare with the Tempo plugin which exports explore at src/index.ts:16 and registers it at package.json:79-86.

greptimedb/src/index.ts is missing export * from './explore';:
https://github.com/perses/plugins/blob/21a1d260f3884018719a27554fdaaeeb87f9e140/greptimedb/src/index.ts#L13-L17

greptimedb/package.json is missing an Explore plugin entry (compare with Tempo's registration):

plugins/greptimedb/package.json

Lines 44 to 85 in 21a1d26

    
           "perses": { 
        
             "moduleName": "GreptimeDB", 
        
             "schemasPath": "schemas", 
        
             "plugins": [ 
        
               { 
        
                 "kind": "Datasource", 
        
                 "spec": { 
        
                   "display": { 
        
                     "name": "GreptimeDB Datasource" 
        
                   }, 
        
                   "name": "GreptimeDBDatasource" 
        
                 } 
        
               }, 
        
               { 
        
                 "kind": "TimeSeriesQuery", 
        
                 "spec": { 
        
                   "display": { 
        
                     "name": "GreptimeDB Time Series Query" 
        
                   }, 
        
                   "name": "GreptimeDBTimeSeriesQuery" 
        
                 } 
        
               }, 
        
               { 
        
                 "kind": "LogQuery", 
        
                 "spec": { 
        
                   "display": { 
        
                     "name": "GreptimeDB Log Query" 
        
                   }, 
        
                   "name": "GreptimeDBLogQuery" 
        
                 } 
        
               }, 
        
               { 
        
                 "kind": "TraceQuery", 
        
                 "spec": { 
        
                   "display": { 
        
                     "name": "GreptimeDB Trace Query" 
        
                   }, 
        
                   "name": "GreptimeDBTraceQuery" 
        
                 } 
        
               } 
        
             ] 
        
           }

The component exists but is dead code without proper wiring:

plugins/greptimedb/src/explore/GreptimeDBTraceExplorer.tsx

Lines 1 to 5 in 21a1d26

    
           // 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 
        
           //

Reference: Tempo plugin's correct pattern:

plugins/tempo/src/index.ts

Lines 14 to 18 in 21a1d26

    
           export { getPluginModule } from './getPluginModule'; 
        
           export * from './components'; 
        
           export * from './explore'; 
        
           export * from './model'; 
        
           export * from './plugins';

plugins/tempo/package.json

Lines 78 to 87 in 21a1d26

    
             { 
        
               "kind": "Explore", 
        
               "spec": { 
        
                 "display": { 
        
                   "name": "Tempo Traces Explorer" 
        
                 }, 
        
                 "name": "TempoExplorer" 
        
               } 
        
             } 
        
           ]

🤖 Generated with Claude Code

sunchanglong · 2026-05-20T02:10:46Z

Code review

Found 1 issue:

Missing Trace Explorer plugin registration and export. The GreptimeDBTraceExplorer component is fully implemented in src/explore/ but is never exported from src/index.ts and not registered in package.json under perses.plugins with kind: "Explore". Without these, the explorer is inaccessible to users. Compare with the Tempo plugin which exports explore at src/index.ts:16 and registers it at package.json:79-86.

greptimedb/src/index.ts is missing export * from './explore';: https://github.com/perses/plugins/blob/21a1d260f3884018719a27554fdaaeeb87f9e140/greptimedb/src/index.ts#L13-L17

greptimedb/package.json is missing an Explore plugin entry (compare with Tempo's registration):

plugins/greptimedb/package.json

Lines 44 to 85 in 21a1d26

"perses": {

"moduleName": "GreptimeDB",

"schemasPath": "schemas",

"plugins": [

{

"kind": "Datasource",

"spec": {

"display": {

"name": "GreptimeDB Datasource"

},

"name": "GreptimeDBDatasource"

}

},

{

"kind": "TimeSeriesQuery",

"spec": {

"display": {

"name": "GreptimeDB Time Series Query"

},

"name": "GreptimeDBTimeSeriesQuery"

}

},

{

"kind": "LogQuery",

"spec": {

"display": {

"name": "GreptimeDB Log Query"

},

"name": "GreptimeDBLogQuery"

}

},

{

"kind": "TraceQuery",

"spec": {

"display": {

"name": "GreptimeDB Trace Query"

},

"name": "GreptimeDBTraceQuery"

}

}

]

}

The component exists but is dead code without proper wiring:

plugins/greptimedb/src/explore/GreptimeDBTraceExplorer.tsx

Lines 1 to 5 in 21a1d26

// 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

//

Reference: Tempo plugin's correct pattern:

plugins/tempo/src/index.ts

Lines 14 to 18 in 21a1d26

export { getPluginModule } from './getPluginModule';

export * from './components';

export * from './explore';

export * from './model';

export * from './plugins';

plugins/tempo/package.json

Lines 78 to 87 in 21a1d26

{

"kind": "Explore",

"spec": {

"display": {

"name": "Tempo Traces Explorer"

},

"name": "TempoExplorer"

}

}

]

🤖 Generated with Claude Code

yes, it is a knowned issue.
To keep this PR clean and avoid delaying the review, we've left Trace Explorer out for now, especially since we don't have an immediate need for it. We plan to follow up and open another PR for it in a future release, unless you prefer having it included now.

jgbernalp · 2026-05-20T08:36:49Z

@sunchanglong in that case, please remove the dead code and create an GitHub issue for later implementation

Signed-off-by: sun <[email protected]>

feat: remove explorer

sunchanglong · 2026-05-20T10:38:40Z

the dead code has been removed.
#660 the issue has been recorded here

jgbernalp · 2026-05-20T10:55:04Z

@@ -0,0 +1,32 @@
+module github.com/perses/plugins/greptimedb
+
+go 1.25.7


Suggested change

go 1.25.7

go 1.26.0

the version was updated for previous review suggestion. the go version changed frequently.

jgbernalp · 2026-05-20T11:13:54Z

+#kind: "GreptimeDBDatasource"
+
+kind: #kind
+spec: {


headers is missing from the spec. When using the proxy headers are included but this datasource uses them directly. Is there any reason to use them directly instead of using the Perses secrets via the proxy configuration? Plain credential storage should be avoided.

jgbernalp · 2026-05-20T11:19:58Z

it seems we don't have tests for this schema

jgbernalp · 2026-05-20T11:20:15Z

It seems we don't have tests for this schema

jgbernalp · 2026-05-20T11:22:48Z

+  };
+
+  try {
+    const response = await fetch(url.toString(), init);


this fetch should be imported from @perses-dev/core

jgbernalp · 2026-05-20T11:24:41Z

+  try {
+    const response = await fetch(url.toString(), init);
+    if (!response.ok) {
+      const errorText = await response.text();


We should check the content type as errors might come formatted in JSON and they will be hard to read from the UI if we just assume they are text, e.g.: https://github.com/perses/plugins/blob/main/loki/src/model/loki-client.ts#L88

jgbernalp · 2026-05-20T11:35:01Z

+    if (normalized.includes('second')) return String(BigInt(Math.trunc(raw)) * 1_000_000_000n);
+
+    if (raw > 1_000_000_000_000_000) return String(BigInt(Math.trunc(raw)));
+    if (raw > 1_000_000_000_000) return String(BigInt(Math.trunc(raw)) * 1_000_000n);


If dataType is undefined, I think we are missing the microsecond check here and they will fall into nanoseconds giving wrong timestamp results. Maybe this is right but the test needs to cover this case as well to make it clear?

feat: add greptimedb plugin

12df878

Signed-off-by: sun <[email protected]>

sunchanglong requested review from a team, AntoineThebaud and Nexucis as code owners April 15, 2026 02:45

sunchanglong requested review from jgbernalp and removed request for a team April 15, 2026 02:45

jgbernalp reviewed Apr 27, 2026

View reviewed changes

Comment thread greptimedb/src/queries/greptimedb-log-query/greptimedb-log-query-types.test.ts Outdated

jgbernalp reviewed Apr 27, 2026

View reviewed changes

Comment thread greptimedb/src/queries/greptimedb-time-series-query/greptimedb-query-types.test.ts Outdated

sunchanglong added 4 commits April 30, 2026 11:20

chore: remove unnecessary setup for test

d393d6a

Signed-off-by: sun <[email protected]>

chore: query types

400b463

Signed-off-by: sun <[email protected]>

refactor: use GreptimeDBResponseData type

0e5bee1

Signed-off-by: sun <[email protected]>

Merge pull request #5 from GreptimeTeam/fixgeneration

f51ae6a

Fixgeneration