mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-22 20:06:07 +02:00
931266483d
* Fix per-signal endpoint parsing in otlptrace * Add distinguishing non-per-signal env var value * Fix per-signal endpoint parsing in otlpmetric * Add changes to changelog * Use else if to prevent unnecessary work * Add spec link to otlptrace README
223 lines
6.0 KiB
Go
223 lines
6.0 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package otlpconfig // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/otlpconfig"
|
|
|
|
import (
|
|
"crypto/tls"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"net/url"
|
|
"os"
|
|
"path"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"go.opentelemetry.io/otel"
|
|
)
|
|
|
|
var DefaultEnvOptionsReader = EnvOptionsReader{
|
|
GetEnv: os.Getenv,
|
|
ReadFile: ioutil.ReadFile,
|
|
}
|
|
|
|
func ApplyGRPCEnvConfigs(cfg *Config) {
|
|
DefaultEnvOptionsReader.ApplyGRPCEnvConfigs(cfg)
|
|
}
|
|
|
|
func ApplyHTTPEnvConfigs(cfg *Config) {
|
|
DefaultEnvOptionsReader.ApplyHTTPEnvConfigs(cfg)
|
|
}
|
|
|
|
type EnvOptionsReader struct {
|
|
GetEnv func(string) string
|
|
ReadFile func(filename string) ([]byte, error)
|
|
}
|
|
|
|
func (e *EnvOptionsReader) ApplyHTTPEnvConfigs(cfg *Config) {
|
|
opts := e.GetOptionsFromEnv()
|
|
for _, opt := range opts {
|
|
opt.ApplyHTTPOption(cfg)
|
|
}
|
|
}
|
|
|
|
func (e *EnvOptionsReader) ApplyGRPCEnvConfigs(cfg *Config) {
|
|
opts := e.GetOptionsFromEnv()
|
|
for _, opt := range opts {
|
|
opt.ApplyGRPCOption(cfg)
|
|
}
|
|
}
|
|
|
|
func (e *EnvOptionsReader) GetOptionsFromEnv() []GenericOption {
|
|
var opts []GenericOption
|
|
|
|
// Endpoint
|
|
if v, ok := e.getEnvValue("METRICS_ENDPOINT"); ok {
|
|
u, err := url.Parse(v)
|
|
// Ignore invalid values.
|
|
if err == nil {
|
|
// This is used to set the scheme for OTLP/HTTP.
|
|
if insecureSchema(u.Scheme) {
|
|
opts = append(opts, WithInsecure())
|
|
} else {
|
|
opts = append(opts, WithSecure())
|
|
}
|
|
opts = append(opts, newSplitOption(func(cfg *Config) {
|
|
cfg.Metrics.Endpoint = u.Host
|
|
// For endpoint URLs for OTLP/HTTP per-signal variables, the
|
|
// URL MUST be used as-is without any modification. The only
|
|
// exception is that if an URL contains no path part, the root
|
|
// path / MUST be used.
|
|
path := u.Path
|
|
if path == "" {
|
|
path = "/"
|
|
}
|
|
cfg.Metrics.URLPath = path
|
|
}, func(cfg *Config) {
|
|
// For OTLP/gRPC endpoints, this is the target to which the
|
|
// exporter is going to send telemetry.
|
|
cfg.Metrics.Endpoint = path.Join(u.Host, u.Path)
|
|
}))
|
|
}
|
|
} else if v, ok = e.getEnvValue("ENDPOINT"); ok {
|
|
u, err := url.Parse(v)
|
|
// Ignore invalid values.
|
|
if err == nil {
|
|
// This is used to set the scheme for OTLP/HTTP.
|
|
if insecureSchema(u.Scheme) {
|
|
opts = append(opts, WithInsecure())
|
|
} else {
|
|
opts = append(opts, WithSecure())
|
|
}
|
|
opts = append(opts, newSplitOption(func(cfg *Config) {
|
|
cfg.Metrics.Endpoint = u.Host
|
|
// For OTLP/HTTP endpoint URLs without a per-signal
|
|
// configuration, the passed endpoint is used as a base URL
|
|
// and the signals are sent to these paths relative to that.
|
|
cfg.Metrics.URLPath = path.Join(u.Path, DefaultMetricsPath)
|
|
}, func(cfg *Config) {
|
|
// For OTLP/gRPC endpoints, this is the target to which the
|
|
// exporter is going to send telemetry.
|
|
cfg.Metrics.Endpoint = path.Join(u.Host, u.Path)
|
|
}))
|
|
}
|
|
}
|
|
|
|
// Certificate File
|
|
if path, ok := e.getEnvValue("CERTIFICATE"); ok {
|
|
if tls, err := e.readTLSConfig(path); err == nil {
|
|
opts = append(opts, WithTLSClientConfig(tls))
|
|
} else {
|
|
otel.Handle(fmt.Errorf("failed to configure otlp exporter certificate '%s': %w", path, err))
|
|
}
|
|
}
|
|
if path, ok := e.getEnvValue("METRICS_CERTIFICATE"); ok {
|
|
if tls, err := e.readTLSConfig(path); err == nil {
|
|
opts = append(opts, WithTLSClientConfig(tls))
|
|
} else {
|
|
otel.Handle(fmt.Errorf("failed to configure otlp exporter certificate '%s': %w", path, err))
|
|
}
|
|
}
|
|
|
|
// Headers
|
|
if h, ok := e.getEnvValue("HEADERS"); ok {
|
|
opts = append(opts, WithHeaders(stringToHeader(h)))
|
|
}
|
|
if h, ok := e.getEnvValue("METRICS_HEADERS"); ok {
|
|
opts = append(opts, WithHeaders(stringToHeader(h)))
|
|
}
|
|
|
|
// Compression
|
|
if c, ok := e.getEnvValue("COMPRESSION"); ok {
|
|
opts = append(opts, WithCompression(stringToCompression(c)))
|
|
}
|
|
if c, ok := e.getEnvValue("METRICS_COMPRESSION"); ok {
|
|
opts = append(opts, WithCompression(stringToCompression(c)))
|
|
}
|
|
|
|
// Timeout
|
|
if t, ok := e.getEnvValue("TIMEOUT"); ok {
|
|
if d, err := strconv.Atoi(t); err == nil {
|
|
opts = append(opts, WithTimeout(time.Duration(d)*time.Millisecond))
|
|
}
|
|
}
|
|
if t, ok := e.getEnvValue("METRICS_TIMEOUT"); ok {
|
|
if d, err := strconv.Atoi(t); err == nil {
|
|
opts = append(opts, WithTimeout(time.Duration(d)*time.Millisecond))
|
|
}
|
|
}
|
|
|
|
return opts
|
|
}
|
|
|
|
func insecureSchema(schema string) bool {
|
|
switch strings.ToLower(schema) {
|
|
case "http", "unix":
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
}
|
|
|
|
// getEnvValue gets an OTLP environment variable value of the specified key using the GetEnv function.
|
|
// This function already prepends the OTLP prefix to all key lookup.
|
|
func (e *EnvOptionsReader) getEnvValue(key string) (string, bool) {
|
|
v := strings.TrimSpace(e.GetEnv(fmt.Sprintf("OTEL_EXPORTER_OTLP_%s", key)))
|
|
return v, v != ""
|
|
}
|
|
|
|
func (e *EnvOptionsReader) readTLSConfig(path string) (*tls.Config, error) {
|
|
b, err := e.ReadFile(path)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return CreateTLSConfig(b)
|
|
}
|
|
|
|
func stringToCompression(value string) Compression {
|
|
switch value {
|
|
case "gzip":
|
|
return GzipCompression
|
|
}
|
|
|
|
return NoCompression
|
|
}
|
|
|
|
func stringToHeader(value string) map[string]string {
|
|
headersPairs := strings.Split(value, ",")
|
|
headers := make(map[string]string)
|
|
|
|
for _, header := range headersPairs {
|
|
nameValue := strings.SplitN(header, "=", 2)
|
|
if len(nameValue) < 2 {
|
|
continue
|
|
}
|
|
name, err := url.QueryUnescape(nameValue[0])
|
|
if err != nil {
|
|
continue
|
|
}
|
|
trimmedName := strings.TrimSpace(name)
|
|
value, err := url.QueryUnescape(nameValue[1])
|
|
if err != nil {
|
|
continue
|
|
}
|
|
trimmedValue := strings.TrimSpace(value)
|
|
|
|
headers[trimmedName] = trimmedValue
|
|
}
|
|
|
|
return headers
|
|
}
|