You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-19Lines changed: 19 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -6,24 +6,24 @@ Grafana data source plugin to connect to Proton and visualize streaming or batch
6
6
[Proton](https://github.com/timeplus-io/proton) is a unified streaming and historical data processing engine in a single binary. It helps data engineers and platform engineers solve complex real-time analytics use cases, and powers the Timeplus streaming analytics platform.
7
7
8
8
## Requirements
9
+
9
10
Grafana v10.0.3 or above
11
+
10
12
https://github.com/timeplus-io/proton
11
13
12
14
## Getting Started
13
15
14
-
To create a proton data source,
16
+
Before the plugin is approved by Grafana, you need to set your Grafana running in development mode via changing /usr/local/etc/grafana/grafana.ini, setting `app_mode = development`
17
+
18
+
In the navigation menu, choose Connections -> Add new connection.
15
19
16
-
1. click `add datasource`
17
-
2. search `proton`
18
-
3. chose `Timeplus Proton`
19
-
4. input your proton `host` default to `localhost` and `port` default to `8463`
20
-
5. click `Save and test`
20
+
Search for Proton and accept the default settings (localhost:8463 as proton connection)
21
21
22
-
Then you should be able to explore this proton data source.
22
+
Create a new dashboard or explore data with this Proton data source.
23
23
24
-
There are unbounded streaming query and bounded historical query in proton, all queries like `select * from stream_name` are default to streaming query, and adding table function to the stream name will turn the query into bounded query.
24
+
There are unbounded streaming query and bounded historical query in proton, all queries like `select * from stream_name` are default to streaming query, and adding `table`` function to the stream name will turn the query into bounded query.
25
25
26
-
For streaming query, check the option `Streaming query` in your query editor.
26
+
By default, the "Streaming Query" toggle is off. If your SQL is a streaming SQL, make sure to turn it on to leverage Grafana's live chart to show the new results.
27
27
28
28

29
29
@@ -55,55 +55,55 @@ For streaming query, check the option `Streaming query` in your query editor.
55
55
1. Install dependencies
56
56
57
57
```bash
58
-
npm install
58
+
yarn install
59
59
```
60
60
61
61
2. Build plugin in development mode and run in watch mode
62
62
63
63
```bash
64
-
npm run dev
64
+
yarn dev
65
65
```
66
66
67
67
3. Build plugin in production mode
68
68
69
69
```bash
70
-
npm run build
70
+
yarn build
71
71
```
72
72
73
73
4. Run the tests (using Jest)
74
74
75
75
```bash
76
76
# Runs the tests and watches for changes, requires git init first
77
-
npm runtest
77
+
yarntest
78
78
79
79
# Exits after running all the tests
80
-
npm run test:ci
80
+
yarn test:ci
81
81
```
82
82
83
83
5. Spin up a Grafana instance and run the plugin inside it (using Docker)
84
84
85
85
```bash
86
-
npm run server
86
+
yarn server
87
87
```
88
88
89
89
6. Run the E2E tests (using Cypress)
90
90
91
91
```bash
92
92
# Spins up a Grafana instance first that we tests against
0 commit comments