Skip to content

Commit

Permalink
Switch to the scylla-plugin 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
amnonh committed Jan 8, 2024
1 parent 4c029f5 commit fb1c9d1
Show file tree
Hide file tree
Showing 10 changed files with 56 additions and 132 deletions.
178 changes: 51 additions & 127 deletions grafana/plugins/scylla-plugin/dist/README.md
Original file line number Diff line number Diff line change
@@ -1,127 +1,51 @@
# Scylla/Apache Cassandra Backend Plugin

The plugin is currently in Alpha and not ready for commercial usage.

[![CircleCI](https://circleci.com/gh/grafana/simple-datasource-backend/tree/master.svg?style=svg)](https://circleci.com/gh/grafana/simple-datasource-backend/tree/master)

This plugin allows connecting Scylla or Appahe Cassandra to Grafana.

## What is Scylla Grafana Data Source Backend Plugin?

A [Backend plugins](https://grafana.com/docs/grafana/latest/developers/plugins/backend/) is a type of data-source plugin that runs on the server.
That means that that from IP connectivity, your Database (Scylla or Apache Cassanra) should be accessible from the grafana server.


## Getting started
Use Grafana 7.0 or higher
* Download and place the datasouce in grafana/plugins directory.

This plugin is not signed yet, Granfa will not allow loading it by default. you should enable it by adding:

for example, if you are using Grafana with containers, add:
```
-e "GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=scylladb-scylla-datasource"
```

You can now add the scylla data source, the only current configuration is a host in the cluster.

When adding a panel use CQL to get the data.
you can only do select statements, but any valid select would work.


## For Scylla-Monitoring Users
* Take the master branch that would run Grafana 7
* Either edit and add the the `ALLOW_PLUGINS` to `start-grafana.sh` or use the command line flag to `start-all.sh`
```
./start-all.sh -s scylla_servers.yml -c "GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=scylladb-scylla-datasource"
```
### Configure the datasoure from file
* If you do not want to configure the data source on every restart, edit `grafana/datasource.yml`
And add:
```
- name: scylla-datasource
type: scylladb-scylla-datasource
orgId: 1
isDefault:
jsonData:
host: 'node-ip'
```
Replacing `node-ip` with an ip of a node in the cluster.

To support user and password add `secureJsonData` to `grafana/datasource.yml`
```
- name: scylla-datasource
type: scylladb-scylla-datasource
orgId: 1
isDefault:
jsonData:
host: 'node-ip'
secureJsonData:
user: 'cassandra'
password: 'cassandra'
```

### Configure the Datasource using Grafana API:
Grafana API allows adding datasource.
The following will add a data source without a username and password, replace the `ADMIN_PASSWORD`
with Grafana's Admin password

```
curl -XPOST -i http://admin:$ADMIN_PASSWORD@localhost:3000/api/datasources \
--data-binary '{"name": "scylla-datasource","type": "scylladb-scylla-datasource", \
"orgId": 1,"access":"proxy", "jsonData":{"host": ""}}' -H "Content-Type: application/json"
```

The following example shows how to configure the plugin with username and password
```
curl -XPOST -i http://admin:$ADMIN_PASSWORD@localhost:3000/api/datasources \
--data-binary '{"name": "scylla-datasource","type": "scylladb-scylla-datasource", "orgId": 1,"access":"proxy", \
"jsonData":{"host": ""}, "secureJsonData":{"user": "scylla", "password": "scylla"}}' \
-H "Content-Type: application/json"
```

## Compiling the data source by yourself
A data source backend plugin consists of both frontend and backend components.

### Frontend

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
```

### Backend

1. Update [Grafana plugin SDK for Go](https://grafana.com/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/) dependency to the latest minor version:

```bash
go get -u github.com/grafana/grafana-plugin-sdk-go
```

2. Build backend plugin binaries for Linux, Windows and Darwin:
```BASH
mage -v
```

3. List all available Mage targets for additional commands:
```BASH
mage -l
```

## Learn more

- [Grafana plugin SDK for Go](https://grafana.com/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/)
<!-- This README file is going to be the one displayed on the Grafana.com website for your plugin. Uncomment and replace the content here before publishing.
Remove any remaining comments before publishing as these may be displayed on Grafana.com -->

# Scylla Jan24

Datasource for scylla

<!-- To help maximize the impact of your README and improve usability for users, we propose the following loose structure:
**BEFORE YOU BEGIN**
- Ensure all links are absolute URLs so that they will work when the README is displayed within Grafana and Grafana.com
- Be inspired ✨
- [grafana-polystat-panel](https://github.com/grafana/grafana-polystat-panel)
- [volkovlabs-variable-panel](https://github.com/volkovlabs/volkovlabs-variable-panel)
**ADD SOME BADGES**
Badges convey useful information at a glance for users whether in the Catalog or viewing the source code. You can use the generator on [Shields.io](https://shields.io/badges/dynamic-json-badge) together with the Grafana.com API
to create dynamic badges that update automatically when you publish a new version to the marketplace.
- For the logo field use 'grafana'.
- Examples (label: query)
- Downloads: $.downloads
- Catalog Version: $.version
- Grafana Dependency: $.grafanaDependency
- Signature Type: $.versionSignatureType
Full example: ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?logo=grafana&query=$.version&url=https://grafana.com/api/plugins/grafana-polystat-panel&label=Marketplace&prefix=v&color=F47A20)
Consider other [badges](https://shields.io/badges) as you feel appropriate for your project.
## Overview / Introduction
Provide one or more paragraphs as an introduction to your plugin to help users understand why they should use it.
Consider including screenshots:
- in [plugin.json](https://grafana.com/developers/plugin-tools/reference-plugin-json#info) include them as relative links.
- in the README ensure they are absolute URLs.
## Requirements
List any requirements or dependencies they may need to run the plugin.
## Getting Started
Provide a quick start on how to configure and use the plugin.
## Documentation
If your project has dedicated documentation available for users, provide links here. For help in following Grafana's style recommendations for technical documentation, refer to our [Writer's Toolkit](https://grafana.com/docs/writers-toolkit/).
## Contributing
Do you want folks to contribute to the plugin or provide feedback through specific means? If so, tell them how!
-->
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
ba5ee903d3b81740a1bd1c9aacf631a04ab8a209838d03a649365cf66590fdc7:Magefile.go
58fd59554a711989af68245d2dfd00de5a693297c4a511a35faf32439e9ec8ba:pkg/main.go
0205ee1f0b45b3bc115ceca620717d4fc288d85518d7bfcbf4ecbee65beef83f:pkg/plugin/datasource.go
a444f62d4ad6672b2d2bea9c2e1db75345c4469eddc365dea542574061be8ab6:pkg/plugin/datasource.go
Binary file modified grafana/plugins/scylla-plugin/dist/gpx_scylladb_darwin_amd64
Binary file not shown.
Binary file modified grafana/plugins/scylla-plugin/dist/gpx_scylladb_darwin_arm64
Binary file not shown.
Binary file modified grafana/plugins/scylla-plugin/dist/gpx_scylladb_linux_amd64
Binary file not shown.
Binary file modified grafana/plugins/scylla-plugin/dist/gpx_scylladb_linux_arm
Binary file not shown.
Binary file modified grafana/plugins/scylla-plugin/dist/gpx_scylladb_linux_arm64
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion grafana/plugins/scylla-plugin/dist/module.js.map

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions grafana/plugins/scylla-plugin/dist/plugin.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@
}
],
"screenshots": [],
"version": "0.2.0",
"updated": "2023-10-04"
"version": "0.3.0",
"updated": "2024-01-08"
},
"dependencies": {
"grafanaDependency": ">=9.5.3",
"grafanaDependency": ">=10.0.3",
"plugins": []
}
}

0 comments on commit fb1c9d1

Please sign in to comment.