CONTRIBUTING.md

How to build X-Ray data source plugin locally

To build X-Ray data source locally you should follow the steps below.

Frontend

1. Install dependencies

yarn install

2. Build plugin in development mode or run in watch mode

yarn dev

or

yarn watch

3. Build plugin in production mode

yarn build

Backend

1. Update Grafana plugin SDK for Go dependency to the latest minor version:

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

2. Build backend plugin binaries for Linux, Windows and Darwin:

mage -v

3. List all available Mage targets for additional commands:

mage -l

4. Watch all go sources, rebuild on change and reload plugin in running Grafana (need Bra installed):

bra run

Testing

E2E Tests

1. Ensure you have the AWS X-Ray E2E data source provisioned in the provisioning/datasources directory

2. Start the server

yarn server

3. Run the tests

yarn e2e

# Optionally show the report, the report automatically shows if any tests fail
yarn e2e:report

Building a release

You need to have commit rights to the GitHub repository to publish a release.

1. Update the version number in the package.json file.
2. Update the CHANGELOG.md by copy and pasting the relevant PRs from Github's Release drafter interface or by running yarn generate-release-notes (you'll need to install the gh cli and jq to run this command).
3. PR the changes.
4. Once merged, follow the Drone release process that you can find here

Learn more

• Build a data source backend plugin tutorial
• Grafana documentation
• Grafana Tutorials - Grafana Tutorials are step-by-step guides that help you make the most of Grafana
• Grafana UI Library - UI components to help you build interfaces using Grafana Design System
• Grafana plugin SDK for Go