AppDynamics.Agent.AgentConfiguration Class Reference

AgentConfiguration represents the application's configuration of the AppDynamics SDK. More...

Inheritance diagram for AppDynamics.Agent.AgentConfiguration:

Static Public Member Functions
static IAgentConfiguration	Create (string appKey)
	Create an instance of AgentConfiguration More...

Properties
string	AppKey [get, set]
	Gets or sets the application key used by the SDK. More...
string	ApplicationName [get, set]
	Gets or sets the name of this mobile application. More...
string	CollectorURL [get, set]
	Gets or sets the collector URL. More...
string	ScreenshotURL [get, set]
	Gets or sets the screenshot service URL. More...
LoggingLevel	LoggingLevel [get, set]
	Gets or sets the logging level. More...
string	ReachabilityHostname [get, set]
	The hostname used to determine whether the device is connected to the internet. More...
ISet< string >	ExcludedURLPatterns [get, set]
	The URL regex patterns for excluding URL request tracking More...
bool	ScreenshotsEnabled [get, set]
	Enables or disables the screenshots. More...
bool	EnableExceptionReporting [get, set]
	Enables or disables the reporting of all exceptions as crashes. More...

Detailed Description

AgentConfiguration represents the application's configuration of the AppDynamics SDK.

The AppKey must be defined. The other properties can be defined for special circumstances.

Member Function Documentation

Create()

static IAgentConfiguration AppDynamics.Agent.AgentConfiguration.Create ( string  appKey )

inlinestatic

Create an instance of AgentConfiguration

Parameters

appKey

App key.

Exceptions

Exception

Thrown when parameter appKey is not the format of AD-AAA-BBB.

Property Documentation

AppKey

string AppDynamics.Agent.AgentConfiguration.AppKey

getset

Gets or sets the application key used by the SDK.

This is a required property.

The app key.

Exceptions

Exception

Thrown when the value is not in the format of AD-AAA-BBB.

ApplicationName

string AppDynamics.Agent.AgentConfiguration.ApplicationName

getset

Gets or sets the name of this mobile application.

Most users will not need this.

For Android, the format should follow Java-language-style. It may contain uppercase or lowercase letters('A' through 'Z'), numbers, and underscores('_'). Individual package name parts may only start with letters. Reverse-DNS format is recommended.

For iOS, the format should follow Apple Bundle IDs. It may contain uppercase or lowercase letters('A' through 'Z'), numbers, and hyphens('-'). Reverse-DNS format is recommended.

All data reported from this application is associated with applicationName, and appears together in dashboards.

The name of the application.

Exceptions

Exception

Thrown when the value is not in the right format

CollectorURL

string AppDynamics.Agent.AgentConfiguration.CollectorURL

getset

Gets or sets the collector URL.

Only use this if you are using an on-premise collector.

The collector URL.

EnableExceptionReporting

bool AppDynamics.Agent.AgentConfiguration.EnableExceptionReporting

getset

Enables or disables the reporting of all exceptions as crashes.

By default, the Xamarin agent will report exceptions as a crash report. This switch can be used to disable this feature.

Default true.

ExcludedURLPatterns

ISet<string> AppDynamics.Agent.AgentConfiguration.ExcludedURLPatterns

getset

The URL regex patterns for excluding URL request tracking

If set, any URL matching one of defined patterns won't be tracked.

The excluded URL patterns.

LoggingLevel

LoggingLevel AppDynamics.Agent.AgentConfiguration.LoggingLevel

getset

Gets or sets the logging level.

Default is LoggingLevel.None.

See also

LoggingLevel

Not recommended for production use.

The logging level.

ReachabilityHostname

string AppDynamics.Agent.AgentConfiguration.ReachabilityHostname

getset

The hostname used to determine whether the device is connected to the internet.

In order to determine if a device is connected to the internet, the agent SDK checks if a network route to the specific host is available. If that host is not reachable, the device is marked as "offline".

If the application has restrictions on the IP addresses it is allowed to freely access, then this property should be used with a host the application can reach that is expected to be available to ensure the connection type is accurate.

Hostname or IP address, default is: www.google.com

ScreenshotsEnabled

bool AppDynamics.Agent.AgentConfiguration.ScreenshotsEnabled

getset

Enables or disables the screenshots.

This feature is not available on C# agents.

Default false.

ScreenshotURL

string AppDynamics.Agent.AgentConfiguration.ScreenshotURL

getset

Gets or sets the screenshot service URL.

Only use this if you are using an on-premise screenshot service and it is different than the collector.

See also

CollectorURL

The screenshot service URL.

---

The documentation for this class was generated from the following file:

• shared/AgentConfiguration.cs