https://github.com/grafana/grafana-plugin-sdk-rust

Grafana Plugin SDK for Rust
https://github.com/grafana/grafana-plugin-sdk-rust

grafana hacktoberfest rust sdk

Last synced: 5 days ago
JSON representation

Grafana Plugin SDK for Rust

• Host: GitHub
• URL: https://github.com/grafana/grafana-plugin-sdk-rust
• Owner: grafana
• License: apache-2.0
• Created: 2021-03-27T23:31:41.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-02T21:10:54.000Z (about 2 months ago)
• Last Synced: 2024-12-17T04:25:10.134Z (9 days ago)
• Topics: grafana, hacktoberfest, rust, sdk
• Language: Rust
• Homepage:
• Size: 1.96 MB
• Stars: 60
• Watchers: 138
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# Grafana Plugin SDK for Rust

[![Build Status](https://github.com/grafana/grafana-plugin-sdk-rust/actions/workflows/rust.yml/badge.svg)](https://github.com/grafana/grafana-plugin-sdk-rust/actions/workflows/rust.yml)

[![docs.rs](https://docs.rs/grafana-plugin-sdk/badge.svg)](https://docs.rs/grafana-plugin-sdk)

[![crates.io](https://img.shields.io/crates/v/grafana-plugin-sdk.svg)](https://crates.io/crates/grafana-plugin-sdk)

This is a Rust implementation of the Grafana Plugin SDK for Rust, similar to the [Grafana Plugin SDK for Go][go]. It can be used to build [backend plugins][] for Grafana.

## Current state

This SDK is still in development. The protocol between the Grafana server and the plugin SDK is considered stable, but the convenience functionality in the SDK may experience breaking changes.

**Disclaimer**: this Rust SDK is not (yet) an official Grafana Labs project! Use the [Go SDK][go] if higher maintainability and support standards are required. That being said, this crate will adhere to semantic versioning, and the authors will aim to respond to issues as far as possible.

## Related projects

The [grafana-sample-backend-plugin-rust][sample-plugin] repository contains a sample backend plugin with a backend written in Rust, along with a docker-compose setup with automatic plugin reloading.

## Developing

### Releasing

Releases are handled using [cargo-release][]. Run the following to dry-run release a new version of all crates:

```bash

cargo release  --workspace

```

If everything looks OK, add the `--execute` flag to go through with the release.

## License

The Rust SDK is licensed under either of the following, at your option:

- Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)

- MIT License (LICENSE-MIT or https://opensource.org/licenses/MIT)

[backend plugins]: https://grafana.com/docs/grafana/latest/developers/plugins/backend/

[cargo-release]: https://crates.io/crates/cargo-release

[go]: https://pkg.go.dev/github.com/grafana/grafana-plugin-sdk-go

[grafana-rs-datasource]: https://github.com/toddtreece/grafana-rs-datasource

[sample-plugin]: https://github.com/sd2k/grafana-sample-backend-plugin-rust/