feat(charts/simple-workflow): Add enabledMetrics field (#250)

Nextdoor · Dec 3, 2023 · a9637aa · a9637aa
1 parent 464bd6d
commit a9637aa
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/charts/simple-workflow/Chart.yaml b/charts/simple-workflow/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: simple-workflow
 description: Default Argo Workflow Helm Chart
 type: application
-version: 0.0.12
+version: 0.0.13
 appVersion: latest
 maintainers:
   - name: masterginger

diff --git a/charts/simple-workflow/README.md b/charts/simple-workflow/README.md
@@ -2,7 +2,7 @@
 
 Default Argo Workflow Helm Chart
 
-![Version: 0.0.12](https://img.shields.io/badge/Version-0.0.12-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
+![Version: 0.0.13](https://img.shields.io/badge/Version-0.0.13-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
 
 ## Values
 
@@ -17,6 +17,8 @@ Default Argo Workflow Helm Chart
 | kmsSecretsRegion | String | `nil` | AWS region where the KMS key is located |
 | secrets | `Map` | `{}` | Map of environment variables to plaintext secrets or KMS encrypted secrets. |
 | secretsEngine | String | `"plaintext"` | Secrets Engine determines the type of Secret Resource that will be created (`KMSSecret`, `Secret`). kms || plaintext are possible values. |
+| workflow.enabledMetrics | `bool` | `false` | If true, argo workflow will emit metrics |
+| workflow.metrics | `map` | `{}` | custom prometheus metrics emited by Argo Workflow |
 | workflow.retryLimit | Integer | `1` | The number of retries when a step fails. |
 | workflow.serviceAccount.name | String | `"workflow-service-account"` | Service Account name used by workflow |
 

diff --git a/charts/simple-workflow/templates/workflow-pipeline.yaml b/charts/simple-workflow/templates/workflow-pipeline.yaml
@@ -24,6 +24,12 @@ spec:
     {{- end }}
   {{- end }}
   entrypoint: deployment-pipeline
+  {{- if .Values.workflow.enabledMetrics }}
+  {{- with $.Values.workflow.metrics }}
+  metrics:
+    {{- tpl (toYaml .) $ | nindent 4 }}
+  {{- end }}
+  {{- end }}
   {{- if .Values.workflow.onExit }}
   onExit: exit-handler
   {{- end }}

diff --git a/charts/simple-workflow/values.yaml b/charts/simple-workflow/values.yaml
@@ -28,6 +28,12 @@ workflow:
   #   secondsAfterSuccess: 5     # Time to live after workflow is successful
   #   secondsAfterFailure: 5     # Time to live after workflow fails
 
+  # -- (`bool`) If true, argo workflow will emit metrics
+  enabledMetrics: false
+
+  # -- (`map`) custom prometheus metrics emited by Argo Workflow
+  metrics: {}
+
 # -- (`Map`) Map of environment variables to plaintext secrets or KMS encrypted secrets.
 secrets: {}