org.glowroot.agent.api

Class Glowroot

java.lang.Object

org.glowroot.agent.api.Glowroot

public class Glowroot
extends Object

Method Summary

Modifier and Type	Method and Description
static void	addTransactionAttribute(String name, String value) Adds an attribute on the current transaction with the specified name and value.
static void	setTransactionName(String transactionName) Set the transaction name that is used for aggregation.
static void	setTransactionOuter() FOR ADVANCED USE CASE ONLY.
static void	setTransactionSlowThreshold(long threshold, TimeUnit unit) Overrides the default slow trace threshold (Configuration > General > Slow trace threshold) for the current transaction.
static void	setTransactionType(String transactionType) Set the transaction type that is used for aggregation.
static void	setTransactionUser(String user) Sets the user attribute on the transaction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addTransactionAttribute

public static void addTransactionAttribute(String name,
                                           String value)

Adds an attribute on the current transaction with the specified name and value. A transaction's attributes are displayed when viewing a trace on the trace explorer page. Subsequent calls to this method with the same name on the same transaction will add an additional attribute if there is not already an attribute with the same name and value. If there is no current transaction then this method does nothing. null values are normalized to the empty string.

setTransactionName

public static void setTransactionName(String transactionName)

Set the transaction name that is used for aggregation. If there is no current transaction then this method does nothing.

setTransactionOuter

public static void setTransactionOuter()

FOR ADVANCED USE CASE ONLY. This should be used in very limited circumstances. E.g. a really long "outer" transaction that processes thousands of objects, where it is useful to track the processing details per object as separate transactions, but also useful to track the overarching long "outer" transaction. If there is no current transaction then this method does nothing.

setTransactionSlowThreshold

public static void setTransactionSlowThreshold(long threshold,
                                               TimeUnit unit)

Overrides the default slow trace threshold (Configuration > General > Slow trace threshold) for the current transaction. This can be used to store particular traces at a lower or higher threshold than the general threshold. If this is called multiple times for a given transaction, the minimum threshold will be used. If there is no current transaction then this method does nothing.

setTransactionType

public static void setTransactionType(String transactionType)

Set the transaction type that is used for aggregation. If there is no current transaction then this method does nothing.

setTransactionUser

public static void setTransactionUser(String user)

Sets the user attribute on the transaction. If there is no current transaction then this method does nothing.