@echoteam/signoz-react 1.0.5 → 1.0.6

package/README.md

@@ -11,6 +11,13 @@ Library React untuk monitoring dan tracing aplikasi menggunakan OpenTelemetry da
 - **Zero Configuration**: Mudah digunakan dengan environment variables
 - **Customizable**: ErrorPage dan ErrorBoundary dapat dikustomisasi sesuai kebutuhan
 
+## 📚 Dokumentasi
+
+- [Konfigurasi CORS Backend](./BACKEND_CORS_SETUP.md) - Panduan lengkap setup CORS di berbagai framework backend
+- [Troubleshooting](./TROUBLESHOOTING.md) - Solusi untuk masalah umum
+- [OpenTelemetry Documentation](https://opentelemetry.io/docs/)
+- [React Error Boundary](https://reactjs.org/docs/error-boundaries.html)
+
 ## 📦 Instalasi
 
 ```bash
@@ -31,8 +38,15 @@ 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
+REACT_APP_SIGNOZ_ALLOWED_ORIGINS=https://api1.example.com,https://api2.example.com,/^https:\/\/.*\.your-domain\.com$/
 ```
 
+> **Catatan untuk REACT_APP_SIGNOZ_ALLOWED_ORIGINS:**
+> - Daftar URL yang diizinkan untuk CORS, dipisahkan dengan koma
+> - Untuk RegExp pattern, gunakan format `/pattern/` (contoh: `/^https:\/\/.*\.example\.com$/`)
+> - Jika tidak diisi, default ke semua origin (`/.+/g`)
+> - Spasi di sekitar koma akan dihapus otomatis
+
 ### Inisialisasi
 
 ```typescript
@@ -42,16 +56,35 @@ import { initializeSignOzTracing } from '@echoteam/signoz-react';
 initializeSignOzTracing();
 
 // Atau dengan konfigurasi manual
+// Inisialisasi dengan konfigurasi minimal
 initializeSignOzTracing({
-  serviceName: 'my-react-app',
+  serviceName: 'my-app',
   serviceVersion: '1.0.0',
   environment: 'production',
-  serviceNamespace: 'frontend',
-  url: 'https://your-signoz-instance.com/v1/traces',
+  serviceNamespace: 'default',
+  url: 'https://api.signoz.io/v1/traces'
+});
+
+// Inisialisasi dengan konfigurasi lengkap
+initializeSignOzTracing({
+  serviceName: 'my-app',
+  serviceVersion: '1.0.0',
+  environment: 'production',
+  serviceNamespace: 'default',
+  url: 'https://api.signoz.io/v1/traces',
   headers: {
-    'Authorization': 'Bearer your-token'
+    'X-API-Key': 'your-api-key'
   },
-  traceSampleRate: 0.5 // Sampling 50% trace
+  traceSampleRate: 0.5, // Sampling 50% trace
+  batchSpanProcessorConfig: {
+    maxQueueSize: 100,
+    scheduledDelayMillis: 5000,
+    exportTimeoutMillis: 30000
+  },
+  allowedOrigins: [
+    'https://api.example.com',
+    /^https:\/\/.*\.your-domain\.com$/
+  ]
 });
 ```
 
@@ -200,9 +233,13 @@ Inisialisasi SignOz tracing untuk aplikasi React.
   - `environment`: Environment (production, staging, development)
   - `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`
+  - `headers` (opsional): Header tambahan untuk request
+  - `traceSampleRate` (opsional): Rate sampling trace (0-1, default: 1.0)
+  - `batchSpanProcessorConfig` (opsional): Konfigurasi batch processor
+    - `maxQueueSize`: Ukuran maksimum antrian span
+    - `scheduledDelayMillis`: Delay pengiriman batch dalam milidetik
+    - `exportTimeoutMillis`: Timeout ekspor dalam milidetik
+  - `allowedOrigins` (opsional): Array URL/RegExp yang diizinkan untuk CORS
 
 ### `ErrorBoundary`
 
@@ -313,5 +350,4 @@ MIT License - lihat file [LICENSE](LICENSE) untuk detail.
 
 - [SignOz Documentation](https://signoz.io/docs/)
 - [OpenTelemetry Documentation](https://opentelemetry.io/docs/)
-- [React Error Boundary](https://reactjs.org/docs/error-boundaries.html)
-
+- [React Error Boundary](https://reactjs.org/docs/error-boundaries.html)

package/dist/index.d.ts

@@ -7,6 +7,12 @@ interface SignOzConfig {
     url: string;
     headers?: Record<string, string>;
     traceSampleRate?: number;
+    batchSpanProcessorConfig?: {
+        maxQueueSize?: number;
+        scheduledDelayMillis?: number;
+        exportTimeoutMillis?: number;
+    };
+    allowedOrigins?: (string | RegExp)[];
 }
 declare global {
     interface Window {
@@ -16,12 +22,12 @@ declare global {
         REACT_APP_SIGNOZ_SERVICE_NAMESPACE: string;
         REACT_APP_SIGNOZ_URL: string;
         REACT_APP_SIGNOZ_TRACE_SAMPLE_RATE: string;
+        REACT_APP_SIGNOZ_ALLOWED_ORIGINS: 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;