@fiberplane/prometheus-query

fiberplane-prometheus-query

TypeScript package for querying Prometheus.

This package provides a subset of the functionality of the Prometheus Provider that is useful for TypeScript projects where importing the entire Provider runtime would be overkill.

The query responses are converted to Provider types and are compatible with our Provider Protocol. This also ensures they're readily usable with fiberplane-charts.

Please see https://github.com/fiberplane/providers for the original provider written in Rust.

Contributing

If you want to test a work-in-progress in a downstream project, you can use yarn build && yarn pack to create a tarball you can reference like such:

  "dependencies": {
    "@fiberplane/prometheus-query": "/path/to/package.tgz"
  }

Sharing a custom branch

If you want to share a WIP branch with others, it might be more convenient to forcibly check in the dist/ folder, which you can do like so:

yarn build
git add -f dist
git commit -m "WIP"
git push -u origin branch_name

Then point your dependency in the downstream project to the custom branch using the following syntax:

  "dependencies": {
    "@fiberplane/prometheus-query": "https://[e-mail]/fiberplane/fiberplane.git#workspace=fiberplane-prometheus-query&head=<branch_name>"
  }

If you want to update prometheus-query while using the above syntax, you may use yarn up "@fiberplane/prometheus-query@<full-dependency-url>".

Make sure to remove the dist/ folder before opening a PR. CI will fail if you don't, so you'll be reminded if you forget :)