https://github.com/intercloud/intercloud-grafana-plugin
Grafana datasource plugin for InterCloud's services metrics
https://github.com/intercloud/intercloud-grafana-plugin
Last synced: 10 months ago
JSON representation
Grafana datasource plugin for InterCloud's services metrics
- Host: GitHub
- URL: https://github.com/intercloud/intercloud-grafana-plugin
- Owner: intercloud
- License: apache-2.0
- Created: 2020-09-01T06:36:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-13T14:33:59.000Z (over 3 years ago)
- Last Synced: 2025-05-28T00:11:32.557Z (12 months ago)
- Language: TypeScript
- Size: 726 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# InterCloud Grafana Data Source Plugin
This plugin provides a Grafana Data Source to show InterCloud's services metrics from the REST API.
Grafana server version: >= 7.4.0 - < 8.0.0
## Quick Test
### 1. Environment and tools
Requirements:
You need a **node engine version ">=14 <15"**.
You can use [nvm](https://github.com/nvm-sh/nvm) to manage different versions.
You also will need **[yarn](https://yarnpkg.com/)** to build the plugin.
### 2. Run a local grafana with InterCloud's plugin
```BASH
git clone https://github.com/intercloud/intercloud-grafana-plugin.git
cd intercloud-grafana-plugin
yarn install
yarn build
```
After that, you can start a docker container :
* On Windows
```BASH
docker run -d -p 3000:3000 -v %cd%/dist:/var/lib/grafana/plugins/intercloud --name=grafana grafana/grafana:7.4.0
```
* On Linux
```BASH
docker run -d -p 3000:3000 -v `pwd`/dist:/var/lib/grafana/plugins/intercloud --name=grafana grafana/grafana:7.4.0
```
Then open your browser on http://localhost:3000 (use admin/admin as default credentials, you can change it after login).
Add the InterCloud Data Source (See https://grafana.com/docs/grafana/latest/features/datasources/add-a-data-source/) and configure you `API Key` to make grafana access InterCloud API (You can create an [InterCloud portal Personal Access Token](https://doc.intercloud.io/api-howtos/authentication/personal-access-token/) to be used as Grafana `API Key`)
> To minimize the amount of sensitive information sent to and from the browser, data source plugins can use the Grafana data source proxy. When using the data source proxy, any requests containing sensitive information go through the Grafana server. No sensitive data is sent to the browser after the data is saved.
Press `Save & Test` button.
### 3. Create panel
Go to `+ > Create > Dashboard` and Add a new panel.
Fill the query information with the [IRN](https://doc.intercloud.io/api-howtos/metrics/) of the service you want to retrieve metrics (e.g. `irn:connectors:skstok62tbks::p0q4dy`) and choose metric.
You can add more than one query per panel and change the panel title.
## Getting started with development for the plugin
### 1. Install dependencies
```BASH
yarn install
```
### 2. Build plugin in development mode or run in watch mode
```BASH
yarn dev
```
or
```BASH
yarn watch
```
### 3. Build plugin in production mode
```BASH
yarn build
```
## Todo
- Signature verification
- Support status measures
- Add alerting support (backend plugin)
- Add annotations support
- ci/cd
- unit tests
## Learn more
- [InterCloud Portal and API Documentation](https://doc.intercloud.io)
- [Grafana documentation](https://grafana.com/docs/)
- [Grafana Tutorials](https://grafana.com/tutorials/) - Grafana Tutorials are step-by-step guides that help you make the most of Grafana