Node: add open telemetry client config

Signed-off-by: Adar Ovadia <[email protected]>

Author: Adar Ovadia

node/src/BaseClient.ts

@@ -666,17 +666,17 @@ export interface BaseClientConfiguration {
  *
  * ### OpenTelemetry
  *
- * - **openTelemetryConfigs**: Use the `openTelemetryConfigs` property to specify the endpoint of the collector to export the measurments.
+ * - **openTelemetryConfig**: Use the `openTelemetryConfig` property to specify the endpoint of the collector to export the measurments.
  *   - **Collector EndPoint**: Set `collectorEndPoint` to specify the endpoint of the collector to export the measurments.
- *   - **Span Flush Interval**: Set `spanFlushInterval` to specify the duration in milliseconds the data will be exported to the collector. If interval is not specified, 500 will be used.
- * 
+ *   - **Span Flush Interval Ms**: Set `spanFlushIntervalMs` to specify the duration in milliseconds the data will be exported to the collector. If interval is not specified, 500 will be used.
+ *
  * @example
  * ```typescript
  * const config: AdvancedBaseClientConfiguration = {
  *   connectionTimeout: 5000, // 5 seconds
  *   openTelemetryConfig: {
  *      collectorEndPoint: 'https://127.0.0.1',
- *      spanFlushInterval: 500,
+ *      spanFlushIntervalMs: 500,
  *   },
  * };
  * ```
@@ -693,13 +693,16 @@ export interface AdvancedBaseClientConfiguration {
      * Configartion for OpenTelemetry if exits.
      */
     openTelemetryConfig?: {
+        /**
+         * The client collector address to export the measurments.
+         */
         collectorEndPoint: string;
         /**
          * The duration in milliseconds the data will exported to the collector.
          * If interval is not specified, 500 will be used.
          */
-        spanFlushInterval?: number;
-    }
+        spanFlushIntervalMs?: number;
+    };
 }
 
 /**

node/tests/GlideClient.test.ts

@@ -1069,14 +1069,42 @@ describe("GlideClient", () => {
     );
 
     it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
-            "opentelemetry configs_%p",
-            async (protocol) => {
-                const client = GlideClient.createClient({
-                                ...getClientConfigurationOption(cluster.getAddresses(), protocol), advancedConfiguration:{openTelemetryConfig: {collectorEndPoint: "https://eifrah-aws.github.io/glide-for-redis", spanFlushInterval: 400}}},
-                                // htttttps://eifrah-aws.github.io/glide-for-redis
-                            )
-            },
-        );
+        "opentelemetry config_%p",
+        async (protocol) => {
+            GlideClient.createClient({
+                ...getClientConfigurationOption(
+                    cluster.getAddresses(),
+                    protocol,
+                ),
+                advancedConfiguration: {
+                    openTelemetryConfig: {
+                        collectorEndPoint: "https://valid-endpoint",
+                        spanFlushIntervalMs: 400,
+                    },
+                },
+            });
+        },
+    );
+
+    it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
+        "opentelemetry config wrong parameter_%p",
+        async (protocol) => {
+            await expect(
+                GlideClient.createClient({
+                    ...getClientConfigurationOption(
+                        cluster.getAddresses(),
+                        protocol,
+                    ),
+                    advancedConfiguration: {
+                        openTelemetryConfig: {
+                            collectorEndPoint: "wrong.endpoint",
+                            spanFlushIntervalMs: 400,
+                        },
+                    },
+                }),
+            ).rejects.toThrowError(/InvalidInput/i); // Ensure InvalidInput error
+        },
+    );
 
     it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
         "function kill RW func %p",

node/tests/GlideClusterClient.test.ts

@@ -689,12 +689,39 @@ describe("GlideClusterClient", () => {
     );
 
     it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
-        "opentelemetry configs_%p",
+        "opentelemetry config_%p",
         async (protocol) => {
-            const client = GlideClusterClient.createClient({
-                ...getClientConfigurationOption(cluster.getAddresses(), protocol), advancedConfiguration:{openTelemetryConfig: {collectorEndPoint: "https://eifrah-aws.github.io/glide-for-redis"}}},
-                // htttttps://eifrah-aws.github.io/glide-for-redis
-            )
+            GlideClusterClient.createClient({
+                ...getClientConfigurationOption(
+                    cluster.getAddresses(),
+                    protocol,
+                ),
+                advancedConfiguration: {
+                    openTelemetryConfig: {
+                        collectorEndPoint: "https://valid-endpoint",
+                    },
+                },
+            });
+        },
+    );
+
+    it.each([ProtocolVersion.RESP2, ProtocolVersion.RESP3])(
+        "opentelemetry config wrong parameter_%p",
+        async (protocol) => {
+            await expect(
+                GlideClusterClient.createClient({
+                    ...getClientConfigurationOption(
+                        cluster.getAddresses(),
+                        protocol,
+                    ),
+                    advancedConfiguration: {
+                        openTelemetryConfig: {
+                            collectorEndPoint: "wrong.endpoint",
+                            spanFlushIntervalMs: 400,
+                        },
+                    },
+                }),
+            ).rejects.toThrowError(/InvalidInput/i); // Ensure InvalidInput error
         },
     );