Skip to content

Commit

Permalink
[instrumentation] Remove env var prefix validation (#2768)
Browse files Browse the repository at this point in the history
* Remove env var prefix validation

* changelog
  • Loading branch information
TylerHelmuth authored Mar 19, 2024
1 parent a7967a9 commit 798cd0d
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 40 deletions.
16 changes: 16 additions & 0 deletions .chloggen/remove-env-var-validation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action)
component: instrumentation

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Remove env var prefix validation

# One or more tracking issues related to the change
issues: [2768]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
40 changes: 0 additions & 40 deletions apis/v1alpha1/instrumentation_webhook.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,6 @@ import (
"github.com/open-telemetry/opentelemetry-operator/pkg/constants"
)

const (
envPrefix = "OTEL_"
envSplunkPrefix = "SPLUNK_"
)

var (
_ admission.CustomValidator = &InstrumentationWebhook{}
_ admission.CustomDefaulter = &InstrumentationWebhook{}
Expand Down Expand Up @@ -245,44 +240,9 @@ func (w InstrumentationWebhook) validate(r *Instrumentation) (admission.Warnings
default:
return warnings, fmt.Errorf("spec.sampler.type is not valid: %s", r.Spec.Sampler.Type)
}

// validate env vars
if err := w.validateEnv(r.Spec.Env); err != nil {
return warnings, err
}
if err := w.validateEnv(r.Spec.Java.Env); err != nil {
return warnings, err
}
if err := w.validateEnv(r.Spec.NodeJS.Env); err != nil {
return warnings, err
}
if err := w.validateEnv(r.Spec.Python.Env); err != nil {
return warnings, err
}
if err := w.validateEnv(r.Spec.DotNet.Env); err != nil {
return warnings, err
}
if err := w.validateEnv(r.Spec.Go.Env); err != nil {
return warnings, err
}
if err := w.validateEnv(r.Spec.ApacheHttpd.Env); err != nil {
return warnings, err
}
if err := w.validateEnv(r.Spec.Nginx.Env); err != nil {
return warnings, err
}
return warnings, nil
}

func (w InstrumentationWebhook) validateEnv(envs []corev1.EnvVar) error {
for _, env := range envs {
if !strings.HasPrefix(env.Name, envPrefix) && !strings.HasPrefix(env.Name, envSplunkPrefix) {
return fmt.Errorf("env name should start with \"OTEL_\" or \"SPLUNK_\": %s", env.Name)
}
}
return nil
}

func validateJaegerRemoteSamplerArgument(argument string) error {
parts := strings.Split(argument, ",")

Expand Down

0 comments on commit 798cd0d

Please sign in to comment.