go.temporal.io/server/common/telemetry/env.go

79 LOC · 30 covered · 49 uncovered · 12 ranges · 74 concepts · 10 introducers · 19 tests

File neighbourhood

The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.

Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file

In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.

  1
  
  package telemetry
  
  2
  
  3
  
  import (
  
  4
  
  	"errors"
  
  5
  
  	"fmt"
  
  6
  
  	"strings"
  
  7
  
  8
  
  	"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
  
  9
  
  	otelsdktrace "go.opentelemetry.io/otel/sdk/trace"
  
  10
  
  	"go.temporal.io/server/common/primitives"
  
  11
  
  )
  
  12
  
  13
  
  var (
  
  14
  
  	unsupportedTraceExporter         = errors.New("unsupported OTEL exporter")
  
  15
  
  	unsupportedTraceExporterProtocol = errors.New("unsupported OTEL exporter protocol")
  
  16
  
  )
  
  17
  
  18
  
  const (
  
  19
  
  	OtelServiceNameEnvKey                = "OTEL_SERVICE_NAME"
  
  20
  
  	OtelTracesExporterTypesEnvKey        = "OTEL_TRACES_EXPORTER"
  
  21
  
  	OtelTracesOtlpExporterType           = SpanExporterType("otlp")
  
  22
  
  	OtelExporterOtlpTracesProtocolEnvKey = "OTEL_EXPORTER_OTLP_TRACES_PROTOCOL"
  
  23
  
  	OtelExporterOtlpTracesGrcpProtocol   = "grpc"
  
  24
  
  )
  
  25
  
  26
  
  type envVarLookup = func(string) (string, bool)
  
  27
  
  28
  
  // SpanExportersFromEnv creates OTEL span exporters from environment variables.
  
  29
  
  func SpanExportersFromEnv(
  
  30
  
  	envVars envVarLookup,
  
  31
  >
  ) (map[SpanExporterType]otelsdktrace.SpanExporter, error) {
  
env.go ×1

  32
  >
  	exporters := map[SpanExporterType]otelsdktrace.SpanExporter{}
  
  33
  >
  
  34
  >
  	exporterTypes, ok := envVars(OtelTracesExporterTypesEnvKey)
  
  35
  >
  	if !ok {
  
  36
  >
  		return exporters, nil
  
env.go ×1

  37
  >
  	}
  
  38
  
  39
  >
  	for exporterType := range strings.SplitSeq(exporterTypes, ",") {
  
env.go ×1

  40
  >
  		switch SpanExporterType(exporterType) {
  
  41
  >
  		case OtelTracesOtlpExporterType:
  
  42
  >
  			// only grpc is supported; fail if user requests a different protocol
  
  43
  >
  			if protocol, exists := envVars(OtelExporterOtlpTracesProtocolEnvKey); exists {
  
  44
  >
  				isSupported := protocol == OtelExporterOtlpTracesGrcpProtocol
  
env.go ×1

  45
  >
  				if !isSupported {
  
  46
  >
  					return nil, fmt.Errorf("%w: %v=%v", unsupportedTraceExporterProtocol, OtelExporterOtlpTracesProtocolEnvKey, protocol)
  
  47
  >
  				}
  
  48
  
  			}
  
  49
  
  50
  
  			// other OTEL configuration env variables are picked up automatically by the exporter itself
  
  51
  >
  			exporters[OtelTracesOtlpExporterType] = otlptracegrpc.NewUnstarted()
  
env.go ×1

  52
  
  		case "none":
  
  53
  
  			// ignored
  
  54
  >
  		default:
  
env.go ×1

  55
  >
  			return nil, fmt.Errorf("%w: %v=%v", unsupportedTraceExporter, OtelTracesExporterTypesEnvKey, exporterType)
  
  56
  
  		}
  
  57
  
  	}
  
  58
  
  59
  >
  	return exporters, nil
  
env.go ×1

  60
  
  }
  
  61
  
  62
  
  // ResourceServiceName returns the OpenTelemetry tracing service name for a Temporal service.
  
  63
  
  func ResourceServiceName(
  
  64
  
  	rsn primitives.ServiceName,
  
  65
  
  	envVars envVarLookup,
  
  66
  >
  ) string {
  
env.go ×3

  67
  >
  	// map "internal-frontend" to "frontend" for the purpose of tracing
  
  68
  >
  	if rsn == primitives.InternalFrontendService {
  
  69
  >
  		rsn = primitives.FrontendService
  
env.go ×1

  70
  >
  	}
  
  71
  
  72
  
  	// allow custom prefix via env vars
  
  73
  >
  	serviceNamePrefix := "io.temporal"
  
env.go ×3

  74
  >
  	if customServicePrefix, found := envVars(OtelServiceNameEnvKey); found {
  
  75
  >
  		serviceNamePrefix = customServicePrefix
  
env.go ×1

  76
  >
  	}
  
  77
  
  78
  >
  	return fmt.Sprintf("%s.%s", serviceNamePrefix, string(rsn))
  
env.go ×3

  79
  
  }