org.glowroot.agent.api.Glowroot Maven / Gradle / Ivy
/*
* Copyright 2015-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.glowroot.agent.api;
import java.util.concurrent.TimeUnit;
import org.glowroot.agent.shaded.org.checkerframework.checker.nullness.qual.Nullable;
import org.glowroot.agent.api.internal.GlowrootService;
import org.glowroot.agent.api.internal.GlowrootServiceHolder;
public class Glowroot {
private static final GlowrootService service = GlowrootServiceHolder.get();
private Glowroot() {}
/**
* Set the transaction type that is used for aggregation.
*
* If there is no current transaction then this method does nothing.
*/
public static void setTransactionType(@Nullable String transactionType) {
service.setTransactionType(transactionType);
}
/**
* Set the transaction name that is used for aggregation.
*
* If there is no current transaction then this method does nothing.
*/
public static void setTransactionName(@Nullable String transactionName) {
service.setTransactionName(transactionName);
}
/**
* Sets the user attribute on the transaction.
*
* If there is no current transaction then this method does nothing.
*/
public static void setTransactionUser(@Nullable String user) {
service.setTransactionUser(user);
}
/**
* Adds an attribute on the current transaction with the specified {@code name} and
* {@code value}. A transaction's attributes are displayed when viewing a trace on the trace
* explorer page.
*
* Subsequent calls to this method with the same {@code name} on the same transaction will add
* an additional attribute if there is not already an attribute with the same {@code name} and
* {@code value}.
*
* If there is no current transaction then this method does nothing.
*
* {@code null} values are normalized to the empty string.
*/
public static void addTransactionAttribute(String name, @Nullable String value) {
service.addTransactionAttribute(name, value);
}
/**
* 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 {@code threshold} will
* be used.
*
* If there is no current transaction then this method does nothing.
*/
public static void setTransactionSlowThreshold(long threshold, TimeUnit unit) {
service.setTransactionSlowThreshold(threshold, unit);
}
/**
* 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.
*/
public static void setTransactionOuter() {
service.setTransactionOuter();
}
}