Installation

Auto-generate your docs

Getting started with PromGleam is straightforward. You’ll have metrics up and running in your project in just a few minutes.

Requirements

Before installing PromGleam, make sure you have:

PromGleam only supports the Erlang target. If you’re building for JavaScript, you’ll need a different metrics solution.

Add the package

Add PromGleam to your project using the Gleam package manager:

gleam add promgleam

This will add the latest version of PromGleam to your gleam.toml file.

Verify installation

Check that PromGleam was added to your dependencies in gleam.toml:

[dependencies]
promgleam = ">= 0.2.0 and < 1.0.0"

Import in your code

You can now import PromGleam modules in your Gleam code:

import promgleam/metrics/counter
import promgleam/metrics/gauge
import promgleam/metrics/histogram
import promgleam/registry

When you install PromGleam, these dependencies are automatically installed:

You don’t need to install or configure these dependencies manually. The Gleam package manager handles everything for you.

Now that you have PromGleam installed, continue to the quickstart guide to create your first metric.

⌘I