RFC Observability

Signed-off-by: R-Lawton <[email protected]>
Kuadrant · Jul 25, 2024 · afbb0c4 · afbb0c4
1 parent 3b91376
commit afbb0c4
Showing 1 changed file with 24 additions and 15 deletions.
diff --git a/rfcs/0000-observability-api.md b/rfcs/0000-observability-api.md
@@ -25,11 +25,11 @@ The different aspects a user might want to modify could be the following:
 
 | Observability piece   | Kuadrant component                                        | Options                                                                                                                       |
 |-----------------------|-----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
-| Logging               | Kuadrant operator, Authorino operator, Limitador Operator | **component** (string), **logLevel**: (string) **logMode**: (string)                                                          |
-| Tracing               | Authorino operator, Limitador operator                    | **component** (string), **endpoint** (string), **tags** (map[string]string) , **insecure**(bool), **strageyRules** ([]String) |
-| Metrics               | Kuadrant operator, Authorino, Limitador, DNS Operator     | **component** (string), **enableService** (bool), **port** (int32), **deep** (bool)                                           |
-| Alerts *              | Kuadrant operator, Authorino, Limitador                   | **namespace** (string), **component**(string), **enable** bool                                                                |
-| Dashboards *          | Kuadrant operator, Authorino, Limitador                   | **namespace** (string), **component**(string), **enable** bool                                                                |
+| Logging               | Kuadrant operator, Authorino operator, Limitador Operator | **component**  **logLevel**:  **logMode**:                                                           |
+| Tracing               | Authorino operator, Limitador operator                    | **component** , **endpoint** , **tags**  , **insecure**, **strageyRules**  |
+| Metrics               | Kuadrant operator, Authorino, Limitador, DNS Operator     | **component** , **enableService** , **port** , **deep**                                            |
+| Alerts *              | Kuadrant operator, Authorino, Limitador                   | **namespace** , **component**, **enable**                                                                 |
+| Dashboards *          | Kuadrant operator, Authorino, Limitador                   | **namespace** , **component**, **enable**                                                                 |
 | Other 3rd Party *     | e.g Kiali                                                 | **enable** bool                                                                                                               |
 
 ###### **Note**: Observability pieces with a * denotes these are post v1 milestone
@@ -99,6 +99,7 @@ spec:
 
     alerts:
       namespace: my-amazing-namespace
+      component:
         authorino:
           operator-level: true
           component-level: true
@@ -112,6 +113,7 @@ spec:
 
     dashboards:
       namespace: my-amazing-namespace
+      component:
         authorino:
           operator-level: true
           component-level: true
@@ -124,24 +126,31 @@ spec:
 
 ```
 ### Sample use case
-A use case a user might have would be they desire setting up tracing in the  Limitador operator implementing the required endpoints and optional tag. The user also wants metrics setup with custom ports and requires service and serviceMonitors to be created for Kuadrant-operator and Authorino-operator as well as have the limitador have a log level of Debug but just for Authorino.
+A use case a user might have would be they desire setting up tracing in the Limitador operator implementing the required endpoints and optional tag. The user also wants metrics setup with custom ports and requires service and serviceMonitors to be created for Kuadrant-operator and Authorino-operator as well as have the Authorino have a log level of Debug.
 
 ```yaml 
 
 apiVersion: kuadrant.io/v1alpha1
 kind: Observability
 spec:
-  logging:
-    authorino: debug
   tracing:  
-    limitador:
-        endpoint: rpc://tempo.tempo.svc.cluster.local:4317
-        tags: tag1, tag2
+    component:
+      limitador:
+          endpoint: rpc://tempo.tempo.svc.cluster.local:4317
+          tags: tag1, tag2
   metrics: 
-    authorino: 
-      enableService: true
-      port: 8084
-      deep: true   
+    component:
+      authorino: 
+        enableService: true
+        port: 8084
+        deep: true 
+      kuadrant:   
+        enableService: true
+        port: 8084 
+  logging:
+    component:
+      authorino: 
+        logLevel: debug      
 ```
 ### Status
 The status of the Observability CR will not be the observability stack is in a "healthy" state i.e Prometheus and Grafana is up and running. It should be the status of only the things that we contribute for example is new Logging and Tracing now in place or is the console plugin responding. We will not be taking responsibility for aspects we don't have control over.