OpenTelemetry instrumentation attributes

AppSignal supports multiple OpenTelemetry language integrations. However, the data model may not always align perfectly, which can affect how OpenTelemetry data is displayed in the AppSignal interface. By using the attributes listed on this page, you can customize the appearance of trace and span data.

🔐 Do not send Personal Identifiable Information (PII) to AppSignal. Filter PII (e.g., names, emails) and use an ID, hash, or pseudonymized identifier instead.

For HIPAA-covered entities, more info on signing a Business Associate Agreement (BAA) is available in our Business Add-Ons documentation.

Accessing a span

Python
Go (golang)

When customizing the trace or span, first import the OpenTelemetry trace module in the file you want to customize the reported trace data.

from opentelemetry import trace

Using that trace module, create a new span:

tracer = trace.get_tracer(__name__)
with tracer.start_as_current_span("Span name") as span:
    # Set attribute values
    span.set_attribute("attribute name", "attribute value")

Or fetch the current active one:

span = trace.get_current_span()
# Set attribute values
span.set_attribute("attribute name", "attribute value")

When customizing the trace or span, first import the OpenTelemetry trace module in the file you want to customize the reported trace data.

import (
	"go.opentelemetry.io/otel"
	"go.opentelemetry.io/otel/attribute"
	"go.opentelemetry.io/otel/trace"
)

Using that trace module, create a new span:

var tracer = otel.Tracer("my-tracer-name")

func httpHandler(w http.ResponseWriter, r *http.Request) {
	ctx, span := tracer.Start(r.Context(), "hello-span")
	defer span.End()

	// Set attributes
}

Note: In these examples we’re relying on the context from the HTTP request, given by r.Context(). Receiving the context may be different in your application.Or fetch the current active one:

func httpHandler(w http.ResponseWriter, r *http.Request) {
	ctx := r.Context()
    span := trace.SpanFromContext(ctx)

	// Set attributes
}

AppSignal attributes

Namespace

This attribute applies to the entire trace. It can be set on a child span, and does not need to be set on the uppermost parent span. This attribute can only be set once per trace. If it is set multiple times, only the attribute from one span in the trace is applied.

Attribute name: appsignal.namespace
Value type: String

Group traces by namespace for better organization in the AppSignal interface. Namespaces are grouped per OpenTelemetry service name with the format <Service name>/<Namespace>, e.g. “Web server/admin” or “Background worker/billing”. This attribute allows you to configure the namespace part only. The default namespace for all traces is <Service name>/default.

span.set_attribute("appsignal.namespace", "admin")

span.SetAttributes(attribute.String("appsignal.namespace", "admin"))

Root action name

Attribute name: appsignal.action_name
Value type: String

Set the action name of the trace that will be used to create incidents and group tracing on AppSignal.com. This will overwrite any automated mapping done by the AppSignal support for specific instrumentation. It is useful for traces that are not created by supported libraries. If your trace is grouped with other not named or poorly grouped traces, it may be missing this attribute. We aim to improve our automatic grouping over time, so please let us know when you find that this attribute is needed.

span.set_attribute("appsignal.action_name", "ControllerName#action")

span.SetAttributes(attribute.String("appsignal.action_name", "ControllerName#action"))