feat: fix default protocol for kyma (#294)

closes #272

Author: sjvans

CHANGELOG.md

@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 ### Added
 
 - Skip instrumentation of HANA driver, if it does it itself
+- `telemetry-to-otlp`: Automatically switch to `gRPC` (from default `http/protobuf`) when exporting to an endpoint with port `4317`
 
 ### Changed
 

lib/logging/index.js

@@ -20,13 +20,15 @@ function _getExporter() {
 
   // for kind telemetry-to-otlp based on env vars
   if (loggingExporter === 'env') {
-    const otlp_env = getEnvWithoutDefaults()
-    const dflt_env = getEnv()
-    const protocol =
-      otlp_env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL ??
-      otlp_env.OTEL_EXPORTER_OTLP_PROTOCOL ??
-      dflt_env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL ??
-      dflt_env.OTEL_EXPORTER_OTLP_PROTOCOL
+    const cstm_env = getEnvWithoutDefaults()
+    const otlp_env = getEnv()
+    let protocol = cstm_env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL ?? cstm_env.OTEL_EXPORTER_OTLP_PROTOCOL
+    // on kyma, the otlp endpoint speaks grpc, but otel's default protocol is http/protobuf -> fix default
+    if (!protocol) {
+      const endpoint = otlp_env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT ?? otlp_env.OTEL_EXPORTER_OTLP_ENDPOINT ?? ''
+      if (endpoint.match(/:4317/)) protocol = 'grpc'
+    }
+    protocol ??= otlp_env.OTEL_EXPORTER_OTLP_LOGS_PROTOCOL ?? otlp_env.OTEL_EXPORTER_OTLP_PROTOCOL
     loggingExporter = { module: _protocol2module[protocol], class: 'OTLPLogExporter' }
   }
 
@@ -100,7 +102,7 @@ module.exports = resource => {
 
     // intercept logs via format
     const { format: _format } = cds.log
-    const format = cds.log.format = function (module, level, ...args) {
+    const format = (cds.log.format = function (module, level, ...args) {
       const res = _format.call(this, module, level, ...args)
 
       let log
@@ -131,7 +133,7 @@ module.exports = resource => {
       }
 
       return res
-    }
+    })
 
     // replace format function of existing loggers
     for (const each in cds.log.loggers) cds.log.loggers[each].setFormat(format)

lib/metrics/index.js

@@ -29,13 +29,15 @@ function _getExporter() {
 
   // for kind telemetry-to-otlp based on env vars
   if (metricsExporter === 'env') {
-    const otlp_env = getEnvWithoutDefaults()
-    const dflt_env = getEnv()
-    const protocol =
-      otlp_env.OTEL_EXPORTER_OTLP_METRICS_PROTOCOL ??
-      otlp_env.OTEL_EXPORTER_OTLP_PROTOCOL ??
-      dflt_env.OTEL_EXPORTER_OTLP_METRICS_PROTOCOL ??
-      dflt_env.OTEL_EXPORTER_OTLP_PROTOCOL
+    const cstm_env = getEnvWithoutDefaults()
+    const otlp_env = getEnv()
+    let protocol = cstm_env.OTEL_EXPORTER_OTLP_METRICS_PROTOCOL ?? cstm_env.OTEL_EXPORTER_OTLP_PROTOCOL
+    // on kyma, the otlp endpoint speaks grpc, but otel's default protocol is http/protobuf -> fix default
+    if (!protocol) {
+      const endpoint = otlp_env.OTEL_EXPORTER_OTLP_METRICS_ENDPOINT ?? otlp_env.OTEL_EXPORTER_OTLP_ENDPOINT ?? ''
+      if (endpoint.match(/:4317/)) protocol = 'grpc'
+    }
+    protocol ??= otlp_env.OTEL_EXPORTER_OTLP_METRICS_PROTOCOL ?? otlp_env.OTEL_EXPORTER_OTLP_PROTOCOL
     metricsExporter = { module: _protocol2module[protocol], class: 'OTLPMetricExporter' }
   }
 

lib/tracing/index.js

@@ -85,13 +85,15 @@ function _getExporter() {
 
   // for kind telemetry-to-otlp based on env vars
   if (tracingExporter === 'env') {
-    const otlp_env = getEnvWithoutDefaults()
-    const dflt_env = getEnv()
-    const protocol =
-      otlp_env.OTEL_EXPORTER_OTLP_TRACES_PROTOCOL ??
-      otlp_env.OTEL_EXPORTER_OTLP_PROTOCOL ??
-      dflt_env.OTEL_EXPORTER_OTLP_TRACES_PROTOCOL ??
-      dflt_env.OTEL_EXPORTER_OTLP_PROTOCOL
+    const cstm_env = getEnvWithoutDefaults()
+    const otlp_env = getEnv()
+    let protocol = cstm_env.OTEL_EXPORTER_OTLP_TRACES_PROTOCOL ?? cstm_env.OTEL_EXPORTER_OTLP_PROTOCOL
+    // on kyma, the otlp endpoint speaks grpc, but otel's default protocol is http/protobuf -> fix default
+    if (!protocol) {
+      const endpoint = otlp_env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT ?? otlp_env.OTEL_EXPORTER_OTLP_ENDPOINT ?? ''
+      if (endpoint.match(/:4317/)) protocol = 'grpc'
+    }
+    protocol ??= otlp_env.OTEL_EXPORTER_OTLP_TRACES_PROTOCOL ?? otlp_env.OTEL_EXPORTER_OTLP_PROTOCOL
     tracingExporter = { module: _protocol2module[protocol], class: 'OTLPTraceExporter' }
   }