Add helper variables for sentry name and release.

RADAR-base · Jan 6, 2025 · 2dcd892 · 2dcd892
1 parent a18faea
commit 2dcd892
Show file tree

Hide file tree

Showing 50 changed files with 343 additions and 91 deletions.
diff --git a/charts/app-config/README.md b/charts/app-config/README.md
@@ -85,8 +85,8 @@ A Helm chart for RADAR-base application config (app-config) backend service whic
 | jdbc.dialect | string | `"org.hibernate.dialect.PostgreSQLDialect"` | JDBC dialect to use for JDBC Connection |
 | sentry.dsn | string | `nil` | DSN (Data Source Name) of the sentry server |
 | sentry.level | string | `"ERROR"` | Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR) |
-| sentry.service.name | string | `nil` | Name of the sentry service |
-| sentry.service.release | string | `nil` | App version of the sentry service |
+| sentry.service.name | string | `nil` | Name of the service to be displayed in the sentry dashboard |
+| sentry.service.release | string | `nil` | App version to be displayed in the sentry dashboard |
 | sentry.service.environment | string | `"production"` | Environment of the sentry service |
 | sentry.stacktrace.enabled | bool | `true` | Set to true, if stack trace should be enabled |
-| sentry.stacktrace.packages | string | `""` | Comma-separated list of package prefixes to be included in the stacktrace |
+| sentry.stacktrace.packages | string | `"org.radarbase.appconfig,org.radarbase.lang,comparisons"` | Comma-separated list of package prefixes to be included in the stacktrace |
diff --git a/charts/app-config/templates/_helpers.tpl b/charts/app-config/templates/_helpers.tpl
@@ -84,3 +84,24 @@ Create the name of the service account to use
     {{ default "default" .Values.serviceAccount.name }}
 {{- end -}}
 {{- end -}}
+
+{{/*
+Service name to be used by Sentry
+*/}}
+{{- define "app-config.sentryName" -}}
+{{- if .Values.sentry.service.name }}
+{{- printf "%s" .Values.sentry.service.name -}}
+{{- else -}}
+{{- printf "%s" (include "app-config.fullname" .) -}}{{- end -}}
+{{- end }}
+
+{{/*
+App release to be used by Sentry
+*/}}
+{{- define "app-config.sentryRelease" -}}
+{{- if .Values.sentry.service.release }}
+{{- printf "%s" .Values.sentry.service.release -}}
+{{- else -}}
+{{- printf "%s" .Chart.AppVersion -}}
+{{- end -}}
+{{- end }}
diff --git a/charts/app-config/templates/deployment.yaml b/charts/app-config/templates/deployment.yaml
@@ -90,9 +90,9 @@ spec:
             value: {{ .Values.sentry.stacktrace.packages}}
             {{- end }}
           - name: SENTRY_NAME
-            value: {{ .Values.sentry.service.name }}
+            value:  {{ include "app-config.sentryName" . }}
           - name: SENTRY_RELEASE
-            value: {{ .Values.sentry.service.release }}
+            value:  {{ include "app-config.sentryRelease" . }}
           - name: SENTRY_ENVIRONMENT
             value: {{ .Values.sentry.service.environment }}
           {{- else }}

diff --git a/charts/app-config/values.yaml b/charts/app-config/values.yaml
@@ -206,9 +206,9 @@ sentry:
   # -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
   level: ERROR
   service:
-    # -- Name of the sentry service
+    # -- Name of the service to be displayed in the sentry dashboard
     name:
-    # -- App version of the sentry service
+    # -- App version to be displayed in the sentry dashboard
     release:
     # -- Environment of the sentry service
     environment: production

diff --git a/charts/catalog-server/README.md b/charts/catalog-server/README.md
@@ -98,8 +98,8 @@ A Helm chart for RADAR-base catalogue server. This application creates RADAR-bas
 | cc.schemaRegistryApiSecret | string | `"srApiSecret"` | API secret of the Confluent Cloud based schema registry |
 | sentry.dsn | string | `nil` | DSN (Data Source Name) of the sentry server |
 | sentry.level | string | `"ERROR"` | Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR) |
-| sentry.service.name | string | `nil` | Name of the sentry service |
-| sentry.service.release | string | `nil` | App version of the sentry service |
+| sentry.service.name | string | `nil` | Name of the service to be displayed in the sentry dashboard |
+| sentry.service.release | string | `nil` | App version to be displayed in the sentry dashboard |
 | sentry.service.environment | string | `"production"` | Environment of the sentry service |
 | sentry.stacktrace.enabled | bool | `true` | Set to true, if stack trace should be enabled |
-| sentry.stacktrace.packages | string | `""` | Comma-separated list of package prefixes to be included in the stacktrace |
+| sentry.stacktrace.packages | string | `"org.radarbase.schema,org.radarbase.stream"` | Comma-separated list of package prefixes to be included in the stacktrace |
diff --git a/charts/catalog-server/templates/_helpers.tpl b/charts/catalog-server/templates/_helpers.tpl
@@ -54,3 +54,24 @@ Create chart name and version as used by the chart label.
 {{- define "catalog-server.saslJaasConfig" -}}
 {{- printf "org.apache.kafka.common.security.plain.PlainLoginModule required username='%s' password='%s';" .apiKey .apiSecret | b64enc | quote -}}
 {{- end -}}
+
+{{/*
+Service name to be used by Sentry
+*/}}
+{{- define "catalog-server.sentryName" -}}
+{{- if .Values.sentry.service.name }}
+{{- printf "%s" .Values.sentry.service.name -}}
+{{- else -}}
+{{- printf "%s" (include "catalog-server.fullname" .) -}}{{- end -}}
+{{- end }}
+
+{{/*
+App release to be used by Sentry
+*/}}
+{{- define "catalog-server.sentryRelease" -}}
+{{- if .Values.sentry.service.release }}
+{{- printf "%s" .Values.sentry.service.release -}}
+{{- else -}}
+{{- printf "%s" .Chart.AppVersion -}}
+{{- end -}}
+{{- end }}
diff --git a/charts/catalog-server/templates/deployment.yaml b/charts/catalog-server/templates/deployment.yaml
@@ -96,9 +96,9 @@ spec:
           value: {{ .Values.sentry.stacktrace.packages}}
           {{- end }}
         - name: SENTRY_NAME
-          value: {{ .Values.sentry.service.name }}
+          value: {{ include "catalog-server.sentryName" . }}
         - name: SENTRY_RELEASE
-          value: {{ .Values.sentry.service.release }}
+          value: {{ include "catalog-server.sentryRelease" . }}
         - name: SENTRY_ENVIRONMENT
           value: {{ .Values.sentry.service.environment }}
         {{- else }}
@@ -137,9 +137,9 @@ spec:
             value: {{ .Values.sentry.stacktrace.packages}}
             {{- end }}
           - name: SENTRY_NAME
-            value: {{ .Values.sentry.service.name }}
+            value: {{ include "catalog-server.sentryName" . }}
           - name: SENTRY_RELEASE
-            value: {{ .Values.sentry.service.release }}
+            value: {{ include "catalog-server.sentryRelease" . }}
           - name: SENTRY_ENVIRONMENT
             value: {{ .Values.sentry.service.environment }}
           {{- else }}

diff --git a/charts/catalog-server/values.yaml b/charts/catalog-server/values.yaml
@@ -257,9 +257,9 @@ sentry:
   # -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
   level: ERROR
   service:
-    # -- Name of the sentry service
+    # -- Name of the service to be displayed in the sentry dashboard
     name:
-    # -- App version of the sentry service
+    # -- App version to be displayed in the sentry dashboard
     release:
     # -- Environment of the sentry service
     environment: production

diff --git a/charts/data-dashboard-backend/README.md b/charts/data-dashboard-backend/README.md
@@ -71,8 +71,8 @@ API for data in the data dashboard
 | jdbc.properties."hibernate.physical_naming_strategy" | string | `"org.radarbase.datadashboard.api.domain.model.CamelCaseToUppercaseColumnNamingStrategy"` | Must be _CamelCaseToUppercaseColumnNamingStrategy_ for compatibility with table created by jdbc-connector |
 | sentry.dsn | string | `nil` | DSN (Data Source Name) of the sentry server |
 | sentry.level | string | `"ERROR"` | Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR) |
-| sentry.service.name | string | `nil` | Name of the sentry service |
-| sentry.service.release | string | `nil` | App version of the sentry service |
-| sentry.service.environment | string | `"production"` | Environment of the sentry service |
+| sentry.service.name | string | `nil` | Name of the service to be displayed in the sentry dashboard |
+| sentry.service.release | string | `nil` | App version to be displayed in the sentry dashboard |
+| sentry.service.environment | string | `"production"` | The environment name for this installation. |
 | sentry.stacktrace.enabled | bool | `true` | Set to true, if stack trace should be enabled |
-| sentry.stacktrace.packages | string | `""` | Comma-separated list of package prefixes to be included in the stacktrace |
+| sentry.stacktrace.packages | string | `"org.radarbase.datadashboard,org.radarbase.upload"` | Comma-separated list of package prefixes to be included in the stacktrace |
diff --git a/charts/data-dashboard-backend/templates/_helpers.tpl b/charts/data-dashboard-backend/templates/_helpers.tpl
@@ -71,3 +71,24 @@ Selector labels
 app.kubernetes.io/name: {{ include "data-dashboard-backend.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end }}
+
+{{/*
+Service name to be used by Sentry
+*/}}
+{{- define "data-dashboard-backend.sentryName" -}}
+{{- if .Values.sentry.service.name }}
+{{- printf "%s" .Values.sentry.service.name -}}
+{{- else -}}
+{{- printf "%s" (include "data-dashboard-backend.fullname" .) -}}{{- end -}}
+{{- end }}
+
+{{/*
+App release to be used by Sentry
+*/}}
+{{- define "data-dashboard-backend.sentryRelease" -}}
+{{- if .Values.sentry.service.release }}
+{{- printf "%s" .Values.sentry.service.release -}}
+{{- else -}}
+{{- printf "%s" .Chart.AppVersion -}}
+{{- end -}}
+{{- end }}
diff --git a/charts/data-dashboard-backend/templates/deployment.yaml b/charts/data-dashboard-backend/templates/deployment.yaml
@@ -64,9 +64,9 @@ spec:
             value: {{ .Values.sentry.stacktrace.packages}}
             {{- end }}
           - name: SENTRY_NAME
-            value: {{ .Values.sentry.service.name }}
+            value:  {{ include "data-dashboard-backend.sentryName" . }}
           - name: SENTRY_RELEASE
-            value: {{ .Values.sentry.service.release }}
+            value:  {{ include "data-dashboard-backend.sentryRelease" . }}
           - name: SENTRY_ENVIRONMENT
             value: {{ .Values.sentry.service.environment }}
           {{- else }}

diff --git a/charts/data-dashboard-backend/values.yaml b/charts/data-dashboard-backend/values.yaml
@@ -172,11 +172,11 @@ sentry:
   # -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
   level: ERROR
   service:
-    # -- Name of the sentry service
+    # -- Name of the service to be displayed in the sentry dashboard
     name:
-    # -- App version of the sentry service
+    # -- App version to be displayed in the sentry dashboard
     release:
-    # -- Environment of the sentry service
+    # -- The environment name for this installation.
     environment: production
   stacktrace:
     # -- Set to true, if stack trace should be enabled

diff --git a/charts/management-portal/README.md b/charts/management-portal/README.md
@@ -108,11 +108,11 @@ A Helm chart for RADAR-Base Management Portal to manage projects and participant
 | oauth_clients | object | check `values.yaml` | OAuth2 Client configuration |
 | sentry.dsn | string | `nil` | DSN (Data Source Name) of the sentry server |
 | sentry.level | string | `"ERROR"` | Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR) |
-| sentry.service.name | string | `nil` | Name of the sentry service |
-| sentry.service.release | string | `nil` | App version of the sentry service |
+| sentry.service.name | string | `nil` | Name of the service to be displayed in the sentry dashboard |
+| sentry.service.release | string | `nil` | App version to be displayed in the sentry dashboard |
 | sentry.service.environment | string | `"production"` | Environment of the sentry service |
 | sentry.stacktrace.enabled | bool | `true` | Set to true, if stack trace should be enabled |
-| sentry.stacktrace.packages | string | `""` | Comma-separated list of package prefixes to be included in the stacktrace |
+| sentry.stacktrace.packages | string | `"org.radarbase.management,org.radarbase.auth"` | Comma-separated list of package prefixes to be included in the stacktrace |
 
 ## OAuth Client Configuration
 List of OAuth client configurations supported by RADAR-base. Each client should be enabled separately, if relevant and used in the installation.

diff --git a/charts/management-portal/templates/_helpers.tpl b/charts/management-portal/templates/_helpers.tpl
@@ -72,3 +72,24 @@ Return true if a secret object should be created
     {{- true -}}
 {{- end -}}
 {{- end -}}
+
+{{/*
+Service name to be used by Sentry
+*/}}
+{{- define "management-portal.sentryName" -}}
+{{- if .Values.sentry.service.name }}
+{{- printf "%s" .Values.sentry.service.name -}}
+{{- else -}}
+{{- printf "%s" (include "management-portal.fullname" .) -}}{{- end -}}
+{{- end }}
+
+{{/*
+App release to be used by Sentry
+*/}}
+{{- define "management-portal.sentryRelease" -}}
+{{- if .Values.sentry.service.release }}
+{{- printf "%s" .Values.sentry.service.release -}}
+{{- else -}}
+{{- printf "%s" .Chart.AppVersion -}}
+{{- end -}}
+{{- end }}
diff --git a/charts/management-portal/templates/deployment.yaml b/charts/management-portal/templates/deployment.yaml
@@ -154,9 +154,9 @@ spec:
             value: {{ .Values.sentry.stacktrace.packages}}
             {{- end }}
           - name: SENTRY_NAME
-            value: {{ .Values.sentry.service.name }}
+            value:  {{ include "management-portal.sentryName" . }}
           - name: SENTRY_RELEASE
-            value: {{ .Values.sentry.service.release }}
+            value:  {{ include "management-portal.sentryRelease" . }}
           - name: SENTRY_ENVIRONMENT
             value: {{ .Values.sentry.service.environment }}
           {{- else }}

diff --git a/charts/management-portal/values.yaml b/charts/management-portal/values.yaml
@@ -605,9 +605,9 @@ sentry:
   # -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
   level: ERROR
   service:
-    # -- Name of the sentry service
+    # -- Name of the service to be displayed in the sentry dashboard
     name:
-    # -- App version of the sentry service
+    # -- App version to be displayed in the sentry dashboard
     release:
     # -- Environment of the sentry service
     environment: production

diff --git a/charts/radar-appserver/README.md b/charts/radar-appserver/README.md
@@ -105,8 +105,8 @@ A Helm chart for the backend application of RADAR-base Appserver
 | upload.storage.path.collection_per_day | bool | `false` | if set to true, a new folder will be created for each day |
 | sentry.dsn | string | `nil` | DSN (Data Source Name) of the sentry server |
 | sentry.level | string | `"ERROR"` | Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR) |
-| sentry.service.name | string | `nil` | Name of the sentry service |
-| sentry.service.release | string | `nil` | App version of the sentry service |
+| sentry.service.name | string | `nil` | Name of the service to be displayed in the sentry dashboard |
+| sentry.service.release | string | `nil` | App version to be displayed in the sentry dashboard |
 | sentry.service.environment | string | `"production"` | Environment of the sentry service |
 | sentry.stacktrace.enabled | bool | `true` | Set to true, if stack trace should be enabled |
-| sentry.stacktrace.packages | string | `""` | Comma-separated list of package prefixes to be included in the stacktrace |
+| sentry.stacktrace.packages | string | `"org.radarbase.appserver,org.radarbase.auth,org.radarbase.fcm"` | Comma-separated list of package prefixes to be included in the stacktrace |
diff --git a/charts/radar-appserver/templates/_helpers.tpl b/charts/radar-appserver/templates/_helpers.tpl
@@ -72,3 +72,24 @@ Selector labels
 app.kubernetes.io/name: {{ include "radar-appserver.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end }}
+
+{{/*
+Service name to be used by Sentry
+*/}}
+{{- define "radar-appserver.sentryName" -}}
+{{- if .Values.sentry.service.name }}
+{{- printf "%s" .Values.sentry.service.name -}}
+{{- else -}}
+{{- printf "%s" (include "radar-appserver.fullname" .) -}}{{- end -}}
+{{- end }}
+
+{{/*
+App release to be used by Sentry
+*/}}
+{{- define "radar-appserver.sentryRelease" -}}
+{{- if .Values.sentry.service.release }}
+{{- printf "%s" .Values.sentry.service.release -}}
+{{- else -}}
+{{- printf "%s" .Chart.AppVersion -}}
+{{- end -}}
+{{- end }}
diff --git a/charts/radar-appserver/templates/deployment.yaml b/charts/radar-appserver/templates/deployment.yaml
@@ -151,9 +151,9 @@ spec:
             value: {{ .Values.sentry.stacktrace.packages}}
             {{- end }}
           - name: SENTRY_NAME
-            value: {{ .Values.sentry.service.name }}
+            value:  {{ include "radar-appserver.sentryName" . }}
           - name: SENTRY_RELEASE
-            value: {{ .Values.sentry.service.release }}
+            value:  {{ include "radar-appserver.sentryRelease" . }}
           - name: SENTRY_ENVIRONMENT
             value: {{ .Values.sentry.service.environment }}
           {{- else }}

diff --git a/charts/radar-appserver/values.yaml b/charts/radar-appserver/values.yaml
@@ -267,9 +267,9 @@ sentry:
   # -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
   level: ERROR
   service:
-    # -- Name of the sentry service
+    # -- Name of the service to be displayed in the sentry dashboard
     name:
-    # -- App version of the sentry service
+    # -- App version to be displayed in the sentry dashboard
     release:
     # -- Environment of the sentry service
     environment: production

diff --git a/charts/radar-fitbit-connector/README.md b/charts/radar-fitbit-connector/README.md
@@ -89,8 +89,8 @@ A Helm chart for RADAR-base fitbit connector. This application collects data fro
 | user_cache_refresh_interval_ms | int | `3600000` | How often to invalidate the cache and poll for new user registrations. Only use to speed up processing times during e2e testing. |
 | sentry.dsn | string | `nil` | DSN (Data Source Name) of the sentry server |
 | sentry.level | string | `"ERROR"` | Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR) |
-| sentry.service.name | string | `nil` | Name of the sentry service |
-| sentry.service.release | string | `nil` | App version of the sentry service |
+| sentry.service.name | string | `nil` | Name of the service to be displayed in the sentry dashboard |
+| sentry.service.release | string | `nil` | App version to be displayed in the sentry dashboard |
 | sentry.service.environment | string | `"production"` | Environment of the sentry service |
 | sentry.stacktrace.enabled | bool | `true` | Set to true, if stack trace should be enabled |
-| sentry.stacktrace.packages | string | `""` | Comma-separated list of package prefixes to be included in the stacktrace |
+| sentry.stacktrace.packages | string | `"org.radarbase.connect"` | Comma-separated list of package prefixes to be included in the stacktrace |
diff --git a/charts/radar-fitbit-connector/templates/_helpers.tpl b/charts/radar-fitbit-connector/templates/_helpers.tpl
@@ -50,3 +50,24 @@ Create chart name and version as used by the chart label.
 {{- define "radar-fitbit-connector.chart" -}}
 {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
+
+{{/*
+Service name to be used by Sentry
+*/}}
+{{- define "radar-fitbit-connector.sentryName" -}}
+{{- if .Values.sentry.service.name }}
+{{- printf "%s" .Values.sentry.service.name -}}
+{{- else -}}
+{{- printf "%s" (include "radar-fitbit-connector.fullname" .) -}}{{- end -}}
+{{- end }}
+
+{{/*
+App release to be used by Sentry
+*/}}
+{{- define "radar-fitbit-connector.sentryRelease" -}}
+{{- if .Values.sentry.service.release }}
+{{- printf "%s" .Values.sentry.service.release -}}
+{{- else -}}
+{{- printf "%s" .Chart.AppVersion -}}
+{{- end -}}
+{{- end }}
diff --git a/charts/radar-fitbit-connector/templates/deployment.yaml b/charts/radar-fitbit-connector/templates/deployment.yaml
@@ -111,9 +111,9 @@ spec:
             value: {{ .Values.sentry.stacktrace.packages}}
             {{- end }}
           - name: SENTRY_NAME
-            value: {{ .Values.sentry.service.name }}
+            value:  {{ include "radar-fitbit-connector.sentryName" . }}
           - name: SENTRY_RELEASE
-            value: {{ .Values.sentry.service.release }}
+            value:  {{ include "radar-fitbit-connector.sentryRelease" . }}
           - name: SENTRY_ENVIRONMENT
             value: {{ .Values.sentry.service.environment }}
           {{- else }}

diff --git a/charts/radar-fitbit-connector/values.yaml b/charts/radar-fitbit-connector/values.yaml
@@ -243,9 +243,9 @@ sentry:
   # -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
   level: ERROR
   service:
-    # -- Name of the sentry service
+    # -- Name of the service to be displayed in the sentry dashboard
     name:
-    # -- App version of the sentry service
+    # -- App version to be displayed in the sentry dashboard
     release:
     # -- Environment of the sentry service
     environment: production

diff --git a/charts/radar-gateway/README.md b/charts/radar-gateway/README.md
@@ -95,8 +95,8 @@ A Helm chart for RADAR-base gateway. REST Gateway to Kafka, for incoming partici
 | serverName | string | `"localhost"` | Resolvable server name, needed to find the advertised URL and callback URL |
 | sentry.dsn | string | `nil` | DSN (Data Source Name) of the sentry server |
 | sentry.level | string | `"ERROR"` | Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR) |
-| sentry.service.name | string | `nil` | Name of the sentry service |
-| sentry.service.release | string | `nil` | App version of the sentry service |
+| sentry.service.name | string | `nil` | Name of the service to be displayed in the sentry dashboard |
+| sentry.service.release | string | `nil` | App version to be displayed in the sentry dashboard |
 | sentry.service.environment | string | `"production"` | Environment of the sentry service |
 | sentry.stacktrace.enabled | bool | `true` | Set to true, if stack trace should be enabled |
-| sentry.stacktrace.packages | string | `""` | Comma-separated list of package prefixes to be included in the stacktrace |
+| sentry.stacktrace.packages | string | `"org.radarbase.gateway,org.apache.avro"` | Comma-separated list of package prefixes to be included in the stacktrace |