Event reporters sensors - logging and retries (#94)

* add logging and retries to event reporters sensors

Author: ilia-medvedev-codefresh

charts/gitops-runtime/Chart.yaml

@@ -14,13 +14,10 @@ maintainers:
 annotations:
   artifacthub.io/alternativeName: "codefresh-gitops-runtime"
   artifacthub.io/changes: |
-    - kind: changed
-      description: Update app-proxy
-    - kind: changed
-      description: Update codefresh-gitops-operator.
-      links:
-        - name: GitHub Release
-          url: https://github.com/codefresh-io/codefresh-gitops-operator/releases/tag/v0.1.0-alpha.4
+    - kind: added
+      description: Added possibility to enable logging on event reporter sensors
+    - kind: added
+      description: Added retries on event reporters sensors
 dependencies:
 - name: argo-cd
   repository: https://codefresh-io.github.io/argo-helm

charts/gitops-runtime/README.md

@@ -155,9 +155,16 @@ sealed-secrets:
 | event-reporters.events.eventSource.resources | object | `{}` |  |
 | event-reporters.events.eventSource.tolerations | list | `[]` |  |
 | event-reporters.events.sensor.affinity | object | `{}` |  |
+| event-reporters.events.sensor.env | object | `{}` | Environment variables for sensor pods - add DEBUG_LOG: "true" to add debug level logs |
+| event-reporters.events.sensor.logging | object | `{"enabled":false,"intervalSeconds":0}` | Set to true to enable logging. Set intervalSeconds to add logging interval to moderate log flow. |
 | event-reporters.events.sensor.nodeSelector | object | `{}` |  |
 | event-reporters.events.sensor.replicas | int | `1` |  |
 | event-reporters.events.sensor.resources | object | `{}` |  |
+| event-reporters.events.sensor.retryStrategy | object | `{"duration":0,"factor":1,"jitter":1,"steps":3}` | Retry strategy for events sent to Codefresh |
+| event-reporters.events.sensor.retryStrategy.duration | int | `0` | The initial duration, use strings like "2s", "1m" |
+| event-reporters.events.sensor.retryStrategy.factor | float | `1` | Duration is multiplied by factor each retry, if factor is not zero and steps limit has not been reached. Should not be negative |
+| event-reporters.events.sensor.retryStrategy.jitter | int | `1` | The sleep between each retry is the duration plus an additional amount chosen uniformly at random from the interval between zero and `jitter * duration`. |
+| event-reporters.events.sensor.retryStrategy.steps | int | `3` | Number of retries |
 | event-reporters.events.sensor.tolerations | list | `[]` |  |
 | event-reporters.events.serviceAccount.create | bool | `true` |  |
 | event-reporters.rollout.eventSource.affinity | object | `{}` |  |
@@ -166,9 +173,16 @@ sealed-secrets:
 | event-reporters.rollout.eventSource.resources | object | `{}` |  |
 | event-reporters.rollout.eventSource.tolerations | list | `[]` |  |
 | event-reporters.rollout.sensor.affinity | object | `{}` |  |
+| event-reporters.rollout.sensor.env | object | `{}` | Environment variables for sensor pods - add DEBUG_LOG: "true" to add debug level logs |
+| event-reporters.rollout.sensor.logging | object | `{"enabled":false,"intervalSeconds":0}` | Set to true to enable logging. Set intervalSeconds to add logging interval to moderate log flow. |
 | event-reporters.rollout.sensor.nodeSelector | object | `{}` |  |
 | event-reporters.rollout.sensor.replicas | int | `1` |  |
 | event-reporters.rollout.sensor.resources | object | `{}` |  |
+| event-reporters.rollout.sensor.retryStrategy | object | `{"duration":0,"factor":1,"jitter":1,"steps":3}` | Retry strategy for events sent to Codefresh |
+| event-reporters.rollout.sensor.retryStrategy.duration | int | `0` | The initial duration, use strings like "2s", "1m" |
+| event-reporters.rollout.sensor.retryStrategy.factor | float | `1` | Duration is multiplied by factor each retry, if factor is not zero and steps limit has not been reached. Should not be negative |
+| event-reporters.rollout.sensor.retryStrategy.jitter | int | `1` | The sleep between each retry is the duration plus an additional amount chosen uniformly at random from the interval between zero and `jitter * duration`. |
+| event-reporters.rollout.sensor.retryStrategy.steps | int | `3` | Number of retries |
 | event-reporters.rollout.sensor.tolerations | list | `[]` |  |
 | event-reporters.rollout.serviceAccount.create | bool | `true` |  |
 | event-reporters.workflow.eventSource.affinity | object | `{}` |  |
@@ -177,9 +191,16 @@ sealed-secrets:
 | event-reporters.workflow.eventSource.resources | object | `{}` |  |
 | event-reporters.workflow.eventSource.tolerations | list | `[]` |  |
 | event-reporters.workflow.sensor.affinity | object | `{}` |  |
+| event-reporters.workflow.sensor.env | object | `{}` | Environment variables for sensor pods - add DEBUG_LOG: "true" to add debug level logs |
+| event-reporters.workflow.sensor.logging | object | `{"enabled":false,"intervalSeconds":0}` | Set to true to enable logging. Set intervalSeconds to add logging interval to moderate log flow. |
 | event-reporters.workflow.sensor.nodeSelector | object | `{}` |  |
 | event-reporters.workflow.sensor.replicas | int | `1` |  |
 | event-reporters.workflow.sensor.resources | object | `{}` |  |
+| event-reporters.workflow.sensor.retryStrategy | object | `{"duration":0,"factor":1,"jitter":1,"steps":3}` | Retry strategy for events sent to Codefresh |
+| event-reporters.workflow.sensor.retryStrategy.duration | int | `0` | The initial duration, use strings like "2s", "1m" |
+| event-reporters.workflow.sensor.retryStrategy.factor | float | `1` | Duration is multiplied by factor each retry, if factor is not zero and steps limit has not been reached. Should not be negative |
+| event-reporters.workflow.sensor.retryStrategy.jitter | int | `1` | The sleep between each retry is the duration plus an additional amount chosen uniformly at random from the interval between zero and `jitter * duration`. |
+| event-reporters.workflow.sensor.retryStrategy.steps | int | `3` | Number of retries |
 | event-reporters.workflow.sensor.tolerations | list | `[]` |  |
 | event-reporters.workflow.serviceAccount.create | bool | `true` |  |
 | gitops-operator.affinity | object | `{}` |  |

charts/gitops-runtime/templates/_components/event-reporters/_helpers.tpl

@@ -177,4 +177,22 @@ assumes the name, condition and payload.dependencyName are identical
         src:
           dataKey: body
           dependencyName: {{ .name }}
+  {{- if .retryStrategy }}
+  retryStrategy:
+  {{- .retryStrategy | toYaml | nindent 4 }}
+  {{- end }}
 {{- end -}}
+
+{{/* Logging trigger for the sensor - gets sensor.logging dict */}}
+{{- define "event-reporters.log.trigger" -}}
+  {{- if .enabled }}
+- template:
+    name: log-trigger
+    {{- if gt (int .intervalSeconds) 0 }}
+    log:
+      intervalSeconds: {{ .intervalSeconds }}
+    {{- else }}
+    log: {}
+    {{- end }}
+  {{- end }}
+{{- end }}

charts/gitops-runtime/templates/_components/event-reporters/events-reporter/_sensor.yaml

@@ -15,6 +15,7 @@ spec:
   template:
     serviceAccountName: {{ include "event-reporters.events-reporter.serviceAccountName" .}}
     container:
+      {{- include "codefresh-gitops-runtime.components.common_helpers.container-templates.env-vars" .Values.events.sensor.env  | nindent 6 }}
       resources:
       {{- with .Values.events.sensor.resources  }}
         {{- . | toYaml | nindent 8 }}
@@ -32,5 +33,6 @@ spec:
       {{- . | toYaml | nindent 6 }}
     {{- end }}
   triggers:
-    {{- include "event-reporters.http.trigger" (dict "name" "events" "Values" .Values "payloadDest" "data") | nindent 4 }}
+    {{- include "event-reporters.http.trigger" (dict "name" "events" "Values" .Values "payloadDest" "data" "retryStrategy" .Values.events.sensor.retryStrategy) | nindent 4 }}
+    {{- include "event-reporters.log.trigger" (.Values.events.sensor.logging) | nindent 4 }}
 {{- end }}

charts/gitops-runtime/templates/_components/event-reporters/rollout-reporter/_sensor.yaml

@@ -22,24 +22,26 @@ spec:
     serviceAccountName: {{ include "event-reporters.rollout-reporter.serviceAccountName" .}}
     container:
       name: ""
+      {{- include "codefresh-gitops-runtime.components.common_helpers.container-templates.env-vars" .Values.rollout.sensor.env  | nindent 6 }}
       resources:
-      {{- with .Values.rollout.eventSource.resources  }}
+      {{- with .Values.rollout.sensor.resources  }}
         {{- . | toYaml | nindent 8 }}
       {{- end }}
     tolerations:
-    {{- with .Values.rollout.eventSource.tolerations }}
+    {{- with .Values.rollout.sensor.tolerations }}
       {{- . | toYaml | nindent 6 }}
     {{- end }}
     nodeSelector:
-    {{- with .Values.rollout.eventSource.nodeSelector }}
+    {{- with .Values.rollout.sensor.nodeSelector }}
       {{- . | toYaml | nindent 6 }}
     {{- end }}
     affinity:
-    {{- with .Values.rollout.eventSource.affinity }}
+    {{- with .Values.rollout.sensor.affinity }}
       {{- . | toYaml | nindent 6 }}
     {{- end }}
   triggers:
-  {{- include "event-reporters.http.trigger" (dict "name" "rollouts" "Values" .Values "payloadDest" "data.object") | nindent 4 }}
-  {{- include "event-reporters.http.trigger" (dict "name" "replicasets" "Values" .Values "payloadDest" "data.object") | nindent 4 }}
-  {{- include "event-reporters.http.trigger" (dict "name" "analysisruns" "Values" .Values "payloadDest" "data.object") | nindent 4 }}
+  {{- include "event-reporters.http.trigger" (dict "name" "rollouts" "Values" .Values "payloadDest" "data.object" "retryStrategy" .Values.rollout.sensor.retryStrategy) | nindent 4 }}
+  {{- include "event-reporters.http.trigger" (dict "name" "replicasets" "Values" .Values "payloadDest" "data.object" "retryStrategy" .Values.rollout.sensor.retryStrategy) | nindent 4 }}
+  {{- include "event-reporters.http.trigger" (dict "name" "analysisruns" "Values" .Values "payloadDest" "data.object" "retryStrategy" .Values.rollout.sensor.retryStrategy) | nindent 4 }}
+  {{- include "event-reporters.log.trigger" (.Values.rollout.sensor.logging) | nindent 4 }}
 {{- end }}

charts/gitops-runtime/templates/_components/event-reporters/workflow-reporter/_sensor.yaml

@@ -16,6 +16,7 @@ spec:
     serviceAccountName: {{ include "event-reporters.workflow-reporter.serviceAccountName" .}}
     container:
       name: ""
+      {{- include "codefresh-gitops-runtime.components.common_helpers.container-templates.env-vars" .Values.workflow.sensor.env  | nindent 6 }}
       resources:
       {{- with .Values.workflow.sensor.resources  }}
         {{- . | toYaml | nindent 8 }}
@@ -33,5 +34,6 @@ spec:
       {{- . | toYaml | nindent 6 }}
     {{- end }}
   triggers:
-  {{- include "event-reporters.http.trigger" (dict "name" "workflows" "Values" .Values "payloadDest" "data.object") | nindent 4 }}
+  {{- include "event-reporters.http.trigger" (dict "name" "workflows" "Values" .Values "payloadDest" "data.object" "retryStrategy" .Values.workflow.sensor.retryStrategy) | nindent 4 }}
+  {{- include "event-reporters.log.trigger" (.Values.workflow.sensor.logging) | nindent 4 }}
 {{- end }}