Skip to content

Commit 1d8c073

Browse files
committed
Update README.md
1 parent 39c8ab4 commit 1d8c073

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,24 @@ Grafana data source plugin to connect to Proton and visualize streaming or batch
66
[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.
77

88
## Requirements
9+
910
Grafana v10.0.3 or above
11+
1012
https://github.com/timeplus-io/proton
1113

1214
## Getting Started
1315

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.
1519

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)
2121

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.
2323

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.
2525

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.
2727

2828
![query editor](src/img/query.png)
2929

@@ -55,55 +55,55 @@ For streaming query, check the option `Streaming query` in your query editor.
5555
1. Install dependencies
5656

5757
```bash
58-
npm install
58+
yarn install
5959
```
6060

6161
2. Build plugin in development mode and run in watch mode
6262

6363
```bash
64-
npm run dev
64+
yarn dev
6565
```
6666

6767
3. Build plugin in production mode
6868

6969
```bash
70-
npm run build
70+
yarn build
7171
```
7272

7373
4. Run the tests (using Jest)
7474

7575
```bash
7676
# Runs the tests and watches for changes, requires git init first
77-
npm run test
77+
yarn test
7878

7979
# Exits after running all the tests
80-
npm run test:ci
80+
yarn test:ci
8181
```
8282

8383
5. Spin up a Grafana instance and run the plugin inside it (using Docker)
8484

8585
```bash
86-
npm run server
86+
yarn server
8787
```
8888

8989
6. Run the E2E tests (using Cypress)
9090

9191
```bash
9292
# Spins up a Grafana instance first that we tests against
93-
npm run server
93+
yarn server
9494

9595
# Starts the tests
96-
npm run e2e
96+
yarn e2e
9797
```
9898

9999
7. Run the linter
100100

101101
```bash
102-
npm run lint
102+
yarn lint
103103

104104
# or
105105

106-
npm run lint:fix
106+
yarn lint:fix
107107
```
108108

109109

0 commit comments

Comments
 (0)