appd-ionic-capacitor-plugin

AppDynamics Mobile EUM Agent Plugin

Install

Download the repository this README is in. https://github.com/jeremydavis02/appd-ionic-capacitor-plugin
In the downloaded repos main folder run 'npm install'
Then run 'npm run build'
In the ionic application we then run 'npm install /path/to/plugin/repo'
In the ionic application then run 'npx cap sync'
In the IOS application within the ionic application the cocoa pod install of the AppDynamics Agent should be done, referenced here: https://docs.appdynamics.com/appd/22.x/22.5/en/end-user-monitoring/mobile-real-user-monitoring/instrument-ios-applications/install-the-ios-sdk#id-.InstalltheiOSSDKv22.1-cocoapods-install
In the Android application with the ionic application, there should be an /app/build.gradle file that should have the below added below the apply plugin: 'com.android.application' line:

buildscript { repositories { google() mavenCentral() } dependencies { classpath 'com.android.tools.build:gradle:7.2.1' classpath "com.appdynamics:appdynamics-gradle-plugin:22.2.2" } }

apply plugin: 'adeum'

API

echo(...)
startTimer(...)
stopTimer(...)
reportMetricWithName(...)
leaveBreadcrumb(...)
setUserData(...)
removeUserData(...)
reportError(...)
beginCall(...)
endCall(...)
beginHttpRequest(...)
reportDone(...)
withResponseCode(...)
withResponseContentLength(...)
withRequestContentLength(...)
withResponseHeaderFields(...)
withRequestHeaderFields(...)
withInstrumentationSource(...)
withErrorMessage(...)
getCorrelationHeaders()
startNextSession()
unblockScreenshots()
blockScreenshots()
screenshotsBlocked()
takeScreenshot()
startSessionFrame(...)
endSessionFrame(...)
updateSessionFrameName(...)
getVersion()
clear()
Interfaces
Enums

echo(...)

echo(options: EchoOptions) => Promise<EchoOptions>

Param	Type
`options`	`EchoOptions`

Returns: Promise<EchoOptions>

startTimer(...)

startTimer(options: StartTimerOptions) => Promise<void>

Param	Type
`options`	`StartTimerOptions`

stopTimer(...)

stopTimer(options: StopTimerOptions) => Promise<void>

Param	Type
`options`	`StopTimerOptions`

reportMetricWithName(...)

reportMetricWithName(options: ReportMetricWithNameOptions) => Promise<void>

Param	Type
`options`	`ReportMetricWithNameOptions`

leaveBreadcrumb(...)

leaveBreadcrumb(options: LeaveBreadcrumbOptions) => Promise<void>

Param	Type
`options`	`LeaveBreadcrumbOptions`

setUserData(...)

setUserData(options: SetUserDataOptions) => Promise<void>

Param	Type
`options`	`SetUserDataOptions`

removeUserData(...)

removeUserData(options: RemoveUserDataOptions) => Promise<void>

Param	Type
`options`	`RemoveUserDataOptions`

reportError(...)

reportError(options: ReportErrorOptions) => Promise<void>

Param	Type
`options`	`ReportErrorOptions`

beginCall(...)

beginCall(options: BeginCallOptions) => Promise<EndCallOptions>

Param	Type
`options`	`BeginCallOptions`

Returns: Promise<EndCallOptions>

endCall(...)

endCall(options: EndCallOptions) => Promise<void>

Param	Type
`options`	`EndCallOptions`

beginHttpRequest(...)

beginHttpRequest(options: BeginHttpRequestOptions) => Promise<{ http_tracker: string; }>

Param	Type
`options`	`BeginHttpRequestOptions`

Returns: Promise<{ http_tracker: string; }>

reportDone(...)

reportDone(options: ReportDoneOptions) => Promise<void>

Param	Type
`options`	`ReportDoneOptions`

withResponseCode(...)

withResponseCode(options: HttpTrackerResponseCodeOptions) => Promise<void>

Param	Type
`options`	`HttpTrackerResponseCodeOptions`

withResponseContentLength(...)

withResponseContentLength(options: HttpTrackerContentLengthOptions) => Promise<void>

Param	Type
`options`	`HttpTrackerContentLengthOptions`

withRequestContentLength(...)

withRequestContentLength(options: HttpTrackerContentLengthOptions) => Promise<void>

Param	Type
`options`	`HttpTrackerContentLengthOptions`

withResponseHeaderFields(...)

withResponseHeaderFields(options: HttpTrackerHeaderOptions) => Promise<void>

Param	Type
`options`	`HttpTrackerHeaderOptions`

withRequestHeaderFields(...)

withRequestHeaderFields(options: HttpTrackerHeaderOptions) => Promise<void>

Param	Type
`options`	`HttpTrackerHeaderOptions`

withInstrumentationSource(...)

withInstrumentationSource(options: HttpTrackerInstrumentationSourceOptions) => Promise<void>

Param	Type
`options`	`HttpTrackerInstrumentationSourceOptions`

withErrorMessage(...)

withErrorMessage(options: HttpTrackerErrorMessageOptions) => Promise<void>

Param	Type
`options`	`HttpTrackerErrorMessageOptions`

getCorrelationHeaders()

getCorrelationHeaders() => Promise<{ headers: Map<string, string>; }>

Returns: Promise<{ headers: Map<string, string>; }>

startNextSession()

startNextSession() => Promise<void>

unblockScreenshots()

unblockScreenshots() => Promise<void>

blockScreenshots()

blockScreenshots() => Promise<void>

screenshotsBlocked()

screenshotsBlocked() => Promise<{ screenshots_blocked: boolean; }>

Returns: Promise<{ screenshots_blocked: boolean; }>

takeScreenshot()

takeScreenshot() => Promise<void>

startSessionFrame(...)

startSessionFrame(options: StartSessionFrameOptions) => Promise<{ session_frame: string; }>

Param	Type
`options`	`StartSessionFrameOptions`

Returns: Promise<{ session_frame: string; }>

endSessionFrame(...)

endSessionFrame(options: EndSessionFrameOptions) => Promise<void>

Param	Type
`options`	`EndSessionFrameOptions`

updateSessionFrameName(...)

updateSessionFrameName(options: UpdateSessionFrameOptions) => Promise<{ session_frame: string; }>

Param	Type
`options`	`UpdateSessionFrameOptions`

Returns: Promise<{ session_frame: string; }>

getVersion()

getVersion() => Promise<{ version: string; }>

Returns: Promise<{ version: string; }>

clear()

clear() => Promise<void>

Interfaces

EchoOptions

Prop	Type
`value`	`string`

StartTimerOptions

Prop	Type
`name`	`string`

StopTimerOptions

Prop	Type
`name`	`string`

ReportMetricWithNameOptions

Prop	Type
`name`	`string`
`value`	`number`

LeaveBreadcrumbOptions

Prop	Type
`name`	`string`

SetUserDataOptions

Prop	Type
`key`	`string`
`value`	`string`

RemoveUserDataOptions

Prop	Type
`key`	`string`

ReportErrorOptions

Prop	Type
`error`	`string`
`errorDomain`	`string`
`errorCode`	`number`
`errorStack`	`boolean`
`errorSeverity`	`ErrorSeverityLevel`

EndCallOptions

Prop	Type
`call_tracker`	`string`

BeginCallOptions

Prop	Type
`className`	`string`
`methodName`	`string`
`withArguments`	`[]`

BeginHttpRequestOptions

Prop	Type
`url`	`string`

ReportDoneOptions

Prop	Type
`http_tracker`	`string`

HttpTrackerResponseCodeOptions

Prop	Type
`http_tracker`	`string`
`status_code`	`string`

HttpTrackerContentLengthOptions

Prop	Type
`http_tracker`	`string`
`content_length`	`number`

HttpTrackerHeaderOptions

Prop	Type
`http_tracker`	`string`
`http_headers`	`Map<string, string>`

Map

Prop	Type
`size`	`number`

Method	Signature
clear	() => void
delete	(key: K) => boolean
forEach	(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any) => void
get	(key: K) => V \| undefined
has	(key: K) => boolean
set	(key: K, value: V) => this

HttpTrackerInstrumentationSourceOptions

Prop	Type
`http_tracker`	`string`
`information_source`	`string`

HttpTrackerErrorMessageOptions

Prop	Type
`http_tracker`	`string`
`error_message`	`string`

StartSessionFrameOptions

Prop	Type
`session_frame_name`	`string`

EndSessionFrameOptions

Prop	Type
`session_frame`	`string`

UpdateSessionFrameOptions

Prop	Type
`session_frame_name`	`string`
`session_frame`	`string`

Enums

ErrorSeverityLevel

Members	Value
`errorLevelInfo`	`0`
`errorLevelWarn`
`errorLevelCritical`

Name		Name	Last commit message	Last commit date
Latest commit History 45 Commits
.history		.history
.vscode		.vscode
android		android
example		example
ios		ios
src		src
.eslintignore		.eslintignore
.gitignore		.gitignore
.prettierignore		.prettierignore
AppdIonicCapacitorPlugin.podspec		AppdIonicCapacitorPlugin.podspec
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
rollup.config.js		rollup.config.js
tsconfig.json		tsconfig.json

jsdavis02/appd-ionic-capacitor-plugin

Folders and files

Latest commit

History

Repository files navigation

appd-ionic-capacitor-plugin

Install

API

echo(...)

startTimer(...)

stopTimer(...)

reportMetricWithName(...)

leaveBreadcrumb(...)

setUserData(...)

removeUserData(...)

reportError(...)

beginCall(...)

endCall(...)

beginHttpRequest(...)

reportDone(...)

withResponseCode(...)

withResponseContentLength(...)

withRequestContentLength(...)

withResponseHeaderFields(...)

withRequestHeaderFields(...)

withInstrumentationSource(...)

withErrorMessage(...)

getCorrelationHeaders()

startNextSession()

unblockScreenshots()

blockScreenshots()

screenshotsBlocked()

takeScreenshot()

startSessionFrame(...)

endSessionFrame(...)

updateSessionFrameName(...)

getVersion()

clear()

Interfaces

EchoOptions

StartTimerOptions

StopTimerOptions

ReportMetricWithNameOptions

LeaveBreadcrumbOptions

SetUserDataOptions

RemoveUserDataOptions

ReportErrorOptions

EndCallOptions

BeginCallOptions

BeginHttpRequestOptions

ReportDoneOptions

HttpTrackerResponseCodeOptions

HttpTrackerContentLengthOptions

HttpTrackerHeaderOptions

Map

HttpTrackerInstrumentationSourceOptions

HttpTrackerErrorMessageOptions

StartSessionFrameOptions

EndSessionFrameOptions

UpdateSessionFrameOptions

Enums

ErrorSeverityLevel

About

Resources

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 2

Uh oh!

Languages

Packages