@echoteam/signoz-react 1.0.3 → 1.0.5

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 CODR Team
+Copyright (c) 2024 echoteam
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -30,6 +30,7 @@ REACT_APP_SIGNOZ_SERVICE_VERSION=1.0.0
 REACT_APP_SIGNOZ_ENV=production
 REACT_APP_SIGNOZ_SERVICE_NAMESPACE=frontend
 REACT_APP_SIGNOZ_URL=https://your-signoz-instance.com/v1/traces
+REACT_APP_SIGNOZ_TRACE_SAMPLE_RATE=1.0
 ```
 
 ### Inisialisasi
@@ -49,7 +50,8 @@ initializeSignOzTracing({
   url: 'https://your-signoz-instance.com/v1/traces',
   headers: {
     'Authorization': 'Bearer your-token'
-  }
+  },
+  traceSampleRate: 0.5 // Sampling 50% trace
 });
 ```
 
@@ -199,6 +201,8 @@ Inisialisasi SignOz tracing untuk aplikasi React.
   - `serviceNamespace`: Namespace layanan
   - `url`: URL endpoint SignOz
   - `headers`: Headers tambahan untuk request
+  - `traceSampleRate`: Sampling rate tracing (0.0 - 1.0, default: 1.0 jika tidak diisi)
+    - Bisa juga diatur lewat environment variable `REACT_APP_SIGNOZ_TRACE_SAMPLE_RATE`
 
 ### `ErrorBoundary`
 

package/dist/index.d.ts

@@ -6,6 +6,7 @@ interface SignOzConfig {
     serviceNamespace: string;
     url: string;
     headers?: Record<string, string>;
+    traceSampleRate?: number;
 }
 declare global {
     interface Window {
@@ -14,11 +15,13 @@ declare global {
         REACT_APP_SIGNOZ_ENV: string;
         REACT_APP_SIGNOZ_SERVICE_NAMESPACE: string;
         REACT_APP_SIGNOZ_URL: string;
+        REACT_APP_SIGNOZ_TRACE_SAMPLE_RATE: string;
     }
 }
 /**
  * Inisialisasi SignOz tracing untuk aplikasi React
  * @param config - Konfigurasi SignOz (opsional, akan menggunakan environment variables jika tidak disediakan)
+ * @throws {SignOzConfigurationError} Jika konfigurasi tidak valid
  */
 declare function initializeSignOzTracing(config?: SignOzConfig): void;
 

package/dist/index.esm.js

@@ -16045,64 +16045,149 @@ function getWebAutoInstrumentations(inputConfigs) {
     return instrumentations;
 }
 
+// Error class khusus untuk masalah konfigurasi
+class SignOzConfigurationError extends Error {
+    constructor(message, missingFields) {
+        super(message);
+        this.missingFields = missingFields;
+        this.name = 'SignOzConfigurationError';
+    }
+}
+/**
+ * Mendapatkan nilai environment variable dari process.env atau window
+ * @param key - Nama environment variable
+ * @returns Nilai environment variable atau undefined
+ */
+function getEnvVariable(key) {
+    // Cek process.env terlebih dahulu
+    if (typeof process !== 'undefined' && process.env) {
+        const value = process.env[key];
+        if (value)
+            return value;
+    }
+    // Fallback ke window jika process.env tidak tersedia atau tidak memiliki nilai
+    if (typeof window !== 'undefined') {
+        return window[key];
+    }
+    return undefined;
+}
+/**
+ * Memvalidasi konfigurasi SignOz
+ * @param config - Konfigurasi yang akan divalidasi
+ * @throws {SignOzConfigurationError} Jika konfigurasi tidak valid
+ */
+function validateConfig(config) {
+    const requiredFields = [
+        'serviceName',
+        'serviceVersion',
+        'environment',
+        'serviceNamespace',
+        'url'
+    ];
+    const missingFields = requiredFields.filter(field => !config[field]);
+    if (missingFields.length > 0) {
+        const missingFieldsStr = missingFields.join(', ');
+        throw new SignOzConfigurationError(`Konfigurasi SignOz tidak lengkap. Field yang diperlukan: ${missingFieldsStr}`, missingFields);
+    }
+    // Validasi traceSampleRate jika ada
+    if (config.traceSampleRate !== undefined) {
+        const rate = Number(config.traceSampleRate);
+        if (isNaN(rate) || rate < 0 || rate > 1) {
+            throw new SignOzConfigurationError('traceSampleRate harus berupa angka antara 0 dan 1');
+        }
+    }
+    // Validasi URL
+    try {
+        new URL(config.url);
+    }
+    catch (e) {
+        throw new SignOzConfigurationError(`URL tidak valid: ${config.url}`);
+    }
+}
 /**
  * Inisialisasi SignOz tracing untuk aplikasi React
  * @param config - Konfigurasi SignOz (opsional, akan menggunakan environment variables jika tidak disediakan)
+ * @throws {SignOzConfigurationError} Jika konfigurasi tidak valid
  */
 function initializeSignOzTracing(config) {
-    // Gunakan config yang disediakan atau fallback ke environment variables
-    const serviceName = (config === null || config === void 0 ? void 0 : config.serviceName) || window.REACT_APP_SIGNOZ_SERVICE_NAME;
-    const serviceVersion = (config === null || config === void 0 ? void 0 : config.serviceVersion) || window.REACT_APP_SIGNOZ_SERVICE_VERSION;
-    const environment = (config === null || config === void 0 ? void 0 : config.environment) || window.REACT_APP_SIGNOZ_ENV;
-    const serviceNamespace = (config === null || config === void 0 ? void 0 : config.serviceNamespace) || window.REACT_APP_SIGNOZ_SERVICE_NAMESPACE;
-    const url = (config === null || config === void 0 ? void 0 : config.url) || window.REACT_APP_SIGNOZ_URL;
-    const headers = (config === null || config === void 0 ? void 0 : config.headers) || {};
-    // Validasi konfigurasi yang diperlukan
-    if (!serviceName || !serviceVersion || !environment || !serviceNamespace || !url) {
-        console.error('SignOz: Konfigurasi tidak lengkap. Pastikan semua environment variables atau config disediakan.');
-        return;
+    try {
+        // Gabungkan config dengan environment variables
+        const effectiveConfig = {
+            serviceName: (config === null || config === void 0 ? void 0 : config.serviceName) || getEnvVariable('REACT_APP_SIGNOZ_SERVICE_NAME'),
+            serviceVersion: (config === null || config === void 0 ? void 0 : config.serviceVersion) || getEnvVariable('REACT_APP_SIGNOZ_SERVICE_VERSION'),
+            environment: (config === null || config === void 0 ? void 0 : config.environment) || getEnvVariable('REACT_APP_SIGNOZ_ENV'),
+            serviceNamespace: (config === null || config === void 0 ? void 0 : config.serviceNamespace) || getEnvVariable('REACT_APP_SIGNOZ_SERVICE_NAMESPACE'),
+            url: (config === null || config === void 0 ? void 0 : config.url) || getEnvVariable('REACT_APP_SIGNOZ_URL'),
+            headers: (config === null || config === void 0 ? void 0 : config.headers) || {},
+            traceSampleRate: (config === null || config === void 0 ? void 0 : config.traceSampleRate) !== undefined
+                ? config.traceSampleRate
+                : getEnvVariable('REACT_APP_SIGNOZ_TRACE_SAMPLE_RATE')
+                    ? parseFloat(getEnvVariable('REACT_APP_SIGNOZ_TRACE_SAMPLE_RATE'))
+                    : 1.0
+        };
+        // Validasi konfigurasi
+        validateConfig(effectiveConfig);
+        // Define resource and service attributes
+        const resource = new Resource({
+            'service.name': effectiveConfig.serviceName,
+            'service.version': effectiveConfig.serviceVersion,
+            'deployment.environment': effectiveConfig.environment,
+            'service.namespace': effectiveConfig.serviceNamespace,
+        });
+        // Set up the OTLP trace exporter
+        const exporter = new OTLPTraceExporter({
+            url: effectiveConfig.url,
+            headers: effectiveConfig.headers,
+        });
+        // Set up the span processor
+        const processor = new BatchSpanProcessor(exporter);
+        // Create and configure the WebTracerProvider
+        const provider = new WebTracerProvider({
+            resource: resource,
+            spanProcessors: [processor],
+            sampler: new ParentBasedSampler({
+                root: new TraceIdRatioBasedSampler(effectiveConfig.traceSampleRate)
+            })
+        });
+        // Register the tracer provider with the context manager
+        provider.register({
+            contextManager: new ZoneContextManager(),
+        });
+        // Set up automatic instrumentation for web APIs
+        registerInstrumentations({
+            instrumentations: [
+                getWebAutoInstrumentations({
+                    '@opentelemetry/instrumentation-xml-http-request': {
+                        propagateTraceHeaderCorsUrls: [
+                            /.+/g, // Regex to match your backend URLs
+                        ],
+                    },
+                    '@opentelemetry/instrumentation-fetch': {
+                        propagateTraceHeaderCorsUrls: [
+                            /.+/g, // Regex to match your backend URLs
+                        ],
+                    },
+                }),
+            ],
+        });
+        console.log('SignOz tracing berhasil diinisialisasi');
+    }
+    catch (error) {
+        if (error instanceof SignOzConfigurationError) {
+            console.error(`[SignOz Error] ${error.message}`);
+            if (error.missingFields) {
+                console.error('Field yang hilang:');
+                error.missingFields.forEach(field => {
+                    const envVar = `REACT_APP_SIGNOZ_${field.toUpperCase()}`;
+                    console.error(`- ${field} (Environment Variable: ${envVar})`);
+                });
+            }
+        }
+        else {
+            console.error('[SignOz Error] Terjadi kesalahan saat menginisialisasi tracing:', error);
+        }
+        throw error;
     }
-    // Define resource and service attributes
-    const resource = new Resource({
-        'service.name': serviceName,
-        'service.version': serviceVersion,
-        'deployment.environment': environment,
-        'service.namespace': serviceNamespace,
-    });
-    // Set up the OTLP trace exporter
-    const exporter = new OTLPTraceExporter({
-        url: url,
-        headers: headers,
-    });
-    // Set up the span processor
-    const processor = new BatchSpanProcessor(exporter);
-    // Create and configure the WebTracerProvider
-    const provider = new WebTracerProvider({
-        resource: resource,
-        spanProcessors: [processor],
-    });
-    // Register the tracer provider with the context manager
-    provider.register({
-        contextManager: new ZoneContextManager(),
-    });
-    // Set up automatic instrumentation for web APIs
-    registerInstrumentations({
-        instrumentations: [
-            getWebAutoInstrumentations({
-                '@opentelemetry/instrumentation-xml-http-request': {
-                    propagateTraceHeaderCorsUrls: [
-                        /.+/g, // Regex to match your backend URLs
-                    ],
-                },
-                '@opentelemetry/instrumentation-fetch': {
-                    propagateTraceHeaderCorsUrls: [
-                        /.+/g, // Regex to match your backend URLs
-                    ],
-                },
-            }),
-        ],
-    });
-    console.log('SignOz tracing berhasil diinisialisasi');
 }
 
 const ErrorBoundaryContext = createContext(null);