Add opentelementry implementation

command/run.go

@@ -8,6 +8,7 @@ import (
 	"net/http"
 	"strings"
 	"sync"
+	"time"
 
 	"github.com/sirupsen/logrus"
 
@@ -18,6 +19,7 @@ import (
 	"github.com/avenga/couper/errors"
 	"github.com/avenga/couper/server"
 	"github.com/avenga/couper/server/writer"
+	"github.com/avenga/couper/telemetry"
 )
 
 var _ Cmd = &Run{}
@@ -43,11 +45,17 @@ func NewRun(ctx context.Context) *Run {
 	set.Var(&AcceptForwardedValue{settings: &settings}, "accept-forwarded-url", "-accept-forwarded-url [proto][,host][,port]")
 	set.Var(&settings.TLSDevProxy, "https-dev-proxy", "-https-dev-proxy 8443:8080,9443:9000")
 	set.BoolVar(&settings.NoProxyFromEnv, "no-proxy-from-env", settings.NoProxyFromEnv, "-no-proxy-from-env")
-	set.StringVar(&settings.RequestIDFormat, "request-id-format", settings.RequestIDFormat, "-request-id-format uuid4")
 	set.StringVar(&settings.RequestIDAcceptFromHeader, "request-id-accept-from-header", settings.RequestIDAcceptFromHeader, "-request-id-accept-from-header X-UID")
 	set.StringVar(&settings.RequestIDBackendHeader, "request-id-backend-header", settings.RequestIDBackendHeader, "-request-id-backend-header Couper-Request-ID")
 	set.StringVar(&settings.RequestIDClientHeader, "request-id-client-header", settings.RequestIDClientHeader, "-request-id-client-header Couper-Request-ID")
+	set.StringVar(&settings.RequestIDFormat, "request-id-format", settings.RequestIDFormat, "-request-id-format uuid4")
 	set.StringVar(&settings.SecureCookies, "secure-cookies", settings.SecureCookies, "-secure-cookies strip")
+	set.BoolVar(&settings.TelemetryMetrics, "beta-metrics", settings.TelemetryMetrics, "-metrics")
+	set.IntVar(&settings.TelemetryMetricsPort, "beta-metrics-port", settings.TelemetryMetricsPort, "-metrics-port 9090")
+	set.StringVar(&settings.TelemetryMetricsEndpoint, "beta-metrics-endpoint", settings.TelemetryMetricsEndpoint, "-metrics-endpoint [host:port]")
+	set.StringVar(&settings.TelemetryMetricsExporter, "beta-metrics-exporter", settings.TelemetryMetricsExporter, "-metrics-exporter [name]")
+	set.BoolVar(&settings.TelemetryTraces, "beta-traces", settings.TelemetryTraces, "-traces")
+	set.StringVar(&settings.TelemetryTracesEndpoint, "beta-traces-endpoint", settings.TelemetryTracesEndpoint, "-traces-endpoint [host:port]")
 	return &Run{
 		context:  ctx,
 		flagSet:  set,
@@ -109,6 +117,16 @@ func (r *Run) Execute(args Args, config *config.Couper, logEntry *logrus.Entry)
 	timings := runtime.DefaultTimings
 	env.Decode(&timings)
 
+	telemetry.InitExporter(r.context, &telemetry.Options{
+		MetricsCollectPeriod: time.Second * 2,
+		Metrics:              r.settings.TelemetryMetrics,
+		MetricsEndpoint:      r.settings.TelemetryMetricsEndpoint,
+		MetricsExporter:      r.settings.TelemetryMetricsExporter,
+		MetricsPort:          r.settings.TelemetryMetricsPort,
+		Traces:               r.settings.TelemetryTraces,
+		TracesEndpoint:       r.settings.TelemetryTracesEndpoint,
+	}, logEntry)
+
 	// logEntry has still the 'daemon' type which can be used for config related load errors.
 	srvConf, err := runtime.NewServerConfiguration(config, logEntry, cache.New(logEntry, r.context.Done()))
 	if err != nil {
@@ -158,6 +176,7 @@ func (r *Run) Execute(args Args, config *config.Couper, logEntry *logrus.Entry)
 		_ = s.Close()
 		logEntry.Infof("Server closed: %s", s.Addr)
 	}
+
 	return nil
 }
 

command/run_test.go

@@ -38,39 +38,51 @@ func TestNewRun(t *testing.T) {
 	}{
 		{"defaults from file", "01_defaults.hcl", nil, nil, &defaultSettings},
 		{"overrides from file", "02_changed_defaults.hcl", nil, nil, &config.Settings{
-			DefaultPort:            9090,
-			HealthPath:             "/status/health",
-			NoProxyFromEnv:         true,
-			LogFormat:              defaultSettings.LogFormat,
-			LogLevel:               defaultSettings.LogLevel,
-			RequestIDFormat:        "uuid4",
-			RequestIDBackendHeader: defaultSettings.RequestIDBackendHeader,
-			RequestIDClientHeader:  defaultSettings.RequestIDClientHeader,
-			XForwardedHost:         true,
-			AcceptForwardedURL:     []string{},
-			AcceptForwarded:        &config.AcceptForwarded{},
+			AcceptForwarded:          &config.AcceptForwarded{},
+			AcceptForwardedURL:       []string{},
+			DefaultPort:              9090,
+			HealthPath:               "/status/health",
+			LogFormat:                defaultSettings.LogFormat,
+			LogLevel:                 defaultSettings.LogLevel,
+			NoProxyFromEnv:           true,
+			RequestIDBackendHeader:   defaultSettings.RequestIDBackendHeader,
+			RequestIDClientHeader:    defaultSettings.RequestIDClientHeader,
+			RequestIDFormat:          "uuid4",
+			TelemetryMetricsEndpoint: defaultSettings.TelemetryMetricsEndpoint,
+			TelemetryMetricsExporter: defaultSettings.TelemetryMetricsExporter,
+			TelemetryMetricsPort:     defaultSettings.TelemetryMetricsPort,
+			TelemetryTracesEndpoint:  defaultSettings.TelemetryTracesEndpoint,
+			XForwardedHost:           true,
 		}},
 		{"defaults with flag port", "01_defaults.hcl", Args{"-p", "9876"}, nil, &config.Settings{
-			DefaultPort:            9876,
-			HealthPath:             defaultSettings.HealthPath,
-			LogFormat:              defaultSettings.LogFormat,
-			LogLevel:               defaultSettings.LogLevel,
-			RequestIDFormat:        defaultSettings.LogFormat,
-			RequestIDBackendHeader: defaultSettings.RequestIDBackendHeader,
-			RequestIDClientHeader:  defaultSettings.RequestIDClientHeader,
-			AcceptForwardedURL:     []string{},
-			AcceptForwarded:        &config.AcceptForwarded{},
+			AcceptForwarded:          &config.AcceptForwarded{},
+			AcceptForwardedURL:       []string{},
+			DefaultPort:              9876,
+			HealthPath:               defaultSettings.HealthPath,
+			LogFormat:                defaultSettings.LogFormat,
+			LogLevel:                 defaultSettings.LogLevel,
+			RequestIDBackendHeader:   defaultSettings.RequestIDBackendHeader,
+			RequestIDClientHeader:    defaultSettings.RequestIDClientHeader,
+			RequestIDFormat:          defaultSettings.LogFormat,
+			TelemetryMetricsEndpoint: defaultSettings.TelemetryMetricsEndpoint,
+			TelemetryMetricsExporter: defaultSettings.TelemetryMetricsExporter,
+			TelemetryMetricsPort:     defaultSettings.TelemetryMetricsPort,
+			TelemetryTracesEndpoint:  defaultSettings.TelemetryTracesEndpoint,
 		}},
 		{"defaults with flag and env port", "01_defaults.hcl", Args{"-p", "9876"}, []string{"COUPER_DEFAULT_PORT=4561"}, &config.Settings{
-			DefaultPort:            4561,
-			HealthPath:             defaultSettings.HealthPath,
-			LogFormat:              defaultSettings.LogFormat,
-			LogLevel:               defaultSettings.LogLevel,
-			RequestIDFormat:        defaultSettings.LogFormat,
-			RequestIDBackendHeader: defaultSettings.RequestIDBackendHeader,
-			RequestIDClientHeader:  defaultSettings.RequestIDClientHeader,
-			AcceptForwardedURL:     []string{},
-			AcceptForwarded:        &config.AcceptForwarded{},
+			AcceptForwarded:          &config.AcceptForwarded{},
+			AcceptForwardedURL:       []string{},
+			DefaultPort:              4561,
+			HealthPath:               defaultSettings.HealthPath,
+			LogFormat:                defaultSettings.LogFormat,
+			LogLevel:                 defaultSettings.LogLevel,
+			RequestIDBackendHeader:   defaultSettings.RequestIDBackendHeader,
+			RequestIDClientHeader:    defaultSettings.RequestIDClientHeader,
+			RequestIDFormat:          defaultSettings.LogFormat,
+			TelemetryMetricsEndpoint: defaultSettings.TelemetryMetricsEndpoint,
+			TelemetryMetricsExporter: defaultSettings.TelemetryMetricsExporter,
+			TelemetryMetricsPort:     defaultSettings.TelemetryMetricsPort,
+			TelemetryTracesEndpoint:  defaultSettings.TelemetryTracesEndpoint,
 		}},
 	}
 	for _, tt := range tests {
@@ -101,7 +113,7 @@ func TestNewRun(t *testing.T) {
 			time.Sleep(time.Second / 4)
 			runCmd.settingsMu.Lock()
 			if !reflect.DeepEqual(couperFile.Settings, tt.settings) {
-				t.Errorf("Settings differ:\nwant:\t%#v\ngot:\t%#v\n", tt.settings, couperFile.Settings)
+				t.Errorf("Settings differ: %s:\nwant:\t%#v\ngot:\t%#v\n", tt.name, tt.settings, couperFile.Settings)
 			}
 			runCmd.settingsMu.Unlock()
 

config/request/context_key.go

@@ -9,13 +9,16 @@ const (
 	Endpoint
 	EndpointKind
 	Error
+	Handler
+	LogDebugLevel
 	LogEntry
 	OpenAPI
 	PathParams
 	ResponseWriter
 	RoundTripName
 	RoundTripProxy
 	ServerName
+	StartTime
 	TokenRequest
 	TokenRequestRetries
 	UID

config/settings.go

@@ -48,20 +48,24 @@ func (a AcceptForwarded) String() string {
 	return strings.Join(parts, ",")
 }
 
+const otelCollectorEndpoint = "localhost:4317"
+
 // DefaultSettings defines the <DefaultSettings> object.
 var DefaultSettings = Settings{
-	DefaultPort:               8080,
-	HealthPath:                "/healthz",
-	LogFormat:                 "common",
-	LogLevel:                  "info",
-	LogPretty:                 false,
-	NoProxyFromEnv:            false,
-	RequestIDFormat:           "common",
-	RequestIDAcceptFromHeader: "",
-	RequestIDBackendHeader:    "Couper-Request-ID",
-	RequestIDClientHeader:     "Couper-Request-ID",
-	SecureCookies:             "",
-	XForwardedHost:            false,
+	DefaultPort:              8080,
+	HealthPath:               "/healthz",
+	LogFormat:                "common",
+	LogLevel:                 "info",
+	LogPretty:                false,
+	NoProxyFromEnv:           false,
+	RequestIDBackendHeader:   "Couper-Request-ID",
+	RequestIDClientHeader:    "Couper-Request-ID",
+	RequestIDFormat:          "common",
+	TelemetryMetricsEndpoint: otelCollectorEndpoint,
+	TelemetryMetricsExporter: "prometheus",
+	TelemetryMetricsPort:     9090, // default prometheus port
+	TelemetryTracesEndpoint:  otelCollectorEndpoint,
+	XForwardedHost:           false,
 
 	// TODO: refactor
 	AcceptForwardedURL: []string{},
@@ -70,21 +74,28 @@ var DefaultSettings = Settings{
 
 // Settings represents the <Settings> object.
 type Settings struct {
+	AcceptForwarded *AcceptForwarded
+
+	AcceptForwardedURL        []string `hcl:"accept_forwarded_url,optional"`
 	DefaultPort               int      `hcl:"default_port,optional"`
 	HealthPath                string   `hcl:"health_path,optional"`
 	LogFormat                 string   `hcl:"log_format,optional"`
 	LogLevel                  string   `hcl:"log_level,optional"`
 	LogPretty                 bool     `hcl:"log_pretty,optional"`
 	NoProxyFromEnv            bool     `hcl:"no_proxy_from_env,optional"`
-	RequestIDFormat           string   `hcl:"request_id_format,optional"`
 	RequestIDAcceptFromHeader string   `hcl:"request_id_accept_from_header,optional"`
 	RequestIDBackendHeader    string   `hcl:"request_id_backend_header,optional"`
 	RequestIDClientHeader     string   `hcl:"request_id_client_header,optional"`
+	RequestIDFormat           string   `hcl:"request_id_format,optional"`
 	SecureCookies             string   `hcl:"secure_cookies,optional"`
 	TLSDevProxy               List     `hcl:"https_dev_proxy,optional"`
+	TelemetryMetrics          bool     `hcl:"beta_metrics,optional"`
+	TelemetryMetricsPort      int      `hcl:"beta_metrics_port,optional"`
+	TelemetryMetricsEndpoint  string   `hcl:"beta_metrics_endpoint,optional"`
+	TelemetryMetricsExporter  string   `hcl:"beta_metrics_exporter,optional"`
+	TelemetryTraces           bool     `hcl:"beta_traces,optional"`
+	TelemetryTracesEndpoint   string   `hcl:"beta_traces_endpoint,optional"`
 	XForwardedHost            bool     `hcl:"xfh,optional"`
-	AcceptForwardedURL        []string `hcl:"accept_forwarded_url,optional"`
-	AcceptForwarded           *AcceptForwarded
 }
 
 var _ flag.Value = &List{}

errors/error.go

@@ -104,16 +104,16 @@ func (e *Error) Unwrap() error {
 
 // LogError contains additional context which should be used for logging purposes only.
 func (e *Error) LogError() string {
-	msg := appendMsg(e.synopsis, e.label, e.message)
+	msg := AppendMsg(e.synopsis, e.label, e.message)
 
 	if e.inner != nil {
 		if innr, ok := e.inner.(*Error); ok {
 			if Equals(e, innr) {
 				innr.synopsis = "" // at least for one level, prevent duplicated synopsis
 			}
-			return appendMsg(msg, innr.LogError())
+			return AppendMsg(msg, innr.LogError())
 		}
-		msg = appendMsg(msg, e.inner.Error())
+		msg = AppendMsg(msg, e.inner.Error())
 	}
 
 	return msg
@@ -127,8 +127,8 @@ func (e *Error) HTTPStatus() int {
 	return e.httpStatus
 }
 
-// appendMsg chains the given strings with ": " as separator.
-func appendMsg(target string, messages ...string) string {
+// AppendMsg chains the given strings with ": " as separator.
+func AppendMsg(target string, messages ...string) string {
 	result := target
 	for _, m := range messages {
 		if result != "" && m != "" {

eval/http.go

@@ -197,7 +197,7 @@ func getFormParams(ctx *hcl.EvalContext, req *http.Request, attrs map[string]*hc
 		return nil
 	}
 
-	log := req.Context().Value(request.LogEntry).(*logrus.Entry)
+	log := req.Context().Value(request.LogEntry).(*logrus.Entry).WithContext(req.Context())
 
 	if req.Method != http.MethodPost {
 		log.WithError(errors.Evaluation.Label("form_params").
@@ -329,8 +329,8 @@ func ApplyResponseContext(ctx context.Context, body hcl.Body, beresp *http.Respo
 		return nil
 	}
 
-	content, _, _ := body.PartialContent(config.BackendInlineSchema)
-	if attr, ok := content.Attributes["set_response_status"]; ok {
+	bodyContent, _, _ := body.PartialContent(config.BackendInlineSchema)
+	if attr, ok := bodyContent.Attributes["set_response_status"]; ok {
 		_, err := ApplyResponseStatus(ctx, attr, beresp)
 		return err
 	}
@@ -358,7 +358,7 @@ func ApplyResponseStatus(ctx context.Context, attr *hcl.Attribute, beresp *http.
 	if beresp != nil {
 		if status == 204 {
 			beresp.Request.Context().
-				Value(request.LogEntry).(*logrus.Entry).
+				Value(request.LogEntry).(*logrus.Entry).WithContext(ctx).
 				Warn("set_response_status: removing body, if any due to status-code 204")
 
 			beresp.Body = io.NopCloser(bytes.NewBuffer([]byte{}))