Packages
appsignal
2.17.4
2.17.4
2.17.3
2.17.2
2.17.1
2.17.0
2.16.0
2.15.11
2.15.10
2.15.9
2.15.8
2.15.7
2.15.6
2.15.5
2.15.4
2.15.3
2.15.2
2.15.1
2.15.0
2.14.1
2.14.0
2.13.4
2.13.3
2.13.2
2.13.1
2.13.0
2.12.3
2.12.2
2.12.1
2.12.0
2.11.0
2.10.2
2.10.1
2.10.0
2.9.2
2.9.1
2.9.0
2.8.3
2.8.2
2.8.1
2.8.0
2.7.13
2.7.12
2.7.11
2.7.10
2.7.9
2.7.8
2.7.7
2.7.6
2.7.5
2.7.4
2.7.3
2.7.2
2.7.1
2.7.0
2.7.0-beta.1
2.6.1
2.6.0
2.5.3
2.5.2
2.5.1
2.5.0
2.4.3
2.4.2
2.4.1
2.4.0
2.3.1
2.3.0
2.2.19
2.2.18
2.2.17
2.2.16
2.2.15
2.2.14
2.2.13
2.2.12
retired
2.2.11
2.2.10
2.2.9
2.2.8
2.2.7
2.2.6
2.2.5
2.2.4
2.2.3
2.2.2
2.2.1
2.2.0
2.1.15
2.1.14
2.1.13
2.1.12
2.1.11
2.1.10
2.1.9
2.1.8
2.1.7
2.1.7-beta.1
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.8
2.0.7
2.0.6
2.0.6-beta.1
2.0.5
retired
2.0.4
retired
2.0.3
retired
2.0.2
retired
2.0.1
retired
2.0.0
retired
2.0.0-beta.11
2.0.0-beta.10
2.0.0-beta.9
2.0.0-beta.8
2.0.0-beta.7
2.0.0-beta.6
2.0.0-beta.5
2.0.0-beta.4
2.0.0-beta.3
2.0.0-beta.2
2.0.0-beta.1
2.0.0-alpha.7
2.0.0-alpha.6
2.0.0-alpha.5
2.0.0-alpha.4
2.0.0-alpha.3
2.0.0-alpha.2
2.0.0-alpha.1
1.13.5
1.13.4
1.13.3
1.13.2
1.13.1
1.13.0
1.13.0-beta.2
1.13.0-beta.1
1.12.1
1.12.0
1.12.0-beta.3
1.12.0-beta.2
1.12.0-beta.1
1.11.8
1.11.7
1.11.6
1.11.5
1.11.4
1.11.3
1.11.2
1.11.1
1.11.0
1.11.0-beta.1
1.10.13
1.10.12
1.10.11
1.10.10
1.10.9
1.10.8
1.10.7
1.10.6
1.10.5
1.10.4
1.10.3
1.10.2
1.10.1
1.10.0
1.9.4
1.9.3
1.9.2
1.9.1
1.9.1-beta.1
1.9.0
1.9.0-beta.1
1.9.0-alpha.1
1.8.2
1.8.1
1.8.1-beta.2
1.8.1-beta.1
1.8.0
1.7.2
1.7.1
1.7.0
1.7.0-beta.2
1.7.0-beta.1
1.7.0-alpha.4
1.7.0-alpha.3
1.7.0-alpha.2
1.7.0-alpha.1
1.6.7
1.6.6
1.6.6-beta.2
1.6.6-beta.1
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-beta.1
1.6.0-alpha.1
1.5.1
1.5.0
1.5.0-beta.2
1.5.0-beta.1
1.4.11-beta.1
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.4.0-alpha.1
1.3.6
1.3.6-beta.1
1.3.5
1.3.4
1.3.4-beta.1
1.3.3
1.3.2
1.3.1
1.3.0
1.3.0-beta.3
1.3.0-beta.2
1.3.0-beta.1
1.2.3
1.2.2
1.2.1
1.2.0
1.1.1
1.1.0
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
1.0.0-rc.1
0.13.0
0.12.3
0.12.2
0.12.1
0.12.0
0.11.6
0.11.5
0.11.4
0.11.3
0.11.2
0.11.1
0.11.0
0.10.0
0.9.2
0.9.1
0.9.0
0.8.0
0.7.1
0.7.0
0.6.2
0.6.1
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
0.0.1
Collects error and performance data from your Elixir applications and sends it to AppSignal
Current section
Files
Jump to
Current section
Files
lib/appsignal.ex
defmodule Appsignal do
@moduledoc """
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.
"""
@os Application.compile_env(:appsignal, :os_internal, :os)
@installation_report Application.compile_env(
:appsignal,
:appsignal_diagnose_installation_report,
Appsignal.Diagnose.InstallationReport
)
use Application
alias Appsignal.Config
require Logger
@doc false
def start(_type, _args) do
import Supervisor.Spec, warn: false
initialize()
if Config.error_backend_enabled?() do
Appsignal.Error.Backend.attach()
end
if Config.instrument_ecto?() do
Appsignal.Ecto.attach()
end
if Config.instrument_finch?() do
Appsignal.Finch.attach()
end
if Config.instrument_oban?() do
Appsignal.Oban.attach()
end
if Config.instrument_tesla?() do
Appsignal.Tesla.attach()
end
if Config.instrument_absinthe?() do
Appsignal.Absinthe.attach()
end
children = [
{Appsignal.Tracer, []},
{Appsignal.Monitor, []},
{Appsignal.Probes, []},
{Appsignal.CheckIn.Scheduler, []},
{Finch, name: AppsignalFinch, pools: %{default: Appsignal.Transmitter.pool_options()}}
]
result = Supervisor.start_link(children, strategy: :one_for_one, name: Appsignal.Supervisor)
# Add our default system probes. It's important that this is called after
# the Suportvisor has started. Otherwise the GenServer cannot register the
# probe.
add_default_probes()
result
end
@doc false
def stop(_state) do
Appsignal.IntegrationLogger.debug("AppSignal stopping.")
end
@doc false
def config_change(_changed, _new, _removed) do
# Spawn a separate process that reloads the configuration. AppSignal can't
# reload it in the same process because the GenServer would continue
# calling itself once it reached `Application.put_env` in
# `Appsignal.Config`.
spawn(fn ->
Appsignal.Nif.stop()
initialize()
end)
:ok
end
@doc false
@spec initialize() :: :ok
def initialize do
case {Config.initialize(), Config.configured_as_active?()} do
{_, false} ->
Logger.info("AppSignal disabled.")
{:ok, true} ->
Appsignal.IntegrationLogger.debug("AppSignal starting.")
Config.write_to_environment()
Appsignal.Nif.start()
if Appsignal.Nif.loaded?() do
Appsignal.IntegrationLogger.debug("AppSignal started.")
else
log_nif_loading_error()
end
{{:error, :invalid_config}, true} ->
Logger.warning(
"Warning: No valid AppSignal configuration found, continuing with " <>
"AppSignal metrics disabled."
)
end
end
@doc false
def add_default_probes do
# This is a workaround for https://github.com/erlang/otp/issues/5425.
:erlang.system_flag(:scheduler_wall_time, true)
Appsignal.Probes.register(:erlang, &Appsignal.Probes.ErlangProbe.call/1)
end
@doc """
Set a gauge for a measurement of a metric.
"""
@spec set_gauge(String.t(), float | integer, map) :: :ok
def set_gauge(key, value, tags \\ %{})
def set_gauge(key, value, tags) when is_integer(value) do
set_gauge(key, value + 0.0, tags)
end
def set_gauge(key, value, %{} = tags) when is_float(value) do
encoded_tags = Appsignal.Utils.DataEncoder.encode(tags)
:ok = Appsignal.Nif.set_gauge(key, value, encoded_tags)
end
@doc """
Increment a counter of a metric.
"""
@spec increment_counter(String.t(), number, map) :: :ok
def increment_counter(key, count \\ 1, tags \\ %{})
def increment_counter(key, count, %{} = tags) when is_number(count) do
encoded_tags = Appsignal.Utils.DataEncoder.encode(tags)
:ok = Appsignal.Nif.increment_counter(key, count + 0.0, encoded_tags)
end
@doc """
Add a value to a distribution
Use this to collect multiple data points that will be merged into a graph.
"""
@spec add_distribution_value(String.t(), float | integer, map) :: :ok
def add_distribution_value(key, value, tags \\ %{})
def add_distribution_value(key, value, tags) when is_integer(value) do
add_distribution_value(key, value + 0.0, tags)
end
def add_distribution_value(key, value, %{} = tags) when is_float(value) do
encoded_tags = Appsignal.Utils.DataEncoder.encode(tags)
:ok = Appsignal.Nif.add_distribution_value(key, value, encoded_tags)
end
defdelegate instrument(fun), to: Appsignal.Instrumentation
defdelegate instrument(name, fun), to: Appsignal.Instrumentation
defdelegate instrument(name, category, fun), to: Appsignal.Instrumentation
defdelegate set_error(exception, stacktrace), to: Appsignal.Instrumentation
defdelegate set_error(kind, reason, stacktrace), to: Appsignal.Instrumentation
defdelegate send_error(exception, stacktrace), to: Appsignal.Instrumentation
defdelegate send_error(kind, reason, stacktrace), to: Appsignal.Instrumentation
defdelegate send_error(kind, reason, stacktrace, fun), to: Appsignal.Instrumentation
@spec heartbeat(String.t()) :: :ok
@deprecated "Use `Appsignal.CheckIn.cron/1` instead."
defdelegate heartbeat(name), to: Appsignal.CheckIn, as: :cron
@spec heartbeat(String.t(), (-> out)) :: out when out: var
@deprecated "Use `Appsignal.CheckIn.cron/2` instead."
defdelegate heartbeat(name, fun), to: Appsignal.CheckIn, as: :cron
defp log_nif_loading_error do
arch = parse_architecture(to_string(:erlang.system_info(:system_architecture)))
{_, target_list} = @os.type()
target = to_string(target_list)
{install_arch, install_target} = fetch_installed_architecture_target()
if arch == install_arch && target == install_target do
Appsignal.IntegrationLogger.error(
"AppSignal failed to load the extension. Please run the diagnose tool and email us at support@appsignal.com: https://docs.appsignal.com/elixir/command-line/diagnose.html\n",
stderr: true
)
else
Appsignal.IntegrationLogger.error(
"The AppSignal NIF was installed for architecture '#{install_arch}-#{install_target}', but the current architecture is '#{arch}-#{target}'. Please reinstall the AppSignal package on the host the app is started: mix deps.compile appsignal --force",
stderr: true
)
end
end
# Parse install report and fetch the architecture and target
defp fetch_installed_architecture_target do
case @installation_report.read_install() do
{:ok, raw_report} ->
case Jason.decode(raw_report) do
{:ok, report} ->
%{"build" => %{"architecture" => arch, "target" => target}} = report
{parse_architecture(arch), target}
{:error, reason} ->
Appsignal.IntegrationLogger.error(
"Failed to parse the AppSignal 'install.report' file: #{inspect(reason)}",
stderr: true
)
{"unknown", "unknown"}
end
{:error, reason} ->
Appsignal.IntegrationLogger.error(
"Failed to read the AppSignal 'install.report' file: #{inspect(reason)}",
stderr: true
)
{"unknown", "unknown"}
end
end
# Transform `aarch64-apple-darwin21.3.0` to `aarch64`
defp parse_architecture(arch_parts) do
List.first(String.split(arch_parts, "-", parts: 2))
end
end