AppDynamics Xamarin SDK  2021.9.0
Real user monitoring for your Xamarin app.
Properties | Events | List of all members
AppDynamics.Agent.IAgentConfiguration Interface Reference

Inherited by AppDynamics.Agent.AgentConfigurationImpl.

Properties

string AppKey [get, set]
 Gets or sets the application key used by the SDK. More...
 
string CollectorURL [get, set]
 Gets or sets the collector URL. More...
 
string ScreenshotURL [get, set]
 Gets or sets the screenshot service URL. More...
 
string ReachabilityHostname [get, set]
 The hostname used to determine whether the device is connected to the internet. More...
 
LoggingLevel LoggingLevel [get, set]
 Gets or sets the logging level. More...
 
string ApplicationName [get, set]
 Gets or sets the name of this mobile application. 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 EnableAggregateExceptionReporting [get, set]
 Enables or disables the reporting of aggregate exceptions as crashes. More...
 
Func< IHttpRequestTracker, bool > OnNetworkRequest [get, set]
 Invoked when a network request is intercepted by the agent. More...
 
bool CrashReportingEnabled [get, set]
 Enables or disables the reporting of crashes. More...
 

Events

EventHandler< IEnumerable< CrashReportSummary > > OnCrash
 The agent supports the use of an event to send notifications of crashes being reported. You can use this event to get these reports.
 

Property Documentation

§ AppKey

string AppDynamics.Agent.IAgentConfiguration.AppKey
getset

Gets or sets the application key used by the SDK.

This is a required property.

The app key.

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

§ ApplicationName

string AppDynamics.Agent.IAgentConfiguration.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
ExceptionThrown when the value is not in the right format

§ CollectorURL

string AppDynamics.Agent.IAgentConfiguration.CollectorURL
getset

Gets or sets the collector URL.

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

The collector URL.

§ CrashReportingEnabled

bool AppDynamics.Agent.IAgentConfiguration.CrashReportingEnabled
getset

Enables or disables the reporting of crashes.

By default, the Xamarin agent will report unhandled main thread exceptions and unobserved task exceptions as a crash report. This switch can be used to disable this feature.

Default true.

§ EnableAggregateExceptionReporting

bool AppDynamics.Agent.IAgentConfiguration.EnableAggregateExceptionReporting
getset

Enables or disables the reporting of aggregate exceptions as crashes.

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

Default false.

§ ExcludedURLPatterns

ISet<string> AppDynamics.Agent.IAgentConfiguration.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.IAgentConfiguration.LoggingLevel
getset

Gets or sets the logging level.

Default is LoggingLevel.Off.

Not recommended for production use.

§ OnNetworkRequest

Func<IHttpRequestTracker, bool> AppDynamics.Agent.IAgentConfiguration.OnNetworkRequest
getset

Invoked when a network request is intercepted by the agent.

The request in question will be sent through this interface so that it can be modified, in your code, prior to it being recorded as a beacon.

Return True to have the beacon, modified or not, recorded. Return False to stop the beacon from being recorded for this occurance.

Currently, only the URL property can be modified, in the future other properties will/may be added.Calling the -reportDone on this object will have no effect.

§ ReachabilityHostname

string AppDynamics.Agent.IAgentConfiguration.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.IAgentConfiguration.ScreenshotsEnabled
getset

Enables or disables the screenshots.

This feature is not available on C# agents.

Default false.

§ ScreenshotURL

string AppDynamics.Agent.IAgentConfiguration.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 interface was generated from the following file: