Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enable JAEGER_SERVICE_NAME and JAEGER_PROPAGATION env vars to be set … #128

Merged
merged 2 commits into from
Nov 27, 2018
Merged

Enable JAEGER_SERVICE_NAME and JAEGER_PROPAGATION env vars to be set … #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4947ec8
Enable JAEGER_SERVICE_NAME and JAEGER_PROPAGATION env vars to be set …
objectiser Nov 23, 2018
163fa63
Addressed comments
objectiser Nov 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions pkg/inject/sidecar.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,19 @@ var (
Annotation = "inject-jaeger-agent"
)

const (
envVarServiceName = "JAEGER_SERVICE_NAME"
envVarPropagation = "JAEGER_PROPAGATION"
)

// Sidecar adds a new container to the deployment, connecting to the given jaeger instance
func Sidecar(dep *appsv1.Deployment, jaeger *v1alpha1.Jaeger) {
deployment.NewAgent(jaeger) // we need some initialization from that, but we don't actually need the agent's instance here

if jaeger == nil || dep.Annotations[Annotation] != jaeger.Name {
logrus.Debugf("Skipping sidecar injection for deployment %v", dep.Name)
} else {
decorate(dep)
logrus.Debugf("Injecting sidecar for pod %v", dep.Name)
dep.Spec.Template.Spec.Containers = append(dep.Spec.Template.Spec.Containers, container(jaeger))
}
Expand Down Expand Up @@ -96,3 +102,38 @@ func container(jaeger *v1alpha1.Jaeger) v1.Container {
},
}
}

func decorate(dep *appsv1.Deployment) {
if app, found := dep.Spec.Template.Labels["app"]; found {
// Append the namespace to the app name. Using the DNS style "<app>.<namespace>""
// which also matches with the style used in Istio.
if len(dep.Namespace) > 0 {
app += "." + dep.Namespace
} else {
app += ".default"
}
for i := 0; i < len(dep.Spec.Template.Spec.Containers); i++ {
if !hasEnv(envVarServiceName, dep.Spec.Template.Spec.Containers[i].Env) {
dep.Spec.Template.Spec.Containers[i].Env = append(dep.Spec.Template.Spec.Containers[i].Env, v1.EnvVar{
Name: envVarServiceName,
Value: app,
})
}
if !hasEnv(envVarPropagation, dep.Spec.Template.Spec.Containers[i].Env) {
dep.Spec.Template.Spec.Containers[i].Env = append(dep.Spec.Template.Spec.Containers[i].Env, v1.EnvVar{
Name: envVarPropagation,
Value: "jaeger,b3",
})
}
}
}
}

func hasEnv(name string, vars []v1.EnvVar) bool {
for i := 0; i < len(vars); i++ {
if vars[i].Name == name {
return true
}
}
return false
}
85 changes: 76 additions & 9 deletions pkg/inject/sidecar_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,79 @@ func reset() {

func TestInjectSidecar(t *testing.T) {
jaeger := v1alpha1.NewJaeger("TestInjectSidecar")
dep := dep(map[string]string{Annotation: jaeger.Name})
dep := dep(map[string]string{Annotation: jaeger.Name}, map[string]string{})
Sidecar(dep, jaeger)
assert.Len(t, dep.Spec.Template.Spec.Containers, 2)
assert.Contains(t, dep.Spec.Template.Spec.Containers[1].Image, "jaeger-agent")
assert.Len(t, dep.Spec.Template.Spec.Containers[0].Env, 0)
}

func TestInjectSidecarWithEnvVars(t *testing.T) {
jaeger := v1alpha1.NewJaeger("TestInjectSidecarWithEnvVars")
dep := dep(map[string]string{Annotation: jaeger.Name}, map[string]string{"app": "testapp"})
Sidecar(dep, jaeger)
assert.Len(t, dep.Spec.Template.Spec.Containers, 2)
assert.Contains(t, dep.Spec.Template.Spec.Containers[1].Image, "jaeger-agent")
assert.Len(t, dep.Spec.Template.Spec.Containers[0].Env, 2)
assert.Equal(t, envVarServiceName, dep.Spec.Template.Spec.Containers[0].Env[0].Name)
assert.Equal(t, "testapp.default", dep.Spec.Template.Spec.Containers[0].Env[0].Value)
assert.Equal(t, envVarPropagation, dep.Spec.Template.Spec.Containers[0].Env[1].Name)
assert.Equal(t, "jaeger,b3", dep.Spec.Template.Spec.Containers[0].Env[1].Value)
}

func TestInjectSidecarWithEnvVarsWithNamespace(t *testing.T) {
jaeger := v1alpha1.NewJaeger("TestInjectSidecarWithEnvVarsWithNamespace")
dep := dep(map[string]string{Annotation: jaeger.Name}, map[string]string{"app": "testapp"})
dep.Namespace = "mynamespace"
Sidecar(dep, jaeger)
assert.Len(t, dep.Spec.Template.Spec.Containers, 2)
assert.Contains(t, dep.Spec.Template.Spec.Containers[1].Image, "jaeger-agent")
assert.Len(t, dep.Spec.Template.Spec.Containers[0].Env, 2)
assert.Equal(t, envVarServiceName, dep.Spec.Template.Spec.Containers[0].Env[0].Name)
assert.Equal(t, "testapp.mynamespace", dep.Spec.Template.Spec.Containers[0].Env[0].Value)
assert.Equal(t, envVarPropagation, dep.Spec.Template.Spec.Containers[0].Env[1].Name)
assert.Equal(t, "jaeger,b3", dep.Spec.Template.Spec.Containers[0].Env[1].Value)
}

func TestInjectSidecarWithEnvVarsOverrideName(t *testing.T) {
jaeger := v1alpha1.NewJaeger("TestInjectSidecarWithEnvVarsOverrideName")
dep := dep(map[string]string{Annotation: jaeger.Name}, map[string]string{"app": "testapp"})
dep.Spec.Template.Spec.Containers[0].Env = append(dep.Spec.Template.Spec.Containers[0].Env, v1.EnvVar{
Name: envVarServiceName,
Value: "otherapp",
})
Sidecar(dep, jaeger)
assert.Len(t, dep.Spec.Template.Spec.Containers, 2)
assert.Contains(t, dep.Spec.Template.Spec.Containers[1].Image, "jaeger-agent")
assert.Len(t, dep.Spec.Template.Spec.Containers[0].Env, 2)
assert.Equal(t, envVarServiceName, dep.Spec.Template.Spec.Containers[0].Env[0].Name)
// Explicitly provided env var is used instead of injected "app.namespace" value
assert.Equal(t, "otherapp", dep.Spec.Template.Spec.Containers[0].Env[0].Value)
assert.Equal(t, envVarPropagation, dep.Spec.Template.Spec.Containers[0].Env[1].Name)
assert.Equal(t, "jaeger,b3", dep.Spec.Template.Spec.Containers[0].Env[1].Value)
}

func TestInjectSidecarWithEnvVarsOverridePropagation(t *testing.T) {
jaeger := v1alpha1.NewJaeger("TestInjectSidecarWithEnvVarsOverridePropagation")
dep := dep(map[string]string{Annotation: jaeger.Name}, map[string]string{"app": "testapp"})
dep.Spec.Template.Spec.Containers[0].Env = append(dep.Spec.Template.Spec.Containers[0].Env, v1.EnvVar{
Name: envVarPropagation,
Value: "tracecontext",
})
Sidecar(dep, jaeger)
assert.Len(t, dep.Spec.Template.Spec.Containers, 2)
assert.Contains(t, dep.Spec.Template.Spec.Containers[1].Image, "jaeger-agent")
assert.Len(t, dep.Spec.Template.Spec.Containers[0].Env, 2)
assert.Equal(t, envVarPropagation, dep.Spec.Template.Spec.Containers[0].Env[0].Name)
// Explicitly provided propagation env var used instead of injected "jaeger,b3" value
assert.Equal(t, "tracecontext", dep.Spec.Template.Spec.Containers[0].Env[0].Value)
assert.Equal(t, envVarServiceName, dep.Spec.Template.Spec.Containers[0].Env[1].Name)
assert.Equal(t, "testapp.default", dep.Spec.Template.Spec.Containers[0].Env[1].Value)
}

func TestSkipInjectSidecar(t *testing.T) {
jaeger := v1alpha1.NewJaeger("TestSkipInjectSidecar")
dep := dep(map[string]string{Annotation: "non-existing-operator"})
dep := dep(map[string]string{Annotation: "non-existing-operator"}, map[string]string{})
Sidecar(dep, jaeger)
assert.Len(t, dep.Spec.Template.Spec.Containers, 1)
assert.NotContains(t, dep.Spec.Template.Spec.Containers[0].Image, "jaeger-agent")
Expand All @@ -59,20 +123,20 @@ func TestSidecarNotNeeded(t *testing.T) {
}

func TestSidecarNeeded(t *testing.T) {
dep := dep(map[string]string{Annotation: "some-jaeger-instance"})
dep := dep(map[string]string{Annotation: "some-jaeger-instance"}, map[string]string{})
assert.True(t, Needed(dep))
}

func TestHasSidecarAlready(t *testing.T) {
dep := dep(map[string]string{Annotation: "TestHasSidecarAlready"})
dep := dep(map[string]string{Annotation: "TestHasSidecarAlready"}, map[string]string{})
assert.True(t, Needed(dep))
jaeger := v1alpha1.NewJaeger("TestHasSidecarAlready")
Sidecar(dep, jaeger)
assert.False(t, Needed(dep))
}

func TestSelectSingleJaegerPod(t *testing.T) {
dep := dep(map[string]string{Annotation: "true"})
dep := dep(map[string]string{Annotation: "true"}, map[string]string{})
jaegerPods := &v1alpha1.JaegerList{
Items: []v1alpha1.Jaeger{
v1alpha1.Jaeger{
Expand All @@ -89,7 +153,7 @@ func TestSelectSingleJaegerPod(t *testing.T) {
}

func TestCannotSelectFromMultipleJaegerPods(t *testing.T) {
dep := dep(map[string]string{Annotation: "true"})
dep := dep(map[string]string{Annotation: "true"}, map[string]string{})
jaegerPods := &v1alpha1.JaegerList{
Items: []v1alpha1.Jaeger{
v1alpha1.Jaeger{
Expand All @@ -110,13 +174,13 @@ func TestCannotSelectFromMultipleJaegerPods(t *testing.T) {
}

func TestNoAvailableJaegerPods(t *testing.T) {
dep := dep(map[string]string{Annotation: "true"})
dep := dep(map[string]string{Annotation: "true"}, map[string]string{})
jaeger := Select(dep, &v1alpha1.JaegerList{})
assert.Nil(t, jaeger)
}

func TestSelectBasedOnName(t *testing.T) {
dep := dep(map[string]string{Annotation: "the-second-jaeger-instance-available"})
dep := dep(map[string]string{Annotation: "the-second-jaeger-instance-available"}, map[string]string{})

jaegerPods := &v1alpha1.JaegerList{
Items: []v1alpha1.Jaeger{
Expand All @@ -138,13 +202,16 @@ func TestSelectBasedOnName(t *testing.T) {
assert.Equal(t, "the-second-jaeger-instance-available", jaeger.Name)
}

func dep(annotations map[string]string) *appsv1.Deployment {
func dep(annotations map[string]string, labels map[string]string) *appsv1.Deployment {
return &appsv1.Deployment{
ObjectMeta: metav1.ObjectMeta{
Annotations: annotations,
},
Spec: appsv1.DeploymentSpec{
Template: v1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Labels: labels,
},
Spec: v1.PodSpec{
Containers: []v1.Container{
v1.Container{},
Expand Down