feat: Merge basic metric types (#9)

* Remove v1beta1.singlemetric

* singlemetric cleanup

* rename chart

* update example spec

* add projections to v1alpha1 metric type

* initially replace v1beta1.CompoundMetric with v1alpha1.Metric

* remove compound metric types

* replace controllers and handlers

* clean up

* rename files

* fix metrics with no projections

* restore spec.target and swtich to gvk

Author: moelsayed

Makefile

@@ -237,8 +237,6 @@ dev-local-all:
 	$(MAKE) dev-secret
 	$(MAKE) dev-basic-metric
 	$(MAKE) dev-managed-metric
-	$(MAKE) dev-v1beta1-singlemetric
-	$(MAKE) dev-v1beta1-compmetric
 
 
 
@@ -260,11 +258,6 @@ dev-basic-metric:
 dev-managed-metric:
 	kubectl apply -f examples/managed_metric.yaml
 
-
-.PHONY: dev-v1beta1-singlemetric
-dev-v1beta1-singlemetric:
-	kubectl apply -f examples/v1beta1/singlemetric.yaml
-
 .PHONY: dev-v1beta1-compmetric
 dev-v1beta1-compmetric:
 	kubectl apply -f examples/v1beta1/compmetric.yaml
@@ -311,7 +304,7 @@ helm-chart:
 .PHONY: helm-install-local
 helm-install-local: docker-build
 	helm upgrade --install $(PROJECT_FULL_NAME) charts/$(PROJECT_FULL_NAME)/ --set image.repository=$(IMG_BASE) --set image.tag=$(IMG_VERSION) --set image.pullPolicy=Never
-	$(KIND) load docker-image ${IMG} --name=$(PROJECT_NAME)-dev
+	$(KIND) load docker-image ${IMG} --name=$(PROJECT_FULL_NAME)-dev
 
 
 

PROJECT

@@ -31,14 +31,6 @@ resources:
   kind: RemoteClusterAccess
   path: github.com/SAP/metrics-operator/api/v1alpha1
   version: v1alpha1
-- api:
-    crdVersion: v1
-    namespaced: true
-  controller: true
-  domain: metrics.cloud.sap
-  kind: SingleMetric
-  path: github.com/SAP/metrics-operator/api/v1beta1
-  version: v1beta1
 - api:
     crdVersion: v1
     namespaced: true

README.md

@@ -47,43 +47,15 @@ Replace `<operator-namespace>`, `<artifactory-secret-name>`, and `<version>` wit
 
 ## Usage
 
+### Metric
 
-### Single Metric
-To create a basic metric, deploy a `SingleMetric` resource in your desired namespace. The Metrics Operator will pick up the resource and start monitoring it, periodically sending data points to the configured data sink.
-
-Example `SingleMetric` resource:
-
-```yaml
-apiVersion: metrics.cloud.sap/v1beta1
-kind: SingleMetric
-metadata:
-  name: single-pod
-spec:
-  name: single-metric-pods
-  description: Pods
-  target:
-    kind: Pod
-    group: ""
-    version: v1
-  frequency: 1 # in minutes
----
-```
-
-Apply the metric:
-
-```bash
-kubectl apply -f singlemetric.yaml
-```
-
-### Compound Metric
-
-Compound metrics have additional capabilities, such as projections. Projections allow you to extract specific fields from the target resource and include them in the metric data.
+Metrics have additional capabilities, such as projections. Projections allow you to extract specific fields from the target resource and include them in the metric data.
 This can be useful for tracking additional dimensions of the resource, such as fields, labels or annotations. It uses the dot notation to access nested fields.
 The projections are then translated to dimensions in the metric.
 
 ```yaml
-apiVersion: metrics.cloud.sap/v1beta1
-kind: CompoundMetric
+apiVersion: metrics.cloud.sap/v1alpha
+kind: Metric
 metadata:
   name: comp-pod
 spec:
@@ -152,7 +124,7 @@ spec:
 ### Cluster Access
 The Metrics Operator can monitor both the cluster it's deployed in and remote clusters. To monitor a remote cluster, define a `ClusterAccess` resource:
 
-This cluster access resource can be used by `SingleMetric` and `CompoundMetric` resources to monitor resources in the remote cluster.
+This cluster access resource can be used by `CompoundMetric` resources to monitor resources in the remote cluster.
 
 ```yaml
 apiVersion: metrics.cloud.sap/v1beta1

api/v1alpha1/common_types.go

@@ -0,0 +1,21 @@
+package v1alpha1
+
+import "k8s.io/apimachinery/pkg/runtime/schema"
+
+// GroupVersionKind defines the group, version and kind of the object that should be instrumented
+type GroupVersionKind struct {
+	// Define the kind of the object that should be instrumented
+	Kind string `json:"kind,omitempty"`
+	// Define the group of your object that should be instrumented
+	Group string `json:"group,omitempty"`
+	// Define version of the object you want to be instrumented
+	Version string `json:"version,omitempty"`
+}
+
+func (gvk *GroupVersionKind) GVK() schema.GroupVersionKind {
+	return schema.GroupVersionKind{
+		Group:   gvk.Group,
+		Kind:    gvk.Kind,
+		Version: gvk.Version,
+	}
+}

api/v1alpha1/metric_types.go

@@ -36,8 +36,20 @@ const (
 	PhasePending PhaseType = "Pending"
 )
 
-// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
-// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
+// Projection defines the projection of the metric
+type Projection struct {
+	// Define the name of the field that should be extracted
+	Name string `json:"name,omitempty"`
+
+	// Define the path to the field that should be extracted
+	FieldPath string `json:"fieldPath,omitempty"`
+}
+
+// Dimension defines the dimension of the metric
+type Dimension struct {
+	Name  string `json:"name,omitempty"`
+	Value string `json:"value,omitempty"`
+}
 
 // MetricSpec defines the desired state of Metric
 type MetricSpec struct {
@@ -46,12 +58,8 @@ type MetricSpec struct {
 	// Sets the description that will be used to identify the metric in Dynatrace(or other providers)
 	// +optional
 	Description string `json:"description,omitempty"`
-	// Decide which kind the metric should keep track of (needs to be plural version)
-	Kind string `json:"kind,omitempty"`
-	// Define the group of your object that should be instrumented (without version at the end)
-	Group string `json:"group,omitempty"`
-	// Define version of the object you want to intrsument
-	Version string `json:"version,omitempty"`
+	// +kubebuilder:validation:Required
+	Target GroupVersionKind `json:"target,omitempty"`
 	// Define labels of your object to adapt filters of the query
 	// +optional
 	LabelSelector string `json:"labelSelector,omitempty"`
@@ -63,6 +71,8 @@ type MetricSpec struct {
 	CheckInterval metav1.Duration `json:"checkInterval,omitempty"`
 
 	RemoteClusterAccessFacade `json:",inline"`
+
+	Projections []Projection `json:"projections,omitempty"`
 }
 
 // MetricObservation represents the latest available observation of an object's state
@@ -72,6 +82,8 @@ type MetricObservation struct {
 
 	// The latest value of the metric
 	LatestValue string `json:"latestValue,omitempty"`
+
+	Dimensions []Dimension `json:"dimensions,omitempty"`
 }
 
 // GetTimestamp returns the timestamp of the observation
@@ -117,13 +129,11 @@ func (r *Metric) SetConditions(conditions ...metav1.Condition) {
 		meta.SetStatusCondition(&r.Status.Conditions, c)
 	}
 }
-
-// GvkToString returns the GVK of the metric as a string
 func (r *Metric) GvkToString() string {
-	if r.Spec.Group == "" {
-		return fmt.Sprintf("/%s, Kind=%s", r.Spec.Version, r.Spec.Kind)
+	if r.Spec.Target.Group == "" {
+		return fmt.Sprintf("/%s, Kind=%s", r.Spec.Target.Version, r.Spec.Target.Kind)
 	}
-	return fmt.Sprintf("%s/%s, Kind=%s", r.Spec.Group, r.Spec.Version, r.Spec.Kind)
+	return fmt.Sprintf("%s/%s, Kind=%s", r.Spec.Target.Group, r.Spec.Target.Version, r.Spec.Target.Kind)
 }
 
 //+kubebuilder:object:root=true