Skip to content

Commit 77f5b7c

Browse files
authored
improved grafana docs (#577)
1 parent 45272db commit 77f5b7c

1 file changed

Lines changed: 19 additions & 24 deletions

File tree

docs/integration-grafana.md

Lines changed: 19 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Integration with Grafana
22

3-
Grafana has long been one of the most popular tools for real-time monitoring and data visualization, helping organizations track metrics and analyze trends through a single, user-friendly interface. For self-hosted Timeplus Enterprise or Timeplus Proton, you can try [the Grafana plugin for Timeplus](https://grafana.com/grafana/plugins/timeplus-proton-datasource/) with the source code at [GitHub](https://github.com/timeplus-io/proton-grafana-source). This plugin was designed to leverage Grafana’s new [Grafana Live](https://grafana.com/docs/grafana/latest/setup-grafana/set-up-grafana-live/) capability, allowing users to keep their SQL query results up-to-date without the need to refresh their dashboards. Check out [here](https://github.com/timeplus-io/proton/tree/develop/examples/grafana) for sample setup.
3+
Grafana has long been one of the most popular tools for real-time monitoring and data visualization, helping organizations track metrics and analyze trends through a single, user-friendly interface. For Timeplus Enterprise or Timeplus Proton, you can try the Grafana plugin for Timeplus with the source code at [GitHub](https://github.com/timeplus-io/proton-grafana-source). This plugin was designed to leverage Grafana’s new [Grafana Live](https://grafana.com/docs/grafana/latest/setup-grafana/set-up-grafana-live/) capability, allowing users to keep their SQL query results up-to-date without the need to refresh their dashboards. Check out [here](https://github.com/timeplus-io/proton/tree/develop/examples/grafana) for sample setup.
44

55
<iframe width="560" height="315" src="https://www.youtube.com/embed/cBRl1k9qWZc?si=TzVpULg-B0b0T5GE" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
66

@@ -19,33 +19,17 @@ Our Timeplus Grafana Plugin provides a flexible, powerful way to enhance your da
1919

2020
Getting started with the latest version of the Timeplus Grafana Plugin is straightforward.
2121

22-
### Step 1: Set Up Grafana {#step1}
22+
### Step 1: Install the Timeplus Plugin {#step1}
2323

24-
First, ensure that you have Grafana OSS or Grafana Enterprise installed.
25-
26-
• **For Mac users**, you can install Grafana by running:
27-
`brew install grafana`
28-
29-
• **For Linux users**, you can use the following commands, adjusting the download URL to match the latest version if necessary:
30-
`sudo yum install -y https://dl.grafana.com/enterprise/release/grafana-enterprise-11.3.0-1.x86_64.rpm`
31-
For additional installation instructions, please refer to the [Grafana download page](https://grafana.com/grafana/download).
32-
33-
### Step 2: Install the Timeplus Plugin {#step2}
34-
35-
Next, download and install the Timeplus plugin in your Grafana deployment. For example, if you’re on Linux:
24+
First, download Timeplus Grafana Plugin from our Github [release page](https://github.com/timeplus-io/proton-grafana-source/releases).Next install the Timeplus plugin in your Grafana deployment. For detailed guide, please refer to [Grafana docs](https://grafana.com/docs/grafana/latest/administration/plugin-management/plugin-install/#install-a-plugin-from-a-zip-file).
3625

3726
```shell
38-
cd /var/lib/grafana
39-
mkdir plugins
40-
cd plugins
41-
wget d.timeplus.com/grafana/timeplus-proton-datasource-2.1.3.zip
42-
unzip timeplus-proton-datasource-2.1.3.zip
27+
unzip timeplus-proton-datasource.zip -d YOUR_PLUGIN_DIR/my-plugin
4328
```
4429

45-
After installing the plugin, restart Grafana to enable it:
46-
`sudo /bin/systemctl restart grafana-server.service`
30+
After installing the plugin, restart Grafana to enable it.
4731

48-
### Step 3: Configure the Plugin in Grafana {#step3}
32+
### Step 2: Configure the Plugin in Grafana {#step2}
4933

5034
1. **Login to Grafana’s web UI** and navigate to **Connections \-\> Data Sources**.
5135
2. **Locate the Timeplus Data Source** by scrolling or searching for “Timeplus.”
@@ -54,13 +38,13 @@ After installing the plugin, restart Grafana to enable it:
5438
* For **Timeplus Proton**, use the default username with no password.
5539
4. **Save and Test the Connection** by clicking the **Save & Test** button to confirm the plugin is connected successfully.
5640

57-
### Step 4: Create a Dashboard and Visualize Data {#step4}
41+
### Step 3: Create a Dashboard and Visualize Data {#step3}
5842
1. Follow the “Build a Dashboard” link to start a new dashboard, and **add a visualization**.
5943
2. Select the **Timeplus data source** you configured earlier.
6044

6145
Now, you can enter SQL queries to retrieve and visualize data from Timeplus directly in Grafana.
6246

63-
### Step 5: Example \- Monitoring Real-Time Bitcoin Price {#step5}
47+
### Step 4: Example \- Monitoring Real-Time Bitcoin Price {#step4}
6448

6549
To showcase the power of real-time streaming with Grafana and Timeplus, let’s set up a feed for live Bitcoin pricing:
6650

@@ -78,6 +62,17 @@ With this setup, you can now use Grafana to monitor live prices and transaction
7862

7963
## Change Log {#changelog}
8064

65+
### 2.1.5
66+
Released on 01-12-2026
67+
68+
* Respected the query interval setting.
69+
70+
### 2.1.4
71+
Released on 12-12-2025
72+
73+
* Fixed a concurrent panic issue when running query
74+
* Bumped proton-go-driver to 2.1.2
75+
8176
### 2.1.3
8277
Released on 05-12-2025
8378

0 commit comments

Comments
 (0)