https://github.com/houseninjadojo/capacitor-datadog
Capacitor plugin for Datadog RUM
https://github.com/houseninjadojo/capacitor-datadog
capacitor capacitor-plugin datadog datadog-apm datadog-logs telemetry
Last synced: 15 days ago
JSON representation
Capacitor plugin for Datadog RUM
- Host: GitHub
- URL: https://github.com/houseninjadojo/capacitor-datadog
- Owner: houseninjadojo
- Created: 2022-11-15T12:57:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-09T22:13:36.000Z (over 2 years ago)
- Last Synced: 2025-05-02T14:09:05.833Z (28 days ago)
- Topics: capacitor, capacitor-plugin, datadog, datadog-apm, datadog-logs, telemetry
- Language: TypeScript
- Homepage:
- Size: 207 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# @houseninja/capacitor-datadog
Capacitor plugin for Datadog RUM
## Install
```bash
npm install @houseninja/capacitor-datadog
npx cap sync
```
## API
* [`init(...)`](#init)
* [`setUserInfo(...)`](#setuserinfo)
* [`addUserExtraInfo(...)`](#adduserextrainfo)
* [`addUserAction(...)`](#adduseraction)
* [`addAttribute(...)`](#addattribute)
* [`removeAttribute(...)`](#removeattribute)
* [`addError(...)`](#adderror)
* [Interfaces](#interfaces)
* [Enums](#enums)
### init(...)
```typescript
init(clientToken: string, applicationId: string, service: string) => Promise
```
| Param | Type |
| ------------------- | ------------------- |
| **`clientToken`** | string |
| **`applicationId`** | string |
| **`service`** | string |
--------------------
### setUserInfo(...)
```typescript
setUserInfo(id?: string | undefined, name?: string | undefined, email?: string | undefined, extraInfo?: { [key: string]: string; } | undefined) => Promise
```
| Param | Type |
| --------------- | --------------------------------------- |
| **`id`** | string |
| **`name`** | string |
| **`email`** | string |
| **`extraInfo`** | { [key: string]: string; } |
--------------------
### addUserExtraInfo(...)
```typescript
addUserExtraInfo(extraInfo: { [key: string]: string; }) => Promise
```
| Param | Type |
| --------------- | --------------------------------------- |
| **`extraInfo`** | { [key: string]: string; } |
--------------------
### addUserAction(...)
```typescript
addUserAction(type: RUMUserActionType, name: string, attributes: { [key: string]: string; }) => Promise
```
| Param | Type |
| ---------------- | --------------------------------------------------------------- |
| **`type`** | RUMUserActionType |
| **`name`** | string |
| **`attributes`** | { [key: string]: string; } |
--------------------
### addAttribute(...)
```typescript
addAttribute(key: string, value: string) => Promise
```
| Param | Type |
| ----------- | ------------------- |
| **`key`** | string |
| **`value`** | string |
--------------------
### removeAttribute(...)
```typescript
removeAttribute(key: string) => Promise
```
| Param | Type |
| --------- | ------------------- |
| **`key`** | string |
--------------------
### addError(...)
```typescript
addError(error: unknown, context?: Context | undefined) => Promise
```
| Param | Type |
| ------------- | ------------------------------------------- |
| **`error`** | unknown |
| **`context`** | Context |
--------------------
### Interfaces
#### Context
### Enums
#### RUMUserActionType
| Members | Value |
| ------------ | --------------------- |
| **`tap`** | 'tap' |
| **`click`** | 'click' |
| **`scroll`** | 'scroll' |
| **`swipe`** | 'swipe' |
| **`custom`** | 'custom' |