Namespaces são uma forma de agrupar incidentes de erro, incidentes de desempenho e métricas de ações. O AppSignal usa três namespaces por padrão:
web para requisições webfrontend para JavaScript de front-endbackground para jobs em segundo plano
Os aplicativos podem ter qualquer número de namespaces. Por exemplo, você pode ter um namespace separado para o painel de administração do seu aplicativo, API ou tarefas agendadas. Este guia abordará as etapas necessárias para reportar ações em namespaces personalizados.
Configurando namespaces
Os namespaces são definidos pelo código do seu aplicativo. Com pequenos helpers, você pode personalizar o namespace de uma ação. Este guia ensinará como dividir as requisições em diferentes namespaces. Para este guia, criaremos um namespace “admin” e um namespace “critical” para jobs em segundo plano.
Os nomes de namespace só podem conter letras (a-z) e sublinhados
Não recomendamos ter mais de 15 namespaces por aplicativo.
Configurações por linguagem
Ruby
No Rails, podemos usar o callback before_action para chamar um método antes que uma requisição seja tratada. No exemplo de código abaixo, criamos um before_action que chama o método set_appsignal_namespace. Neste método, chamamos o método helper Appsignal.set_namespace para configurar “admin” como o namespace para esta requisição. Isso também funciona se outros controllers forem subclasses do AdminController.
# Em um controller Rails
# app/controllers/admin_controller.rb
class AdminController < ApplicationController
before_action :set_appsignal_namespace
def set_appsignal_namespace
# Configura todas as ações neste controller para reportar
# no namespace "admin"
Appsignal.set_namespace("admin")
end
# Qualquer outra ação do controller
end
# Em um worker Sidekiq
# app/workers/critical_worker.rb
class CriticalWorker
include Sidekiq::Worker
def perform
# Configura os jobs deste worker para reportar no namespace "critical"
Appsignal.set_namespace("critical")
# O código real do worker
end
end
Appsignal.monitor. Ele aceita o namespace como um argumento de palavra-chave.
# Ao criar uma nova transação
Appsignal.monitor(namespace: "admin") do
# Seu código a ser instrumentado
end
set_namespace para configurar o namespace da transação, como no exemplo abaixo:
# Ao alterar o namespace posteriormente para uma transação
transaction.set_namespace("slow_admin")
Uma nota sobre a localização do helper
Os helpers set_namespace usados neste guia podem ser chamados em qualquer ação que faça parte de uma amostra do AppSignal. Recomendamos chamar isso o mais cedo possível na requisição ou job em segundo plano, para que a transação seja configurada com o namespace fornecido antes que qualquer erro ocorra. Caso contrário, se ocorrer um erro ou qualquer outra coisa que pare o processo, a transação será enviada ao AppSignal antes que o helper set_namespace seja chamado, e a amostra será reportada sob o namespace padrão.
Leia mais
Elixir
Em controllers Phoenix, usamos um plug para chamar uma função antes que a requisição seja tratada pelo Phoenix. No exemplo de código abaixo, usamos plug para chamar a função set_appsignal_namespace (linha 5). Nesta função, chamamos o helper Appsignal.Span.set_namespace para configurar o namespace para esta requisição (linha 10).
# Em um controller Phoenix
defmodule AppsignalPhoenixExampleWeb.AdminController do
use AppsignalPhoenixExampleWeb, :controller
plug :set_appsignal_namespace
defp set_appsignal_namespace(conn, _params) do
# Configura todas as ações neste controller para reportar
# no namespace "admin"
Appsignal.Span.set_namespace(Appsignal.Tracer.root_span(), "admin")
conn
end
# ...
end
Appsignal.Span.set_namespace deve ser chamado no início da função antes de qualquer outro código, como na linha 4 do exemplo de código abaixo:
defmodule MyApp.CriticalJob do
def run do
# Configura os jobs deste worker para reportar no namespace "critical"
Appsignal.Span.set_namespace(Appsignal.Tracer.root_span(), "critical")
# O código real do worker
end
end
Uma nota sobre a localização do helper
Os helpers set_namespace usados neste guia podem ser chamados em qualquer ação que inicie uma transação do AppSignal. Recomendamos chamar isso o mais cedo possível na requisição ou job em segundo plano, para que a transação seja configurada com o namespace fornecido antes que qualquer erro ocorra. Caso contrário, se ocorrer um erro—ou qualquer outra coisa que pare o processo—a transação será enviada ao AppSignal antes que o código set_namespace seja chamado e será reportada sob o namespace padrão.
Leia mais
Node.js
Em aplicativos Node.js, o AppSignal funciona com o OpenTelemetry, que usa spans para rastrear metadados, como a qual namespace um span pertence. Use a função helper setNamespace como no exemplo abaixo para definir o namespace para o trace do span ativo.
import { setNamespace } from "@appsignal/nodejs";
setNamespace("custom-namespace");
PHP
Em aplicativos PHP, o AppSignal funciona com o OpenTelemetry, que usa spans para rastrear metadados, como a qual namespace um span pertence. Use o método helper Appsignal::setNamespace para definir o namespace para o trace do span ativo.
Appsignal::setNamespace("admin");
Python
Em aplicativos Python, o AppSignal funciona com o OpenTelemetry, que usa spans para rastrear metadados, como a qual namespace um span pertence. Use a função helper set_namespace como no exemplo abaixo para definir o namespace para o trace do span ativo.
from appsignal import set_namespace
set_namespace("custom-namespace")
JavaScript de front-end
Em aplicativos JavaScript de front-end, o AppSignal funciona com spans para rastrear metadados, como o namespace de um span.
Diferente de Ruby, Node.js, PHP e Python, a API JavaScript de front-end não
possui um helper global setNamespace / set_namespace. Em vez disso, como Elixir,
Go e Java, você define o namespace diretamente em um span.
setNamespace com um valor String do nome do namespace desejado, conforme demonstrado no exemplo abaixo:
const span = appsignal.createSpan();
span.setNamespace("admin"); // um namespace personalizado para este span (padrão é `frontend`)
appsignal.namespace com um valor String do novo namespace.
span.SetAttributes(attribute.String("appsignal.namespace", "admin"))
appsignal.namespace forem encontrados, o span com o timestamp mais novo prevalece.
Leia mais sobre como a instrumentação personalizada funciona em Go.
Java
Em aplicativos Java, o AppSignal funciona com o OpenTelemetry, que usa spans para rastrear metadados, como a qual namespace um span pertence. Em qualquer span no trace, defina um atributo appsignal.namespace com um valor String do novo namespace.
span.setAttribute("appsignal.namespace", "admin");
appsignal.namespace forem encontrados, o span com o timestamp mais novo prevalece.
Leia mais sobre como a instrumentação personalizada funciona em Java.
Deploy
Quando seu aplicativo estiver configurado com seus novos helpers de namespace, faça o commit das alterações e o deploy do app. Quando o app iniciar/reiniciar, o AppSignal reportará ações sob seu novo namespace 🥳!
Os dados de deploys antigos permanecerão agrupados pelo seu namespace original.
Apenas ações recém-reportadas serão agrupadas pelos seus novos namespaces.
Leitura adicional
