@coralogix/react-native-plugin 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+## 0.1.0 (2025-08-27)
+
+### 🚀 Features
+- Error instrumentation with customizable filtering
+- Network request monitoring (Fetch)
+- Mobile vitals tracking (JS refresh rate, performance metrics)
+- Session sampling and tracking
+- Trace context propagation
+
+
+### 🆕 Added
+- Initial release of the official Coralogix React Native Plugin
+- Core SDK initialization and configuration
+- User, application, and view context management
+- Manual logging with multiple severity levels
+- Custom measurements and metrics reporting
+- Error reporting and crash detection

package/CxSdk.podspec

@@ -0,0 +1,45 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
+
+Pod::Spec.new do |s|
+  s.name         = "CxSdk"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => min_ios_version_supported }
+  s.source       = { :git => "https://github.com/coralogix/cx-react-native-plugin.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm,swift}"
+
+  s.dependency 'Coralogix','1.2.2'
+  s.dependency 'CoralogixInternal','1.2.2'
+
+
+  # Use install_modules_dependencies helper to install the dependencies if React Native version >=0.71.0.
+  # See https://github.com/facebook/react-native/blob/febf6b7f33fdb4904669f99d795eba4c0f95d7bf/scripts/cocoapods/new_architecture.rb#L79.
+  if respond_to?(:install_modules_dependencies, true)
+    install_modules_dependencies(s)
+  else
+    s.dependency "React-Core"
+
+    # Don't install the dependencies when we run `pod install` in the old architecture.
+    if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then
+      s.compiler_flags = folly_compiler_flags + " -DRCT_NEW_ARCH_ENABLED=1"
+      s.pod_target_xcconfig    = {
+          "HEADER_SEARCH_PATHS" => "\"$(PODS_ROOT)/boost\"",
+          "OTHER_CPLUSPLUSFLAGS" => "-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1",
+          "CLANG_CXX_LANGUAGE_STANDARD" => "c++17"
+      }
+      s.dependency "React-Codegen"
+      s.dependency "RCT-Folly"
+      s.dependency "RCTRequired"
+      s.dependency "RCTTypeSafety"
+      s.dependency "ReactCommon/turbomodule/core"
+    end
+  end
+end

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,187 @@
+# Official Coralogix React Native Plugin
+
+[![npm version](https://img.shields.io/npm/v/@coralogix/react-native-plugin.svg)](https://www.npmjs.com/package/@coralogix/react-native-plugin)
+
+This package replaces the old `@coralogix/react-native-sdk` package.
+
+## Links
+- [Changelog](https://coralogix.github.io/cx-react-native-plugin/CHANGELOG.html)
+- [Coralogix Real User Monitoring](https://coralogix.com/docs/real-user-monitoring/)
+
+## Usage
+
+To use Coralogix SDK, call `CoralogixRum.init(options)` at the soonest available moment after the app loads.
+This will initialize the SDK based on the options you provided.
+
+```javascript
+import { CoralogixRum } from '@coralogix/react-native-plugin'
+
+CoralogixRum.init({
+  application: 'app-name',
+  environment: 'production',
+  public_key: 'abc-123-456',
+  coralogixDomain: 'EU2',
+  version: 'v1.0.3',
+  labels: {
+    payment: 'visa',
+  },
+  ignoreErrors: ['some error message to ignore'],
+  ignoreUrls: [/.*\.svg/, /.*\.ico/], // will ignore all requests to .svg and .ico files 
+  sessionSampleRate: 100, // Percentage of overall sessions being tracked, Default to 100%
+});
+```
+
+To provide contextual information or transmit manual logs, utilize the exported functions of `CoralogixRum`.
+Keep in mind that these functions will remain inactive until you've invoked `CoralogixRum.init()`.
+
+```javascript
+import { CoralogixRum } from '@coralogix/react-native-plugin';
+
+// Update user context dynamically
+CoralogixRum.setUserContext({
+  user_id: '123',
+  user_name: 'name',
+  user_email: 'user@email.com',
+  user_metadata: {
+    role: 'admin',
+    // ...
+  },
+});
+
+// Update custom labels dynamically
+CoralogixRum.setLabels({
+  ...CoralogixRum.getLabels(),
+  paymentMethod: 'visa',
+  userTheme: 'dark',
+  // ...
+});
+
+// Update application context dynamically
+CoralogixRum.setApplicationContext({
+  application: 'app-name',
+  version: '1.0.0',
+});
+
+CoralogixRum.log(CoralogixLogSeverity.Error, 'this is a log', { key: 'value' });
+CoralogixRum.error('this is a log with error severity', { key: 'value' });
+```
+
+### View Tracking
+
+To track views, set the view context whenever a view changes.
+
+```javascript
+CoralogixRum.setViewContext({
+  view: 'Home',
+});
+```
+
+You can automatically track view changes by using [react-navigation](https://reactnavigation.org/docs/navigation-container/#onstatechange).
+
+```javascript
+<NavigationContainer
+  ref={navigationRef}
+  onStateChange={() => {
+    const currentRouteName = navigationRef.current.getCurrentRoute().name;
+
+    CoralogixRum.setViewContext({ view: currentRouteName });
+  }}
+>
+  >{/* ... */}
+</NavigationContainer>
+```
+
+### Instrumentation's
+
+Turn on/off specific instrumentation; defaults to true for all.
+Each instrumentation is responsible for which data the SDK will track and collect for you.
+
+```javascript
+CoralogixRum.init({
+  // ...
+  instrumentations: {
+    errors: true,
+    custom: true,
+    mobile_vitals: true,
+    anr: true,
+    lifecycle: true,
+    user_interaction: true,
+    network: true
+  },
+});
+```
+
+### Ignore Errors
+
+The ignoreErrors option allows you to exclude errors that meet specific criteria.
+This options accepts a set of strings and regular expressions to match against the event's error message.
+Use regular expressions for exact matching as strings remove partial matches.
+
+```javascript
+import { CoralogixRum } from '@coralogix/react-native-plugin';
+
+CoralogixRum.init({
+  // ...
+  ignoreErrors: [/Exact Match Error Message/, 'partial/match'],
+});
+```
+
+### TraceParentInHeader
+
+Add trace context propagation in headers across service boundaries
+
+```javascript
+CoralogixRum.init({
+  // ...
+  traceParentInHeader: {
+    enabled: true
+  },
+});
+```
+
+### beforeSend
+
+Enable event access and modification before sending to Coralogix, supporting content modification, and event discarding.
+
+```javascript
+CoralogixRum.init({
+  // ...
+  beforeSend: (event) => {
+    // Discard events from @company.com users.
+    if (event.session_context.user_email?.endsWith('@company.com')) {
+      return null;
+    }
+
+    // Redact sensitive information.
+    event.session_context.user_email = '***@***';
+
+    return event;
+  },
+});
+```
+
+### Proxy URL
+
+Proxy configuration to route requests.  
+By specifying a proxy URL, all RUM data will be directed to this URL via the POST method.
+However, it is necessary for this data to be subsequently relayed from the proxy to Coralogix.
+The Coralogix route for each request that is sent to the proxy is available in the request’s cxforward parameter
+(for example, https://www.your-proxy.com/endpoint?cxforward=https%3A%2F%2Fingress.eu1.rum-ingress-coralogix.com%2Fbrowser%2Fv1beta%2Flogs).
+
+```javascript
+CoralogixRum.init({
+  // ...
+  coralogixDomain: 'EU1',
+  proxyUrl: 'https://www.your-proxy.com/endpoint',
+});
+```
+
+### Troubleshooting
+
+#### URL.origin is not implemented
+
+1. `npm install react-native-url-polyfill`
+2. At the top of your entry-point file (index.js) add:
+   `import "react-native-url-polyfill/auto"`
+
+---

package/android/build.gradle

@@ -0,0 +1,87 @@
+buildscript {
+  ext.getExtOrDefault = {name ->
+    return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['CxSdk_' + name]
+  }
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:8.7.2"
+    // noinspection DifferentKotlinGradleVersion
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('kotlinVersion')}"
+  }
+}
+
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+
+apply plugin: "com.facebook.react"
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["CxSdk_" + name]).toInteger()
+}
+
+android {
+  namespace "com.cxsdk"
+
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+
+  defaultConfig {
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+  }
+
+  buildFeatures {
+    buildConfig true
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+
+  lintOptions {
+    disable "GradleCompatible"
+  }
+
+  compileOptions {
+    setCoreLibraryDesugaringEnabled(true)
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
+  sourceSets {
+    main {
+      java.srcDirs += [
+        "generated/java",
+        "generated/jni"
+      ]
+    }
+  }
+}
+
+repositories {
+  mavenCentral()
+  google()
+}
+
+def kotlin_version = getExtOrDefault("kotlinVersion")
+
+dependencies {
+  implementation "com.facebook.react:react-android"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+
+  implementation "com.coralogix:android-sdk:2.4.52"
+  coreLibraryDesugaring "com.android.tools:desugar_jdk_libs:2.1.5"
+}
+
+react {
+  jsRootDir = file("../src/")
+  libraryName = "CxSdk"
+  codegenJavaPackageName = "com.cxsdk"
+}

package/android/gradle.properties

@@ -0,0 +1,5 @@
+CxSdk_kotlinVersion=2.0.21
+CxSdk_minSdkVersion=24
+CxSdk_targetSdkVersion=34
+CxSdk_compileSdkVersion=35
+CxSdk_ndkVersion=27.1.12297006

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>