AppSignal v0.0.1 Appsignal.Transaction

Functions related to Appsignal transactions

This module contains functions for starting and stopping an Appsignal transaction, recording events and collecting metrics within a transaction, et cetera.

Summary

Types

namespace()

The transaction’s namespace

transaction()

Datatype which is used as a handle to the current Appsignal transaction

Functions

complete(transaction)

Complete a transaction

finish(transaction)

Finish a transaction

finish_event(transaction, name, title, body, body_format \\ 0)

Finish an event

generate_id()

Generate a random id as a string to use as transaction identifier

set_action(transaction, action)

Set action of a transaction

set_error(transaction, error, message, backtrace)

Set an error for a transaction

set_meta_data(transaction, key, value)

Set metadata for a transaction

set_queue_start(transaction, start \\ -1)

Set queue start time of a transaction

set_sample_data(transaction, key, payload)

Set sample data for a transaction

start(transaction_id, namespace)

Start a transaction

start_event(transaction)

Start an event

Types

namespace :: :http_request | :background_job

The transaction’s namespace

transaction :: %Appsignal.Transaction{id: term, resource: term}

Datatype which is used as a handle to the current Appsignal transaction.

Functions

complete(transaction)

Specs

complete(transaction) :: :ok

Complete a transaction

Call this after finishing a transaction (and adding sample data if necessary).

transaction: The pointer to the transaction this event occurred in

finish(transaction)

Specs

finish(transaction) :: :sample | :no_sample

Finish a transaction

Call this when a transaction such as a http request or background job ends.

transaction: The pointer to the transaction this event occurred in

Returns :sample wether sample data for this transaction should be collected.

finish_event(transaction, name, title, body, body_format \\ 0)

Specs

finish_event(transaction, String.t, String.t, String.t, integer) :: transaction

Finish an event

Call this when an event ends.

transaction: The pointer to the transaction this event occurred in
name: Name of the category of the event (sql.query, net.http)
title: Title of the event (‘User load’, ‘Http request to google.com’)
body: Body of the event, should not contain unique information per specific event (select * from users where id=?)
body_format Format of the event’s body which can be used for sanitization, 0 for general and 1 for sql currently.

generate_id()

Specs

generate_id :: String.t

Generate a random id as a string to use as transaction identifier.

set_action(transaction, action)

Specs

set_action(transaction, String.t) :: transaction

Set action of a transaction

Call this when the identifying action of a transaction is known.

transaction: The pointer to the transaction this event occurred in
action: This transactions action ("HomepageController.show")

set_error(transaction, error, message, backtrace)

Specs

set_error(transaction, String.t, String.t, any) :: transaction

Set an error for a transaction

Call this when an error occurs within a transaction.

transaction: The pointer to the transaction this event occurred in
name: Name of the error (RuntimeError)
message: Message of the error (‘undefined method call for something’)
backtrace: Backtrace of the error; will be JSON encoded

set_meta_data(transaction, key, value)

Specs

set_meta_data(transaction, String.t, String.t) :: transaction

Set metadata for a transaction

Call this when an error occurs within a transaction to set more detailed data about the error

transaction: The pointer to the transaction this event occurred in
key: Key of this piece of metadata ("email")
value: Value of this piece of metadata ("thijs@appsignal.com")

set_queue_start(transaction, start \\ -1)

Specs

set_queue_start(transaction, integer) :: transaction

Set queue start time of a transaction

Call this when the queue start time in miliseconds is known.

transaction: The pointer to the transaction this event occurred in
queue_start: Transaction queue start time in ms if known, otherwise -1

set_sample_data(transaction, key, payload)

Specs

set_sample_data(transaction, String.t, any) :: transaction

Set sample data for a transaction

Use this to add sample data if finish_transaction returns true.

transaction: The pointer to the transaction this event occurred in
key: Key of this piece of metadata (params, session_data)
payload: Metadata (e.g. %{user_id: 1}); will be JSON encoded

start(transaction_id, namespace)

Specs

start(String.t, namespace) :: transaction

Start a transaction

Call this when a transaction such as a http request or background job starts.

Parameters:

transaction_id The unique identifier of this transaction
namespace The namespace of this transaction. Must be one of :http_request, :background_job.

The function returns a %Transaction{} struct for use with the the other transaction functions in this module.

start_event(transaction)

Specs

start_event(transaction) :: transaction

Start an event

Call this when an event within a transaction you want to measure starts, such as an SQL query or http request.

transaction: The pointer to the transaction this event occurred in.