@balena/jellyfish-metrics

Metrics library for Jellyfish

Usage no npm install needed!

<script type="module">
  import balenaJellyfishMetrics from 'https://cdn.skypack.dev/@balena/jellyfish-metrics';
</script>

README

Jellyfish Metrics

This library gathers Prometheus metrics and exposes them to be scraped by balena-monitor. Jellyfish production metrics can be found in this dashboard.

Usage

Below is an example how to use this library:

const metrics = require('@balena/jellyfish-metrics')

// Start server to expose gathered metrics data.
metrics.startServer(context, portNumber)

// Mark that a card was read from the database.
metrics.markCardReadFromDatabase(card)

Documentation

Adding metrics

Visit the website for complete documentation: https://product-os.github.io/jellyfish-metrics