feat(logs): Add support for logs (#920)

* add support for logs

* add changelog

Author: lucas-zimerman

CHANGELOG.md

@@ -8,12 +8,45 @@
 
 ## Unreleased
 
+#### Features
+
+- Add experimental support for Log tracing ([#920](https://github.com/getsentry/sentry-capacitor/pull/920))
+
+To enable it add the following code to your Sentry Options:
+
+```typescript
+Sentry.init({
+  // other options...
+  _experiments: {
+    enableLogs: true,
+  },
+});
+```
+
+You can also filter the logs being collected by adding beforeSendLogs into `_experiments`
+
+```typescript
+Sentry.init({
+  // other options...
+  _experiments: {
+    enableLogs: true,
+    beforeSendLog: log => {
+      return log;
+    },
+  },
+});
+```
+
 ### Dependencies
 
 - Bump Android SDK from v8.13.2 to v8.13.3 ([#919](https://github.com/getsentry/sentry-capacitor/pull/919))
   - [changelog](https://github.com/getsentry/sentry-java/blob/main/CHANGELOG.md#8133)
   - [diff](https://github.com/getsentry/sentry-java/compare/8.13.2...8.13.3)
 
+### Self Hosted
+
+- It is recommended to use Sentry Self Hosted version `25.2.0` or new for Sentry Capacitor V2 or newer
+
 ## 2.0.0-beta.2
 
 ### Features

android/src/main/java/io/sentry/capacitor/SentryCapacitor.java

@@ -144,6 +144,8 @@ public void initNativeSdk(final PluginCall call) {
                     }
                 }
 
+                options.getLogs().setEnabled(Boolean.TRUE.equals(capOptions.getBoolean("enableLogs", false)));
+
                 logger.info(String.format("Native Integrations '%s'", options.getIntegrations().toString()));
             }
         );

example/ionic-angular-v6/src/app/app.module.ts

@@ -44,6 +44,12 @@ Sentry.init(
     // If the entire session is not sampled, use the below sample rate to sample
     // sessions when an error occurs.
     replaysOnErrorSampleRate: 1.0,
+    _experiments: {
+      enableLogs: true,
+      beforeSendLog: (log) => {
+        return log;
+      }
+    },
   },
   sentryAngularInit,
 );

example/ionic-angular-v6/src/app/tab2/tab2.page.html

@@ -40,6 +40,13 @@
       >
     </label>
 
+    <label>
+      Capture Log
+      <ion-button (click)="captureLog()"
+        >CaptureLog</ion-button
+      >
+    </label>
+
     <label>
       Close the SDK
       <ion-button (click)="close()"

example/ionic-angular-v6/src/app/tab2/tab2.page.ts

@@ -38,6 +38,16 @@ export class Tab2Page {
     );
   }
 
+  public captureLog(): void {
+    Sentry.logger.info('hello world capacitor');
+    Sentry.logger.warn('hello world capacitor');
+    Sentry.logger.error('hello world capacitor');
+    Sentry.logger.fatal('hello world capacitor', {
+      customAttribute: 1234,
+      complexAttribute: { logged: true}
+    });
+  }
+
   public close(): void {
     Sentry.close();
   }

example/ionic-angular-v7/src/app/app.module.ts

@@ -29,6 +29,12 @@ Sentry.init(
         blockAllMedia: true,
       }),
     ],
+    _experiments: {
+      enableLogs: true,
+      beforeSendLog: (log) => {
+        return log;
+      }
+    },
     // A release identifier
     release: '1.0.0',
     // A dist identifier

example/ionic-angular-v7/src/app/tab2/tab2.page.html

@@ -40,6 +40,13 @@
       >
     </label>
 
+    <label>
+      Capture Log
+      <ion-button (click)="captureLog()"
+        >CaptureLog</ion-button
+      >
+    </label>
+
     <label>
       Close the SDK
       <ion-button (click)="close()"

example/ionic-angular-v7/src/app/tab2/tab2.page.ts

@@ -38,6 +38,16 @@ export class Tab2Page {
     );
   }
 
+  public captureLog(): void {
+    Sentry.logger.info('hello world capacitor');
+    Sentry.logger.warn('hello world capacitor');
+    Sentry.logger.error('hello world capacitor');
+    Sentry.logger.fatal('hello world capacitor', {
+      customAttribute: 1234,
+      complexAttribute: { logged: true}
+    });
+  }
+
   public close(): void {
     Sentry.close();
   }

example/ionic-vue3/src/main.ts

@@ -52,6 +52,13 @@ Sentry.init({
   // Session Replay
   replaysSessionSampleRate: 0.1, // This sets the sample rate at 10%. You may want to change it to 100% while in development and then sample at a lower rate in production.
   replaysOnErrorSampleRate: 1.0, // If you're not already sampling the entire session, change the sample rate to 100% when sampling sessions where errors occur.
+  _experiments: {
+    enableLogs: true,
+    beforeSendLog: (log) => {
+      return log;
+    }
+  },
+
 },
   // Forward the init method from @sentry/vue
   SentryVue.init

src/index.ts

@@ -48,7 +48,7 @@ export {
   startIdleSpan,
 } from '@sentry/core';
 
-export { replayIntegration, browserTracingIntegration, registerSpanErrorInstrumentation } from '@sentry/browser';
+export { replayIntegration, browserTracingIntegration, registerSpanErrorInstrumentation, logger } from '@sentry/browser';
 
 export { SDK_NAME, SDK_VERSION } from './version';
 export type { CapacitorOptions } from './options';