Custom namespaces for Elixir apps

For more information about what namespaces are, please see our namespaces documentation.

Configuring a namespace

Using the Appsignal.set_namespace/2 function it's possible to set a namespace for a transaction.

This can be done per transaction with custom instrumentation, added in a the controller in a Phoenix application, or set via a plug to configure it for all requests of a certain Phoenix controller.

It's also possible to configure the namespace when creating the transaction. Please see the documentation for decorators or instrumentation helpers on how to configure a namespace.

Once the namespace is set and the application is sending data to the AppSignal servers, the new namespace will appear in the app navigation on AppSignal.com. Note: Data previously reported for the same action is not moved to the new namespace.

1
2
3
4
5
6
7
8
9
10
11
12
# In a Phoenix controller
defmodule AppsignalPhoenixExampleWeb.AdminController do
  use AppsignalPhoenixExampleWeb, :controller

  plug :set_namespace

  defp set_namespace(conn, _params) do
    Appsignal.Transaction.set_namespace(:admin)
    conn
  end

  # ...

Ignore by namespace

To ignore all actions in a namespace you can configure AppSignal to ignore one or more namespaces in your app's configuration. It's also possible to only ignore one or more specific actions.

Ignoring actions or namespaces will ignore all transaction data from this action or namespace. No errors and performance issues will be reported. Custom metrics data recorded in an action will still be reported.

For more information about this config option, see the ignore_namespaces config option documentation.

1
2
3
4
5
# config/appsignal.exs
use Mix.Config

config :appsignal, :config,
  ignore_namespaces: ["admin", "private"]

You can also configure ignore namespaces using an environment variable.

1
export APPSIGNAL_IGNORE_NAMESPACES="admin,private"