Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grafana/grafana-llm-app
Plugin to easily allow LLM based extensions to grafana
https://github.com/grafana/grafana-llm-app
Last synced: 27 days ago
JSON representation
Plugin to easily allow LLM based extensions to grafana
- Host: GitHub
- URL: https://github.com/grafana/grafana-llm-app
- Owner: grafana
- License: apache-2.0
- Created: 2023-06-06T04:15:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-16T22:26:53.000Z (7 months ago)
- Last Synced: 2024-04-18T15:56:54.690Z (7 months ago)
- Language: TypeScript
- Homepage:
- Size: 11.2 MB
- Stars: 43
- Watchers: 95
- Forks: 4
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LLM Plugin and frontend libraries repo
This repository holds separate packages for Grafana LLM Plugin and the `@grafana/llm` package for interfacing with it.
They are placed into a monorepo because they are tighlty coupled, and should be developed together with identical dependencies where possible.
Each package has its own package.json with its own npm commands, but the intention is that you should be able to run and test both of them from root.
## Developing these packages
### Quickstart
1. Install node >= 20, go >= 1.21, and [Mage](https://magefile.org/).
2. Install docker
3. Run `npm install`
4. Run `npm run dev`
5. In a separate terminal from dev, run `npm run server`
If you want to bring up the vector services, you can run `COMPOSE_PROFILES=vector yarn run server` instead
6. Go to (http://localhost:3000/plugins/grafana-llm-app) to see configuration page and the developer sandbox
This will watch the frontend dependencies and update live. If you are changing backend dependencies, you can run `npm run backend:restart` to rebuild the backend dependencies and restart the plugin in the Grafana server.
### Dev Sandbox
It is recommended to develop functionality against the "developer sandbox", only available when the app is run in dev mode, that can be opened from the configuration page, because it gives you a clean end to end test of any changes. This can be used for modifications to the @grafana/llm library, the backend plugin, or functionality built on top of those packages.
### Backend
It is recommended to run these using npm commands from root so that the entire project can be developed from the root directory. If you want to dig into the commands themselves, you can read the corresponding scripts in ./packages/grafana-llm-app/package.json
1. Update [Grafana plugin SDK for Go](https://grafana.com/developers/plugin-tools/key-concepts/backend-plugins/grafana-plugin-sdk-for-go) dependency to the latest minor version:
```bash
npm run backend:update-sdk
```
2. Build backend plugin binaries for Linux, Windows and Darwin:
```bash
npm run backend:build
```
3. Test the backend
```bash
npm run backend:test
```
4. To see all available Mage targets for additional commands, run this from ./packages/grafana-llm-app/:
```bash
mage -l
```
### Frontend
1. Install dependencies
```bash
npm install
```
2. Build plugin in development mode and run in watch mode
```bash
npm run dev
```
3. Build plugin in production mode
```bash
npm run build
```
4. Run the tests (using Jest)
```bash
# Runs the tests and watches for changes, requires git init first
npm run test
# Exits after running all the tests
npm run test:ci
```
5. Spin up a Grafana instance and run the plugin inside it (using Docker)
```bash
npm run server
```
6. Run the E2E tests (using Cypress)
```bash
# Spins up a Grafana instance first that we tests against
npm run e2e:ci
```
7. Run the linter
```bash
npm run lint
# or
npm run lint:fix
```
## Release process
### Plugin Release
- Bump version in `packages/grafana-llm-app/package.json` (e.g., 0.2.0 to 0.2.1)
- Add notes to changelog describing changes since last release
- Merge PR for a branch containing those changes into main
- Trigger release from "actions" tab on Github.
### llmclient Release
- Push a new tag to the repo (e.g., `git tag -a llmclient/v0.X.X -m "llmclient v0.X.X release"`)