1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
|
// Copyright 2020 New Relic Corporation. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
package newrelic
import (
"fmt"
"io"
"os"
"strconv"
"strings"
"unicode/utf8"
)
// ConfigOption configures the Config when provided to NewApplication.
type ConfigOption func(*Config)
// ConfigEnabled sets the whether or not the agent is enabled.
func ConfigEnabled(enabled bool) ConfigOption {
return func(cfg *Config) { cfg.Enabled = enabled }
}
// ConfigAppName sets the application name.
func ConfigAppName(appName string) ConfigOption {
return func(cfg *Config) { cfg.AppName = appName }
}
// ConfigLicense sets the license.
func ConfigLicense(license string) ConfigOption {
return func(cfg *Config) { cfg.License = license }
}
// ConfigDistributedTracerEnabled populates the Config's
// DistributedTracer.Enabled setting.
func ConfigDistributedTracerEnabled(enabled bool) ConfigOption {
return func(cfg *Config) { cfg.DistributedTracer.Enabled = enabled }
}
// ConfigLogger populates the Config's Logger.
func ConfigLogger(l Logger) ConfigOption {
return func(cfg *Config) { cfg.Logger = l }
}
// ConfigInfoLogger populates the config with basic Logger at info level.
func ConfigInfoLogger(w io.Writer) ConfigOption {
return ConfigLogger(NewLogger(w))
}
// ConfigDebugLogger populates the config with a Logger at debug level.
func ConfigDebugLogger(w io.Writer) ConfigOption {
return ConfigLogger(NewDebugLogger(w))
}
// ConfigFromEnvironment populates the config based on environment variables:
//
// NEW_RELIC_APP_NAME sets AppName
// NEW_RELIC_ATTRIBUTES_EXCLUDE sets Attributes.Exclude using a comma-separated list, eg. "request.headers.host,request.method"
// NEW_RELIC_ATTRIBUTES_INCLUDE sets Attributes.Include using a comma-separated list
// NEW_RELIC_DISTRIBUTED_TRACING_ENABLED sets DistributedTracer.Enabled using strconv.ParseBool
// NEW_RELIC_ENABLED sets Enabled using strconv.ParseBool
// NEW_RELIC_HIGH_SECURITY sets HighSecurity using strconv.ParseBool
// NEW_RELIC_HOST sets Host
// NEW_RELIC_INFINITE_TRACING_SPAN_EVENTS_QUEUE_SIZE sets InfiniteTracing.SpanEvents.QueueSize using strconv.Atoi
// NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_PORT sets InfiniteTracing.TraceObserver.Port using strconv.Atoi
// NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_HOST sets InfiniteTracing.TraceObserver.Host
// NEW_RELIC_LABELS sets Labels using a semi-colon delimited string of colon-separated pairs, eg. "Server:One;DataCenter:Primary"
// NEW_RELIC_LICENSE_KEY sets License
// NEW_RELIC_LOG sets Logger to log to either "stdout" or "stderr" (filenames are not supported)
// NEW_RELIC_LOG_LEVEL controls the NEW_RELIC_LOG level, must be "debug" for debug, or empty for info
// NEW_RELIC_PROCESS_HOST_DISPLAY_NAME sets HostDisplayName
// NEW_RELIC_SECURITY_POLICIES_TOKEN sets SecurityPoliciesToken
// NEW_RELIC_UTILIZATION_BILLING_HOSTNAME sets Utilization.BillingHostname
// NEW_RELIC_UTILIZATION_LOGICAL_PROCESSORS sets Utilization.LogicalProcessors using strconv.Atoi
// NEW_RELIC_UTILIZATION_TOTAL_RAM_MIB sets Utilization.TotalRAMMIB using strconv.Atoi
//
// This function is strict and will assign Config.Error if any of the
// environment variables cannot be parsed.
func ConfigFromEnvironment() ConfigOption {
return configFromEnvironment(os.Getenv)
}
func configFromEnvironment(getenv func(string) string) ConfigOption {
return func(cfg *Config) {
// Because fields could have been assigned in a previous
// ConfigOption, we only want to assign fields using environment
// variables that have been populated. This is especially
// relevant for the string case where no processing occurs.
assignBool := func(field *bool, name string) {
if env := getenv(name); env != "" {
if b, err := strconv.ParseBool(env); nil != err {
cfg.Error = fmt.Errorf("invalid %s value: %s", name, env)
} else {
*field = b
}
}
}
assignInt := func(field *int, name string) {
if env := getenv(name); env != "" {
if i, err := strconv.Atoi(env); nil != err {
cfg.Error = fmt.Errorf("invalid %s value: %s", name, env)
} else {
*field = i
}
}
}
assignString := func(field *string, name string) {
if env := getenv(name); env != "" {
*field = env
}
}
assignString(&cfg.AppName, "NEW_RELIC_APP_NAME")
assignString(&cfg.License, "NEW_RELIC_LICENSE_KEY")
assignBool(&cfg.DistributedTracer.Enabled, "NEW_RELIC_DISTRIBUTED_TRACING_ENABLED")
assignBool(&cfg.Enabled, "NEW_RELIC_ENABLED")
assignBool(&cfg.HighSecurity, "NEW_RELIC_HIGH_SECURITY")
assignString(&cfg.SecurityPoliciesToken, "NEW_RELIC_SECURITY_POLICIES_TOKEN")
assignString(&cfg.Host, "NEW_RELIC_HOST")
assignString(&cfg.HostDisplayName, "NEW_RELIC_PROCESS_HOST_DISPLAY_NAME")
assignString(&cfg.Utilization.BillingHostname, "NEW_RELIC_UTILIZATION_BILLING_HOSTNAME")
assignString(&cfg.InfiniteTracing.TraceObserver.Host, "NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_HOST")
assignInt(&cfg.InfiniteTracing.TraceObserver.Port, "NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_PORT")
assignInt(&cfg.Utilization.LogicalProcessors, "NEW_RELIC_UTILIZATION_LOGICAL_PROCESSORS")
assignInt(&cfg.Utilization.TotalRAMMIB, "NEW_RELIC_UTILIZATION_TOTAL_RAM_MIB")
assignInt(&cfg.InfiniteTracing.SpanEvents.QueueSize, "NEW_RELIC_INFINITE_TRACING_SPAN_EVENTS_QUEUE_SIZE")
if env := getenv("NEW_RELIC_LABELS"); env != "" {
if labels := getLabels(getenv("NEW_RELIC_LABELS")); len(labels) > 0 {
cfg.Labels = labels
} else {
cfg.Error = fmt.Errorf("invalid NEW_RELIC_LABELS value: %s", env)
}
}
if env := getenv("NEW_RELIC_ATTRIBUTES_INCLUDE"); env != "" {
cfg.Attributes.Include = strings.Split(env, ",")
}
if env := getenv("NEW_RELIC_ATTRIBUTES_EXCLUDE"); env != "" {
cfg.Attributes.Exclude = strings.Split(env, ",")
}
if env := getenv("NEW_RELIC_LOG"); env != "" {
if dest := getLogDest(env); dest != nil {
if isDebugEnv(getenv("NEW_RELIC_LOG_LEVEL")) {
cfg.Logger = NewDebugLogger(dest)
} else {
cfg.Logger = NewLogger(dest)
}
} else {
cfg.Error = fmt.Errorf("invalid NEW_RELIC_LOG value %s", env)
}
}
}
}
func getLogDest(env string) io.Writer {
switch env {
case "stdout", "Stdout", "STDOUT":
return os.Stdout
case "stderr", "Stderr", "STDERR":
return os.Stderr
default:
return nil
}
}
func isDebugEnv(env string) bool {
switch env {
case "debug", "Debug", "DEBUG", "d", "D":
return true
default:
return false
}
}
// getLabels reads Labels from the env string, expressed as a semi-colon
// delimited string of colon-separated pairs (for example, "Server:One;Data
// Center:Primary"). Label keys and values must be 255 characters or less in
// length. No more than 64 Labels can be set.
func getLabels(env string) map[string]string {
out := make(map[string]string)
env = strings.Trim(env, ";\t\n\v\f\r ")
for _, entry := range strings.Split(env, ";") {
if entry == "" {
return nil
}
split := strings.Split(entry, ":")
if len(split) != 2 {
return nil
}
left := strings.TrimSpace(split[0])
right := strings.TrimSpace(split[1])
if left == "" || right == "" {
return nil
}
if utf8.RuneCountInString(left) > 255 {
runes := []rune(left)
left = string(runes[:255])
}
if utf8.RuneCountInString(right) > 255 {
runes := []rune(right)
right = string(runes[:255])
}
out[left] = right
if len(out) >= 64 {
return out
}
}
return out
}
|