/grafana-amazonprometheus-datasource

Prometheus Amazon Datasource

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

Amazon Managed Service for Prometheus Data Source

This data source plugin is for the Amazon Managed Service for Prometheus. It has all the features of the Grafana core Prometheus plugin with Amazon specific authentication in the configuration page.

Amazon Managed Service for Prometheus is a Prometheus-compatible service that monitors and provides alerts on containerized applications and infrastructure at scale.

Read more about it here:

https://aws.amazon.com/prometheus/

Getting started

Backend

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

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

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

    mage -v

  3. List all available Mage targets for additional commands:

    mage -l

Frontend

  1. Install dependencies

    yarn install

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

    yarn run dev

  3. Build plugin in production mode

    yarn run build

  4. Run the tests (using Jest)

    # Runs the tests and watches for changes, requires git init first
yarn run test

# Exits after running all the tests
yarn run test:ci

  5. Spin up a Grafana instance and run the plugin inside it (using Docker)

    yarn run server:configured

  6. Run the E2E tests (using Playwright and @grafana/plugin-e2e)

    # Spins up a Grafana docker instance (v11.0.0) (port 3000) with an actual Prometheus instance (port 9090)
yarn run server:configured

# Starts the e2e tests
yarn run e2e

  7. Run the linter

    yarn run lint

# or

yarn run lint:fix

Migrate from core Prometheus to Amazon Managed Service for Prometheus

If you are using core Prometheus with SigV4 authentication, you must migrate to the Amazon Managed Service for Prometheus data source because SigV4 auth is deprecated in core Prometheus. This topic summarizes the steps required to migrate from core Prometheus to Amazon Managed Service for Prometheus. See a detailed list of steps here.

  • Get the UID for Prometheus using SigV4.
  • Get the UID for your new Amazon Managed Service for Prometheus.
  • Update dashboards with the new datasource UID.
  • Update alert rules by exporting provisioning files and updating the data source in the model or create new alert rules.
  • Recreate correlations.
  • Recreate recorded queries.