Merge pull request #150 from DataDog/xgouchet/RUMM-2050/add_verbosity

RUMM-2050 Add verbosity

Author: xgouchet

README.md

@@ -28,7 +28,7 @@ yarn add @datadog/mobile-react-native
 
 {{< img src="real_user_monitoring/react_native/image_reactnative.png" alt="Create a RUM application in Datadog workflow" style="width:90%;">}}
 
-To ensure the safety of your data, you must use a client token. If you used only [Datadog API keys][3] to configure the `@datadog/mobile-react-native` library, they would be exposed client-side in the React Native application's code. 
+To ensure the safety of your data, you must use a client token. If you used only [Datadog API keys][3] to configure the `@datadog/mobile-react-native` library, they would be exposed client-side in the React Native application's code.
 
 For more information about setting up a client token, see the [Client Token documentation][4].
 
@@ -40,8 +40,8 @@ import { DdSdkReactNative, DdSdkReactNativeConfiguration } from '@datadog/mobile
 
 
 const config = new DdSdkReactNativeConfiguration(
-    "<CLIENT_TOKEN>", 
-    "<ENVIRONMENT_NAME>", 
+    "<CLIENT_TOKEN>",
+    "<ENVIRONMENT_NAME>",
     "<RUM_APPLICATION_ID>",
     true, // track User interactions (e.g.: Tap on buttons).
     true, // track XHR Resources
@@ -52,6 +52,10 @@ config.site = "US1"
 config.nativeCrashReportEnabled = true
 // Optional: sample RUM sessions (here, 80% of session will be sent to Datadog. Default = 100%)
 config.sampleRate = 80
+// Optional: set the reported service name (by default, it'll use the package name / bundleIdentifier of your Android / iOS app respectively)
+config.serviceName = "com.example.reactnative"
+// Optional: let the SDK print internal logs (above or equal to the provided level. Default = undefined (meaning no logs))
+config.verbosity = SdkVerbosity.WARN
 
 await DdSdkReactNative.initialize(config)
 
@@ -65,8 +69,8 @@ import { DdSdkReactNative, DdSdkReactNativeConfiguration } from '@datadog/mobile
 
 
 const config = new DdSdkReactNativeConfiguration(
-    "<CLIENT_TOKEN>", 
-    "<ENVIRONMENT_NAME>", 
+    "<CLIENT_TOKEN>",
+    "<ENVIRONMENT_NAME>",
     "<RUM_APPLICATION_ID>",
     true, // track User interactions (e.g.: Tap on buttons).
     true, // track XHR Resources
@@ -90,8 +94,8 @@ import { DdSdkReactNative, DdSdkReactNativeConfiguration } from '@datadog/mobile
 
 
 const config = new DdSdkReactNativeConfiguration(
-    "<CLIENT_TOKEN>", 
-    "<ENVIRONMENT_NAME>", 
+    "<CLIENT_TOKEN>",
+    "<ENVIRONMENT_NAME>",
     "<RUM_APPLICATION_ID>",
     true, // track User interactions (e.g.: Tap on buttons).
     true, // track XHR Resources
@@ -115,8 +119,8 @@ import { DdSdkReactNative, DdSdkReactNativeConfiguration } from '@datadog/mobile
 
 
 const config = new DdSdkReactNativeConfiguration(
-    "<CLIENT_TOKEN>", 
-    "<ENVIRONMENT_NAME>", 
+    "<CLIENT_TOKEN>",
+    "<ENVIRONMENT_NAME>",
     "<RUM_APPLICATION_ID>",
     true, // track User interactions (e.g.: Tap on buttons).
     true, // track XHR Resources
@@ -140,8 +144,8 @@ import { DdSdkReactNative, DdSdkReactNativeConfiguration } from '@datadog/mobile
 
 
 const config = new DdSdkReactNativeConfiguration(
-    "<CLIENT_TOKEN>", 
-    "<ENVIRONMENT_NAME>", 
+    "<CLIENT_TOKEN>",
+    "<ENVIRONMENT_NAME>",
     "<RUM_APPLICATION_ID>",
     true, // track User interactions (e.g.: Tap on buttons).
     true, // track XHR Resources
@@ -190,17 +194,17 @@ Use one of Datadog's integrations to automatically track views for the following
 
 ## Track custom attributes
 
-You can attach user information to all RUM events to get more detailed information from your RUM sessions. 
+You can attach user information to all RUM events to get more detailed information from your RUM sessions.
 
 ### User information
 
 For user-specific information, use the following code wherever you want in your app (after the SDK has been initialized). The `id`, `name`, and `email` attributes are built into Datadog, and you can add other attributes that makes sense for your app.
 
 ```js
 DdSdkReactNative.setUser({
-    id: "1337", 
-    name: "John Smith", 
-    email: "[email protected]", 
+    id: "1337",
+    name: "John Smith",
+    email: "[email protected]",
     type: "premium"
 })
 ```

example/src/ddUtils.tsx

@@ -1,12 +1,12 @@
 import {
+    DdLogs,
     DdSdkReactNative,
     DdSdkReactNativeConfiguration,
-    DdLogs,
+    SdkVerbosity,
     TrackingConsent
 } from '@datadog/mobile-react-native';
 
-import { CLIENT_TOKEN, ENVIRONMENT, APPLICATION_ID } from './ddCredentials';
-import { getTrackingConsent } from './utils';
+import {APPLICATION_ID, CLIENT_TOKEN, ENVIRONMENT} from './ddCredentials';
 
 export function initializeDatadog(trackingConsent: TrackingConsent) {
 
@@ -22,6 +22,7 @@ export function initializeDatadog(trackingConsent: TrackingConsent) {
     config.nativeCrashReportEnabled = true
     config.sampleRate = 100
     config.serviceName = "com.datadoghq.reactnative.sample"
+    config.verbosity = SdkVerbosity.DEBUG;
 
     DdSdkReactNative.initialize(config).then(() => {
         DdLogs.info('The RN Sdk was properly initialized')

packages/core/README.md

@@ -35,8 +35,8 @@ import { DdSdkReactNative, DdSdkReactNativeConfiguration } from '@datadog/mobile
 
 
 const config = new DdSdkReactNativeConfiguration(
-    "<CLIENT_TOKEN>", 
-    "<ENVIRONMENT_NAME>", 
+    "<CLIENT_TOKEN>",
+    "<ENVIRONMENT_NAME>",
     "<RUM_APPLICATION_ID>",
     true, // track User interactions (e.g.: Tap on buttons. You can use 'accessibilityLabel' element property to give tap action the name, otherwise element type will be reported)
     true, // track XHR Resources
@@ -50,6 +50,8 @@ config.nativeCrashReportEnabled = true
 config.sampleRate = 80
 // Optional: set the reported service name (by default, it'll use the package name / bundleIdentifier of your Android / iOS app respectively)
 config.serviceName = "com.example.reactnative"
+// Optional: let the SDK print internal logs (above or equal to the provided level. Default = undefined (meaning no logs))
+config.verbosity = SdkVerbosity.WARN
 
 await DdSdkReactNative.initialize(config)
 

packages/core/src/DdSdkReactNative.tsx

@@ -4,16 +4,17 @@
  * Copyright 2016-Present Datadog, Inc.
  */
 
-import type { DdSdkReactNativeConfiguration } from "./DdSdkReactNativeConfiguration"
-import { DdSdkConfiguration } from "./types"
-import { DdSdk } from "./foundation"
-import { DdRumUserInteractionTracking } from './rum/instrumentation/DdRumUserInteractionTracking'
-import { DdRumErrorTracking } from './rum/instrumentation/DdRumErrorTracking'
-import { DdRumResourceTracking } from './rum/instrumentation/DdRumResourceTracking'
-import type { TrackingConsent } from "./TrackingConsent"
-import { ProxyType } from "./ProxyConfiguration"
-
-import {version as sdkVersion } from './version';
+import type {DdSdkReactNativeConfiguration} from "./DdSdkReactNativeConfiguration"
+import {DdSdkConfiguration} from "./types"
+import {DdSdk} from "./foundation"
+import {DdRumUserInteractionTracking} from './rum/instrumentation/DdRumUserInteractionTracking'
+import {DdRumErrorTracking} from './rum/instrumentation/DdRumErrorTracking'
+import {DdRumResourceTracking} from './rum/instrumentation/DdRumResourceTracking'
+import type {TrackingConsent} from "./TrackingConsent"
+import {ProxyType} from "./ProxyConfiguration"
+import {version as sdkVersion} from './version';
+import {InternalLog} from "./InternalLog"
+import {SdkVerbosity} from "./SdkVerbosity";
 
 /**
  * This class initializes the Datadog SDK, and sets up communication with the server.
@@ -47,10 +48,13 @@ export class DdSdkReactNative {
     static initialize(configuration: DdSdkReactNativeConfiguration): Promise<void> {
         return new Promise<void>((resolve, reject) => {
             if (DdSdkReactNative.wasInitialized) {
+                InternalLog.log("Can't initialize Datadog, SDK was already initialized", SdkVerbosity.WARN);
                 resolve()
                 return
             }
 
+            InternalLog.verbosity = configuration.verbosity
+
             configuration.additionalConfig[DdSdkReactNative.DD_SOURCE_KEY] = 'react-native';
             configuration.additionalConfig[DdSdkReactNative.DD_SDK_VERSION] = sdkVersion;
             configuration.additionalConfig[DdSdkReactNative.DD_NATIVE_VIEW_TRACKING_KEY] = configuration.nativeViewTracking;
@@ -94,6 +98,7 @@ export class DdSdkReactNative {
                     configuration.additionalConfig
                 )
             ).then(() => {
+                InternalLog.log("Datadog SDK was initialized", SdkVerbosity.INFO);
                 DdSdkReactNative.enableFeatures(configuration)
                 DdSdkReactNative.wasInitialized = true
                 resolve()
@@ -110,6 +115,7 @@ export class DdSdkReactNative {
      */
     // eslint-disable-next-line @typescript-eslint/ban-types
     static setAttributes(attributes: object): Promise<void> {
+        InternalLog.log("Setting attributes " + JSON.stringify(attributes), SdkVerbosity.DEBUG);
         return DdSdk.setAttributes(attributes)
     }
 
@@ -120,6 +126,7 @@ export class DdSdkReactNative {
      */
     // eslint-disable-next-line @typescript-eslint/ban-types
     static setUser(user: object): Promise<void> {
+        InternalLog.log("Setting user " + JSON.stringify(user), SdkVerbosity.DEBUG);
         return DdSdk.setUser(user)
     }
 
@@ -129,6 +136,7 @@ export class DdSdkReactNative {
      * @returns a Promise.
      */
     static setTrackingConsent(consent: TrackingConsent): Promise<void> {
+        InternalLog.log("Setting consent " + consent, SdkVerbosity.DEBUG);
         return DdSdk.setTrackingConsent(consent)
     }
 

packages/core/src/DdSdkReactNativeConfiguration.tsx

@@ -5,7 +5,7 @@
  */
 
 import { TrackingConsent } from './TrackingConsent'
-import type { NativeSdkVerbosity } from './NativeSdkVerbosity'
+import type { SdkVerbosity } from './SdkVerbosity'
 import type { ProxyConfiguration } from './ProxyConfiguration';
 
 /**
@@ -17,11 +17,11 @@ export class DdSdkReactNativeConfiguration {
     public nativeCrashReportEnabled: boolean = false;
     public sampleRate: number = 100.0;
     public site: string = "US"
-    public verbosity: NativeSdkVerbosity|undefined = undefined
+    public verbosity: SdkVerbosity|undefined = undefined
     public nativeViewTracking: boolean = false
     public proxyConfig?: ProxyConfiguration = undefined
     public serviceName?: string = undefined
-    
+
     public additionalConfig: {[k: string]: any} = {};
 
     constructor(

packages/core/src/InternalLog.tsx

@@ -0,0 +1,48 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+import {SdkVerbosity} from './SdkVerbosity'
+
+export class InternalLog {
+
+    private static levelMap = new Map<SdkVerbosity, number>([
+        [SdkVerbosity.DEBUG, 1],
+        [SdkVerbosity.INFO, 2],
+        [SdkVerbosity.WARN, 3],
+        [SdkVerbosity.ERROR, 4]
+    ]);
+
+    public static verbosity: SdkVerbosity|undefined = undefined
+
+    public static log (message: string, verbosity: SdkVerbosity): void {
+        if (InternalLog.verbosity === undefined) {
+            return;
+        }
+        const requiredLevel = InternalLog.levelMap.get(verbosity);
+        const allowedLevel = InternalLog.levelMap.get(InternalLog.verbosity);
+        if (allowedLevel === undefined || requiredLevel === undefined) {
+            return;
+        }
+        const prefixedMessage = "DATADOG: " + message
+        if (verbosity == SdkVerbosity.ERROR && (requiredLevel >= allowedLevel)) {
+            console.error(prefixedMessage)
+        }
+
+        if (verbosity == SdkVerbosity.WARN && (requiredLevel >= allowedLevel)) {
+            console.warn(prefixedMessage)
+        }
+
+        if (verbosity == SdkVerbosity.INFO && (requiredLevel >= allowedLevel)) {
+            console.info(prefixedMessage)
+        }
+
+        if (verbosity == SdkVerbosity.DEBUG && (requiredLevel >= allowedLevel)) {
+            console.debug(prefixedMessage)
+        }
+    }
+
+
+}

packages/core/src/NativeSdkVerbosity.tsx packages/core/src/SdkVerbosity.tsxpackages/core/src/NativeSdkVerbosity.tsx renamed to packages/core/src/SdkVerbosity.tsx

@@ -5,9 +5,9 @@
  */
 
 /**
- * Enum specifying possible consent options for DD SDK.
+ * Enum specifying possible log levels for DD SDK.
  */
-export enum NativeSdkVerbosity {
+export enum SdkVerbosity {
     DEBUG = "debug",
     INFO = "info",
     WARN = "warn",

packages/core/src/__tests__/DdSdkReactNative.test.tsx

@@ -13,7 +13,7 @@ import { DdRumUserInteractionTracking } from '../rum/instrumentation/DdRumUserIn
 import { DdRumResourceTracking } from '../rum/instrumentation/DdRumResourceTracking'
 import { DdRumErrorTracking } from '../rum/instrumentation/DdRumErrorTracking'
 import { TrackingConsent } from '../TrackingConsent'
-import { NativeSdkVerbosity } from '../NativeSdkVerbosity'
+import { SdkVerbosity } from '../SdkVerbosity'
 import { ProxyType } from '../ProxyConfiguration'
 
 import { version as sdkVersion } from '../version';
@@ -301,7 +301,7 @@ it('M enable sdk verbosity W initialize { sdk verbosity }', async () => {
     const fakeClientToken = "2"
     const fakeEnvName = "env"
     const configuration = new DdSdkReactNativeConfiguration(fakeClientToken, fakeEnvName, fakeAppId, false, false, true)
-    configuration.verbosity = NativeSdkVerbosity.DEBUG
+    configuration.verbosity = SdkVerbosity.DEBUG
 
     NativeModules.DdSdk.initialize.mockResolvedValue(null)
 
@@ -317,7 +317,7 @@ it('M enable sdk verbosity W initialize { sdk verbosity }', async () => {
     expect(ddSdkConfiguration.additionalConfig).toStrictEqual({
         '_dd.source': 'react-native',
         '_dd.sdk_version': sdkVersion,
-        '_dd.sdk_verbosity': NativeSdkVerbosity.DEBUG,
+        '_dd.sdk_verbosity': SdkVerbosity.DEBUG,
         '_dd.native_view_tracking': false,
         '_dd.long_task.threshold': 200
     })