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

feat(operator): Introduce OTel tracing for WorkloadInstance controller #131

Merged
merged 3 commits into from
Oct 7, 2022
Merged

feat(operator): Introduce OTel tracing for WorkloadInstance controller #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ebe6163
feat(operator): Introduce OTel tracing for WorkloadInstance controller
bacherfl Oct 6, 2022
bc77f54
fix span name
bacherfl Oct 7, 2022
205172e
adapt span name
bacherfl Oct 7, 2022
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
6 changes: 6 additions & 0 deletions operator/api/v1alpha1/semconv/semconv.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ func AddAttributeFromWorkload(s trace.Span, w v1alpha1.KeptnWorkload) {
s.SetAttributes(common.Version.String(w.Spec.Version))
}

func AddAttributeFromWorkloadInstance(s trace.Span, w v1alpha1.KeptnWorkloadInstance) {
s.SetAttributes(common.ApplicationName.String(w.Spec.AppName))
s.SetAttributes(common.Workload.String(w.Name))
s.SetAttributes(common.Version.String(w.Spec.Version))
}

func AddAttributeFromAnnotations(s trace.Span, annotations map[string]string) {
s.SetAttributes(common.ApplicationName.String(annotations[common.AppAnnotation]))
s.SetAttributes(common.Workload.String(annotations[common.WorkloadAnnotation]))
Expand Down
32 changes: 30 additions & 2 deletions operator/controllers/keptnworkloadinstance/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ package keptnworkloadinstance
import (
"context"
"fmt"
"github.com/keptn-sandbox/lifecycle-controller/operator/api/v1alpha1/semconv"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/codes"
"go.opentelemetry.io/otel/propagation"
"go.opentelemetry.io/otel/trace"
"math/rand"
"time"

Expand Down Expand Up @@ -56,6 +61,7 @@ type KeptnWorkloadInstanceReconciler struct {
Recorder record.EventRecorder
Log logr.Logger
Meters common.KeptnMeters
Tracer trace.Tracer
}

//+kubebuilder:rbac:groups=lifecycle.keptn.sh,resources=keptnworkloadinstances,verbs=get;list;watch;create;update;patch;delete
Expand Down Expand Up @@ -92,6 +98,14 @@ func (r *KeptnWorkloadInstanceReconciler) Reconcile(ctx context.Context, req ctr
return reconcile.Result{}, fmt.Errorf("could not fetch KeptnWorkloadInstance: %+v", err)
}

traceContextCarrier := propagation.MapCarrier(workloadInstance.Annotations)
ctx = otel.GetTextMapPropagator().Extract(ctx, traceContextCarrier)

ctx, span := r.Tracer.Start(ctx, "reconcile_workload_instance", trace.WithSpanKind(trace.SpanKindConsumer))
defer span.End()

semconv.AddAttributeFromWorkloadInstance(span, *workloadInstance)

if !workloadInstance.IsStartTimeSet() {
// metrics: increment active deployment counter
r.Meters.DeploymentActive.Add(ctx, 1, workloadInstance.GetActiveMetricsAttributes()...)
Expand All @@ -103,6 +117,7 @@ func (r *KeptnWorkloadInstanceReconciler) Reconcile(ctx context.Context, req ctr
err := r.reconcilePreDeployment(ctx, req, workloadInstance)
if err != nil {
r.Log.Error(err, "Error reconciling pre-deployment checks")
span.SetStatus(codes.Error, err.Error())
return ctrl.Result{Requeue: true}, err
}
return ctrl.Result{Requeue: true, RequeueAfter: 5 * time.Second}, nil
Expand All @@ -113,6 +128,7 @@ func (r *KeptnWorkloadInstanceReconciler) Reconcile(ctx context.Context, req ctr
err := r.reconcileDeployment(ctx, workloadInstance)
if err != nil {
r.Log.Error(err, "Error reconciling deployment")
span.SetStatus(codes.Error, err.Error())
return ctrl.Result{Requeue: true}, err
}
return ctrl.Result{Requeue: true, RequeueAfter: 10 * time.Second}, nil
Expand All @@ -123,6 +139,7 @@ func (r *KeptnWorkloadInstanceReconciler) Reconcile(ctx context.Context, req ctr
err = r.reconcilePostDeployment(ctx, req, workloadInstance)
if err != nil {
r.Log.Error(err, "Error reconciling post-deployment checks")
span.SetStatus(codes.Error, err.Error())
return ctrl.Result{Requeue: true}, err
}
return ctrl.Result{Requeue: true, RequeueAfter: 5 * time.Second}, nil
Expand All @@ -138,6 +155,7 @@ func (r *KeptnWorkloadInstanceReconciler) Reconcile(ctx context.Context, req ctr

err = r.Client.Status().Update(ctx, workloadInstance)
if err != nil {
span.SetStatus(codes.Error, err.Error())
return ctrl.Result{Requeue: true}, err
}

Expand Down Expand Up @@ -223,10 +241,20 @@ func generateTaskName(checkType common.CheckType, taskName string) string {
}

func (r *KeptnWorkloadInstanceReconciler) createKeptnTask(ctx context.Context, namespace string, workloadInstance *klcv1alpha1.KeptnWorkloadInstance, taskDefinition string, checkType common.CheckType) (string, error) {
ctx, span := r.Tracer.Start(ctx, fmt.Sprintf("create_%s_deployment_task", checkType), trace.WithSpanKind(trace.SpanKindProducer))
defer span.End()

semconv.AddAttributeFromWorkloadInstance(span, *workloadInstance)

// create TraceContext
// follow up with a Keptn propagator that JSON-encoded the OTel map into our own key
traceContextCarrier := propagation.MapCarrier{}
otel.GetTextMapPropagator().Inject(ctx, traceContextCarrier)
newTask := &klcv1alpha1.KeptnTask{
ObjectMeta: metav1.ObjectMeta{
Name: generateTaskName(checkType, taskDefinition),
Namespace: namespace,
Name: generateTaskName(checkType, taskDefinition),
Namespace: namespace,
Annotations: traceContextCarrier,
},
Spec: klcv1alpha1.KeptnTaskSpec{
Workload: workloadInstance.Spec.WorkloadName,
Expand Down
1 change: 1 addition & 0 deletions operator/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,7 @@ func main() {
Log: ctrl.Log.WithName("KeptnWorkloadInstance Controller"),
Recorder: mgr.GetEventRecorderFor("keptnworkloadinstance-controller"),
Meters: meters,
Tracer: otel.Tracer("keptn/operator/workloadinstance"),
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "KeptnWorkloadInstance")
os.Exit(1)
Expand Down