com.appdynamics.iot

Class Instrumentation

java.lang.Object

com.appdynamics.iot.Instrumentation

public class Instrumentation
extends java.lang.Object

This class provides the following functionality

1. Registers with the AppDynamics EUM Cloud Collector
2. Provides methods to add different event types to the in-memory buffer
3. Event Support
   • Collect performance data for HTTP network requests NetworkRequestEvent
   • Collect error and exception events ErrorEvent
   • Collect any business specific custom event CustomEvent
   • Send a collection of events at a given time
4. Send the events over HTTPS. This call clears all beacons from the buffer
5. Manage the Instrumentation State

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Instrumentation.Severity
static class	Instrumentation.State

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
Instrumentation()

Method Summary

Modifier and Type	Method and Description
static void	addErrorEvent(java.lang.Throwable throwable, Instrumentation.Severity level)
static void	addEvent(Event event)
static HttpRequestTracker	beginHttpRequest(java.net.URL url)
static boolean	isAppKeyEnabledOnCloud() This call syncs the instrumentation runtime with the cloud for the appkey being used and returns true if the AppKey is enabled and the backend is ready to accept event data.
static boolean	isDisabled() If the controller sends a responseCode of 402, 403 or 429 to the app when it calls sendAllEvents(), the instrumentation runtime is put in a disabled state and the following calls become no-ops.
static void	sendAllEvents() This method sends all collected beacons to the AppDynamics Collector It flushes the in memory buffer after that If a CollectorChannel is set, the Beacons are sent over that If not, the default transport bundled with the SDK is used.
static void	start(AgentConfiguration configuration, DeviceInfo deviceInfo, VersionInfo versionInfo)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

Constructor Detail

Instrumentation

public Instrumentation()

Method Detail

start

public static void start(AgentConfiguration configuration,
                         DeviceInfo deviceInfo,
                         VersionInfo versionInfo)

Parameters:

configuration - Configuration of the Agent

deviceInfo - information about the device

versionInfo - version info about the

See Also:

AgentConfiguration, DeviceInfo, VersionInfo

isDisabled

public static boolean isDisabled()

If the controller sends a responseCode of 402, 403 or 429 to the app when it calls sendAllEvents(), the instrumentation runtime is put in a disabled state and the following calls become no-ops. addEvent(Event), addErrorEvent(Throwable, Severity), beginHttpRequest(URL), sendAllEvents() The current state of the APPKEY on the controller can be checked by calling isAppKeyEnabledOnCloud()

Returns:

true if the instrumentation runtime has been disabled

beginHttpRequest

public static HttpRequestTracker beginHttpRequest(java.net.URL url)

Parameters:

url - The URL of the Http Network Request being tracked

Returns:

The tracking object

addErrorEvent

public static void addErrorEvent(java.lang.Throwable throwable,
                                 Instrumentation.Severity level)

Parameters:

throwable - Report a throwable. If null, this method does nothing.

level - Level of the Error

1. Instrumentation.Severity.ALERT An error that didn't cause any issues
2. Instrumentation.Severity.CRITICAL An error that caused issues
3. Instrumentation.Severity.FATAL An error that killed the app

addEvent

public static void addEvent(Event event)

Parameters:

event - a user defined event

See Also:

Event

sendAllEvents

public static void sendAllEvents()

This method sends all collected beacons to the AppDynamics Collector It flushes the in memory buffer after that If a CollectorChannel is set, the Beacons are sent over that If not, the default transport bundled with the SDK is used. If the AppDynamics Collector returns an HTTP status code of 402, 403 or 429 the instrumentation runtime automatically gets disabled. A status check to see if the current AppKey is enabled or not can be called at any time using the call isAppKeyEnabledOnCloud()

See Also:

CollectorChannelFactory, isDisabled()

isAppKeyEnabledOnCloud

public static boolean isAppKeyEnabledOnCloud()

This call syncs the instrumentation runtime with the cloud for the appkey being used and returns true if the AppKey is enabled and the backend is ready to accept event data.

Returns:

false if the AppKey has been disabled for any reason. Some examples are turning off IoT Monitoring from UI or License Expiration.

See Also:

Instrumentation.State, isDisabled()