Merge pull request #7 from traceo-dev/feat/otel

Feat/otel

Author: piotr-szewczyk

README.md

@@ -6,6 +6,7 @@ A set of SDKS for integration with the [Traceo Platform](https://github.com/trac
 This repository contains all the SDKs needed for integration in Javascript/Typescript projects. Detailed instructions for the SDK implementation process can be found in the individual README for each SDK.
 
 - [`@traceo-sdk/node`](https://github.com/traceo-dev/traceo-sdk/tree/develop/packages/node) - NodeJS.
+- [`@traceo-sdk/opentelemetry-node`](https://github.com/traceo-dev/traceo-sdk/tree/develop/packages/opentelemetry-node) - Open Telemetry for Node.
 - [`@traceo-sdk/react`](https://github.com/traceo-dev/traceo-sdk/tree/develop/packages/react) - React.
 - [`@traceo-sdk/vue`](https://github.com/traceo-dev/traceo-sdk/tree/develop/packages/vue) - Vue.
 

lerna.json

@@ -1,6 +1,6 @@
 {
     "$schema": "node_modules/lerna/schemas/lerna-schema.json",
-    "version": "0.31.8",
+    "version": "0.33.0",
     "npmClient": "yarn",
     "useWorkspaces": true
 }

packages/browser/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@traceo-sdk/browser",
-    "version": "0.32.1",
+    "version": "0.33.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "license": "MIT",

packages/node-core/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@traceo-sdk/node-core",
-    "version": "0.32.2",
+    "version": "0.33.0",
     "author": "Traceo",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

packages/node/README.md

@@ -17,13 +17,12 @@ First what you need is to initialize `TraceoClient` in your application.
 ```ts
 import { TraceoClient } from "@traceo-sdk/node";
 
-new TraceoClient({
-    projectId: <your_project_id>,
-    url: <you_traceo_instance_url>
+new TraceoClient(<project_api_key>, {
+    host: <traceo_host>
 });
 ```
 
-`TraceoClient` options require two parameters. `projectId` is a unique identifier of an application created on the Traceo platform. Information about application ID you can get from the Traceo Platform in `Settings|Details` tab.  `url` parameter specifies the address where your Traceo Platform instance is located. Address should be passed in the format `<protocol>://<domain>:<port>`, eq. `http://localhost:3000`.
+`TraceoClient` constructor required two attribtues. First one in api key which you can generate in project settings. Second is an object contains required attribute `host` which specifies the address where your Traceo Platform instance is located. Address should be passed in the format `<protocol>://<domain>:<port>`, eq. `http://localhost:3000`.
 
 ### Incidents handling
 Incidents are all the exceptions and other problems that occur in your application. After each exception occurs, the Traceo SDK catches the exception and sends it to the Traceo Platform. This package provide the two main ways to catch exceptions in your application - `Handlers` and `Middlewares`.
@@ -96,7 +95,8 @@ The Traceo SDK can be used also as a logger. Each log is saved on the Traceo Pla
 ```ts
 import { TraceoClient } from "@traceo-sdk/node";
 
-new TraceoClient({
+new TraceoClient(<project_api_key>, {
+    host: <traceo_host>,
     scrapLogsInterval: 120 //in seconds
 });
 ```

packages/node/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@traceo-sdk/node",
-    "version": "0.32.2",
+    "version": "0.33.0",
     "author": "Traceo",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
     },
     "dependencies": {
         "stacktrace-parser-node": "^1.1.3",
-        "@traceo-sdk/node-core": "0.32.2",
+        "@traceo-sdk/node-core": "0.33.0",
         "os": "^0.1.2"
     },
     "devDependencies": {

packages/opentelemetry-node/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@traceo-sdk/opentelemetry-node",
-    "version": "0.32.2",
+    "version": "0.33.0",
     "author": "Traceo",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -28,7 +28,7 @@
         "@opentelemetry/api-logs": "^0.39.1",
         "@opentelemetry/exporter-metrics-otlp-http": "^0.38.0",
         "@opentelemetry/exporter-trace-otlp-http": "^0.39.1",
-        "@traceo-sdk/node-core": "0.32.2",
+        "@traceo-sdk/node-core": "0.33.0",
         "os": "^0.1.2",
         "stacktrace-parser-node": "^1.1.3"
     },

packages/react/README.md

@@ -17,7 +17,7 @@ To use this SDK initialize `TraceoClient` in your application.
 ```ts
 import { TraceoClient } from "@traceo-sdk/react";
 
-new TraceoClient(<app_api_key>, {
+new TraceoClient(<project_api_key>, {
     host: <traceo_host>
 });
 
@@ -33,10 +33,8 @@ If you are using React in version >16 you can use `ErrorBoundary` component impo
 
 ```ts
 
-const traceoInstance = new TraceoClient({
-    projectId: <your_application_id>,
-    apiKey: <app_api_key>,
-    url: <you_traceo_instance_url>
+const traceoInstance = new TraceoClient(<project_api_key>, {
+    host: <traceo_host>
 });
 
 
@@ -50,7 +48,7 @@ const traceoInstance = new TraceoClient({
 To enable collect of web-vitals data, you have to set `performance` param to `true` like below:
 
 ```ts
-new TraceoClient(<app_api_key>, {
+new TraceoClient(<project_api_key>, {
     host: <traceo_host>,
     performance: true
 });

packages/react/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@traceo-sdk/react",
-    "version": "0.32.1",
+    "version": "0.33.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "license": "MIT",
@@ -23,7 +23,7 @@
         "test:watch": "jest --watch --notify"
     },
     "dependencies": {
-        "@traceo-sdk/browser": "0.32.1"
+        "@traceo-sdk/browser": "0.33.0"
     },
     "peerDependencies": {
         "react": ">= 16.8.6 < 19"

packages/vue/README.md

@@ -19,7 +19,7 @@ import { TraceoClient } from "@traceo-sdk/vue";
 
 const app = createApp({ ... });
 
-new TraceoClient(<app_api_key>, {
+new TraceoClient(<project_api_key>, {
     host: <traceo_host>
 });
 
@@ -31,7 +31,7 @@ app.mount("#app");
 ### Performance
 To enable collect of web-vitals data, you have to set performance param to true like below:
 ```ts
-new TraceoClient(<app_api_key>, {
+new TraceoClient(<project_api_key>, {
     host: <traceo_host>,
     performance: true
 });