# `Appsignal`
[🔗](https://github.com/appsignal/appsignal-elixir/blob/v2.17.0/lib/appsignal.ex#L1)

AppSignal for Elixir. Follow the [installation
guide](https://docs.appsignal.com/elixir/installation.html) to install
AppSignal into your Elixir app.

This module contains the main AppSignal OTP application, as well as a few
helper functions for sending metrics to AppSignal.

# `add_distribution_value`

```elixir
@spec add_distribution_value(String.t(), float() | integer(), map()) :: :ok
```

Add a value to a distribution

Use this to collect multiple data points that will be merged into a graph.

# `heartbeat`

> This function is deprecated. Use `Appsignal.CheckIn.cron/1` instead..

```elixir
@spec heartbeat(String.t()) :: :ok
```

# `heartbeat`

> This function is deprecated. Use `Appsignal.CheckIn.cron/2` instead..

```elixir
@spec heartbeat(String.t(), (-&gt; out)) :: out when out: var
```

# `increment_counter`

```elixir
@spec increment_counter(String.t(), number(), map()) :: :ok
```

Increment a counter of a metric.

# `instrument`

# `instrument`

# `instrument`

# `send_error`

# `send_error`

# `send_error`

# `set_error`

# `set_error`

# `set_gauge`

```elixir
@spec set_gauge(String.t(), float() | integer(), map()) :: :ok
```

Set a gauge for a measurement of a metric.

---

*Consult [api-reference.md](api-reference.md) for complete listing*
