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
+7-7
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
-
# Proton Grafana Datasource
2
-
Grafana data source plugin to connect to Proton and visualize streaming or batch queries.
1
+
# Timeplus Grafana Datasource
2
+
Grafana data source plugin to connect to Timeplus and visualize streaming or batch queries.
3
3
4
4
## Overview / Introduction
5
5
6
-
[Proton](https://github.com/timeplus-io/proton) is a streaming analytics engine in a single binary. It helps data engineers and platform engineers solve complex real-time analytics use cases, and powers the [Timeplus](https://timeplus.com) streaming analytics platform.
6
+
As the core engine of [Timeplus Enterprise](https://timeplus.com), [Proton](https://github.com/timeplus-io/proton) is a single binary for streaming analytics. It helps data engineers and platform engineers solve complex real-time analytics use cases.
7
7
8
8
## Requirements
9
9
10
10
Grafana v10.0.3 or above
11
11
12
-
A running Proton instance with TCP port 8463 (for database connection) and HTTP port 3218 (for query analazyer REST API).
12
+
A running Timeplus Proton or Timeplus Enterprise instance with TCP port 8463 (for database connection) and HTTP port 3218 (for query analazyer REST API).
13
13
14
14
## Getting Started
15
15
@@ -18,15 +18,15 @@ The [docker-compose.yaml](docker-compose.yaml) in this folder ships a Grafana co
18
18
19
19
You start it with `docker compose up` and go to http://localhost:3000 to view the Carsharing dashboard.
20
20
21
-
A data source for Proton is created automatically.
21
+
A data source for Timeplus is created automatically.
22
22
23
23
### Use your own Grafana deployment
24
24
25
25
In the navigation menu, choose Connections -> Add new connection.
26
26
27
-
Search for Proton and accept the default settings (localhost,port 8463 and 3218 as proton connection). This plugin is expected to run in localhost or trusted network. Username and password for Proton will be added later. For Timeplus Cloud, API Key is supported for REST API, but this Grafana plugin doesn't support Timeplus Cloud at this point.
27
+
Search for Timeplus and accept the default settings (localhost,port 8463 and 3218 as proton connection). This plugin is expected to run in localhost or trusted network. Username and password for Timeplus will be added later. This tool supports self-hosted Timeplus Enterprise, but not for Timeplus Cloud.
28
28
29
-
Create a new dashboard or explore data with this Proton data source.
29
+
Create a new dashboard or explore data with this Timeplus data source.
30
30
31
31
There are unbounded streaming query and bounded historical query in proton, all queries like `select count(*) from stream_name` are streaming queries, and adding `table` function to the stream name will turn the query into bounded query, e.g. `select count(*) from table(stream_name)`.
0 commit comments