Skip to main content

​
Installation

A Webmachine application requires a few manual steps to get working.
  1. Create the AppSignal configuration file or configure it with environment variables. For more details on configuring AppSignal, see the Ruby configuration page.
  2. Make sure AppSignal is required, require "appsignal".
  3. Configure AppSignal using Appsignal.config.
  4. Start AppSignal using Appsignal.start.
An example of a Webmachine app.rb file:
After these steps, start your Webmachine app and wait for data to arrive in AppSignal.

​
Request headers

Webmachine reports the request headers named in the request_headers configuration option, or in keep_request_headers when using a collector. Earlier versions reported no request headers at all.

​
Span attributes

Collector mode only: this applies when AppSignal for Ruby runs in collector mode. It has no effect otherwise.
The request’s span carries:
  • http.request.method — the request method.
  • url.scheme, url.path, and url.query — the address that was requested.
  • http.response.status_code — the status your application responded with.
A span for a request that raised also carries error.type, the class of the error.

​
Distributed tracing

Collector mode only: this applies when AppSignal for Ruby runs in collector mode. It has no effect otherwise.
A request that arrives with a traceparent request header continues the trace it names. The request appears inside the calling service’s trace, under the request that caused it. You can follow a slow request from that service into this application without switching traces. The HTTP clients AppSignal supports start the trace. A request without the header starts a new one.