mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Stephan BehnkeandGitHub
a9c9d9921e
## What changed? <!-- Describe what has changed in this PR --> - allow configuring a custom OTEL `service.name` prefix - allow configuring an OTEL exporter via env vars (following the [OTEL spec](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options)) **Note that the OTEL exporter from the environment variables will only be created if there isn't already one from the config.** Creating an additional one wouldn't make any sense since the env variables would be applied to both anyways and there would not be any difference between them. ## Why? <!-- Tell your future self why have you made these changes --> Addresses: - https://github.com/temporalio/temporal/issues/4042 - https://github.com/temporalio/temporal/issues/4041 - our own (increasing) need to enable OpenTelemetry tracing without touching the Server config (for ad-hoc debugging when working on a SDK, for example) ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> I ran an OTEL collector to verify it sends the tracing exports. These are the env vars I set to make it work: ```go os.Setenv("OTEL_TRACES_EXPORTER", "oltp") os.Setenv("OTEL_EXPORTER_OTLP_TRACES_INSECURE", "true") ``` ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> I doubt anyone would accidentally have these env variables specified and turn on OpenTelemetry by accident. Unless these are specified; no behavior change occurs. ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) --> No
125 lines
4.2 KiB
Go
125 lines
4.2 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package telemetry_test
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
"go.temporal.io/server/common/primitives"
|
|
"go.temporal.io/server/common/telemetry"
|
|
)
|
|
|
|
func TestSupplementTraceExportersFromEnv(t *testing.T) {
|
|
t.Run("when env variable specifies valid OTEL exporter type, add exporter", func(t *testing.T) {
|
|
exporters, err := telemetry.SpanExportersFromEnv(
|
|
func(key string) (string, bool) {
|
|
if key == telemetry.OtelTracesExporterTypesEnvKey {
|
|
return string(telemetry.OtelTracesOtlpExporterType), true
|
|
}
|
|
return "", false
|
|
})
|
|
|
|
require.NoError(t, err)
|
|
require.Len(t, exporters, 1)
|
|
})
|
|
|
|
t.Run("when env variable specifies valid OTEL exporter type but invalid protocol, return error", func(t *testing.T) {
|
|
exporters, err := telemetry.SpanExportersFromEnv(
|
|
func(key string) (string, bool) {
|
|
switch key {
|
|
case telemetry.OtelTracesExporterTypesEnvKey:
|
|
return string(telemetry.OtelTracesOtlpExporterType), true
|
|
case telemetry.OtelExporterOtlpTracesProtocolEnvKey:
|
|
return "invalid", true
|
|
}
|
|
return "", false
|
|
})
|
|
|
|
require.EqualError(t, err, "unsupported OTEL exporter protocol: OTEL_EXPORTER_OTLP_TRACES_PROTOCOL=invalid")
|
|
require.Empty(t, exporters)
|
|
})
|
|
|
|
t.Run("when env variable is specified but exporter type is not supported, return error", func(t *testing.T) {
|
|
exporters, err := telemetry.SpanExportersFromEnv(
|
|
func(key string) (string, bool) {
|
|
if key == telemetry.OtelTracesExporterTypesEnvKey {
|
|
return fmt.Sprintf("%v,%v", telemetry.OtelTracesOtlpExporterType, "nonsense"), true
|
|
}
|
|
return "", false
|
|
})
|
|
|
|
require.EqualError(t, err, "unsupported OTEL exporter: OTEL_TRACES_EXPORTER=nonsense")
|
|
require.Empty(t, exporters)
|
|
})
|
|
|
|
t.Run("when not specified, do not create any exporters", func(t *testing.T) {
|
|
exporters, err := telemetry.SpanExportersFromEnv(
|
|
func(key string) (string, bool) {
|
|
return "", false
|
|
})
|
|
|
|
require.NoError(t, err)
|
|
require.Empty(t, exporters)
|
|
})
|
|
}
|
|
|
|
func TestResourceServiceName(t *testing.T) {
|
|
t.Run("when env variable is specified, use custom service name prefix", func(t *testing.T) {
|
|
require.Equal(t,
|
|
"PREFIX.matching",
|
|
telemetry.ResourceServiceName(primitives.MatchingService, func(key string) (string, bool) {
|
|
require.Equal(t, telemetry.OtelServiceNameEnvKey, key)
|
|
return "PREFIX", true
|
|
}),
|
|
)
|
|
})
|
|
|
|
t.Run("when not specified, use default prefix", func(t *testing.T) {
|
|
require.Equal(t,
|
|
"io.temporal.history",
|
|
telemetry.ResourceServiceName(primitives.HistoryService, func(key string) (string, bool) {
|
|
return "", false
|
|
}),
|
|
)
|
|
})
|
|
|
|
t.Run("always use single service name for internal frontend", func(t *testing.T) {
|
|
require.Equal(t,
|
|
"PREFIX.frontend",
|
|
telemetry.ResourceServiceName(primitives.InternalFrontendService, func(key string) (string, bool) {
|
|
return "PREFIX", true
|
|
}),
|
|
)
|
|
require.Equal(t,
|
|
"io.temporal.frontend",
|
|
telemetry.ResourceServiceName(primitives.InternalFrontendService, func(key string) (string, bool) {
|
|
return "", false
|
|
}),
|
|
)
|
|
})
|
|
}
|