Skip to content

Commit

Permalink
Add condition for instrumentedApplication (#1203)
Browse files Browse the repository at this point in the history
  • Loading branch information
RonFed authored May 19, 2024
1 parent e5ded08 commit 32190bf
Show file tree
Hide file tree
Showing 9 changed files with 155 additions and 8 deletions.
72 changes: 72 additions & 0 deletions api/config/crd/bases/odigos.io_instrumentedapplications.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,78 @@ spec:
status:
description: InstrumentedApplicationStatus defines the observed state
of InstrumentedApplication
properties:
conditions:
description: Represents the observations of a nstrumentedApplication's
current state.
items:
description: "Condition contains details for one aspect of the current
state of this API Resource.\n---\nThis struct is intended for
direct use as an array at the field path .status.conditions. For
example,\n\n\n\ttype FooStatus struct{\n\t // Represents the
observations of a foo's current state.\n\t // Known .status.conditions.type
are: \"Available\", \"Progressing\", and \"Degraded\"\n\t //
+patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t
\ // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\"
patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t
\ // other fields\n\t}"
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: |-
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: |-
type of condition in CamelCase or in foo.example.com/CamelCase.
---
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
useful (see .node.status.conditions), the ability to deconflict is important.
The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
type: object
type: object
served: true
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions api/generated/odigos/applyconfiguration/utils.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions api/odigos/v1alpha1/instrumentedapplication_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ type InstrumentedApplicationSpec struct {

// InstrumentedApplicationStatus defines the observed state of InstrumentedApplication
type InstrumentedApplicationStatus struct {
// Represents the observations of a nstrumentedApplication's current state.
Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" protobuf:"bytes,1,rep,name=conditions"`
}

//+genclient
Expand Down
9 changes: 8 additions & 1 deletion api/odigos/v1alpha1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions cli/cmd/resources/crds/instrumentedapps.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package crds

import (
"github.com/odigos-io/odigos/cli/cmd/resources/crds/common"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
Expand Down Expand Up @@ -187,6 +188,9 @@ func NewInstrumentedApp() *apiextensionsv1.CustomResourceDefinition {
},
"status": {
Type: "object",
Properties: map[string]apiextensionsv1.JSONSchemaProps{
"conditions": common.Conditions,
},
},
},
},
Expand Down
8 changes: 8 additions & 0 deletions instrumentor/controllers/instrumentationdevice/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ import (
"github.com/go-logr/logr"
odigosv1 "github.com/odigos-io/odigos/api/odigos/v1alpha1"
"github.com/odigos-io/odigos/common/consts"
"github.com/odigos-io/odigos/common/k8s"
"github.com/odigos-io/odigos/common/utils"
"github.com/odigos-io/odigos/instrumentor/instrumentation"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/log"
Expand All @@ -25,6 +27,10 @@ const (
UnInstrumentReasonRemoveAll UnInstrumentReason = "Remove all"
)

const (
appliedInstrumentationDeviceType = "AppliedInstrumentationDevice"
)

func clearInstrumentationEbpf(obj client.Object) {
annotations := obj.GetAnnotations()
if annotations == nil {
Expand Down Expand Up @@ -80,8 +86,10 @@ func instrument(logger logr.Logger, ctx context.Context, kubeClient client.Clien
})

if err != nil {
k8s.UpdateStatusConditions(ctx, kubeClient, runtimeDetails, &runtimeDetails.Status.Conditions, metav1.ConditionFalse, appliedInstrumentationDeviceType, "ErrApplyInstrumentationDevice", err.Error())
return err
}
k8s.UpdateStatusConditions(ctx, kubeClient, runtimeDetails, &runtimeDetails.Status.Conditions, metav1.ConditionTrue, appliedInstrumentationDeviceType, string(result), "Successfully applied instrumentation device to pod template")

if result != controllerutil.OperationResultNone {
logger.V(0).Info("instrumented application", "name", obj.GetName(), "namespace", obj.GetNamespace())
Expand Down
10 changes: 8 additions & 2 deletions instrumentor/instrumentation/instrumentation.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package instrumentation

import (
"encoding/json"
"errors"
"fmt"
"strings"

Expand All @@ -15,6 +16,11 @@ import (
"k8s.io/apimachinery/pkg/api/resource"
)

var (
ErrNoDefaultSDK = errors.New("no default sdks found")
ErrPatchEnvVars = errors.New("failed to patch env vars")
)

func ApplyInstrumentationDevicesToPodTemplate(original *v1.PodTemplateSpec, runtimeDetails *odigosv1.InstrumentedApplication, defaultSdks map[common.ProgrammingLanguage]common.OtelSdk, targetObj client.Object) error {

// delete any existing instrumentation devices.
Expand All @@ -32,7 +38,7 @@ func ApplyInstrumentationDevicesToPodTemplate(original *v1.PodTemplateSpec, runt

otelSdk, found := defaultSdks[*containerLanguage]
if !found {
return fmt.Errorf("default sdk not found for language %s", *containerLanguage)
return fmt.Errorf("%w for language: %s, container:%s", ErrNoDefaultSDK, *containerLanguage, container.Name)
}

instrumentationDeviceName := common.InstrumentationDeviceName(*containerLanguage, otelSdk)
Expand All @@ -44,7 +50,7 @@ func ApplyInstrumentationDevicesToPodTemplate(original *v1.PodTemplateSpec, runt

err := patchEnvVars(runtimeDetails, &container, targetObj)
if err != nil {
return fmt.Errorf("failed to patch env vars: %v", err)
return fmt.Errorf("%w: %v", ErrPatchEnvVars, err)
}

modifiedContainers = append(modifiedContainers, container)
Expand Down

0 comments on commit 32190bf

Please sign in to comment.