Update helm charts for Sentry configuration.

RADAR-base · Jan 6, 2025 · 8bea345 · 8bea345
1 parent 9bac983
commit 8bea345
Show file tree

Hide file tree

Showing 38 changed files with 588 additions and 2 deletions.
diff --git a/charts/app-config/README.md b/charts/app-config/README.md
@@ -83,3 +83,10 @@ A Helm chart for RADAR-base application config (app-config) backend service whic
 | jdbc.user | string | `"postgres"` | Username of the database |
 | jdbc.password | string | `"password"` | Password of the user |
 | 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.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 |
diff --git a/charts/app-config/templates/deployment.yaml b/charts/app-config/templates/deployment.yaml
@@ -78,6 +78,27 @@ spec:
               secretKeyRef:
                 name: {{ template "app-config.secretName" . }}
                 key: databasePassword
+          {{- if .Values.sentry.dsn }}
+          - name: SENTRY_DSN
+            value: {{ .Values.sentry.dsn }}
+          - name: SENTRY_LOG_LEVEL
+            value: {{ .Values.sentry.level }}
+            {{- if .Values.sentry.stacktrace.enabled }}
+          - name: SENTRY_ATTACH_STACKTRACE
+            value: {{ .Values.sentry.stacktrace.enabled | quote }}
+          - name: SENTRY_STACKTRACE_APP_PACKAGES
+            value: {{ .Values.sentry.stacktrace.packages}}
+            {{- end }}
+          - name: SENTRY_NAME
+            value: {{ .Values.sentry.service.name }}
+          - name: SENTRY_RELEASE
+            value: {{ .Values.sentry.service.release }}
+          - name: SENTRY_ENVIRONMENT
+            value: {{ .Values.sentry.service.environment }}
+          {{- else }}
+          - name: SENTRY_ENABLED
+            value: "false"
+          {{- end }}
           {{- with .Values.extraEnvVars }}
             {{- toYaml . | nindent 10 }}
           {{- end }}

diff --git a/charts/app-config/values.yaml b/charts/app-config/values.yaml
@@ -198,3 +198,22 @@ jdbc:
   password: password
   # -- JDBC dialect to use for JDBC Connection
   dialect: org.hibernate.dialect.PostgreSQLDialect
+
+# Sentry monitoring configuration
+sentry:
+  # -- DSN (Data Source Name) of the sentry server
+  dsn:
+  # -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
+  level: ERROR
+  service:
+    # -- Name of the sentry service
+    name:
+    # -- App version of the sentry service
+    release:
+    # -- Environment of the sentry service
+    environment: production
+  stacktrace:
+    # -- Set to true, if stack trace should be enabled
+    enabled: true
+    # -- Comma-separated list of package prefixes to be included in the stacktrace
+    packages: ""
diff --git a/charts/catalog-server/README.md b/charts/catalog-server/README.md
@@ -96,3 +96,10 @@ A Helm chart for RADAR-base catalogue server. This application creates RADAR-bas
 | cc.apiSecret | string | `"ccApiSecret"` | API secret of the Confluent Cloud based kafka cluster |
 | cc.schemaRegistryApiKey | string | `"srApiKey"` | API key of the Confluent Cloud based schema registry |
 | 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.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 |
diff --git a/charts/catalog-server/templates/deployment.yaml b/charts/catalog-server/templates/deployment.yaml
@@ -84,6 +84,27 @@ spec:
               name: {{ template "catalog-server.fullname" . }}
               key: srApiSecret
         {{- end }}
+        {{- if .Values.sentry.dsn }}
+        - name: SENTRY_DSN
+          value: {{ .Values.sentry.dsn }}
+        - name: SENTRY_LOG_LEVEL
+          value: {{ .Values.sentry.level }}
+          {{- if .Values.sentry.stacktrace.enabled }}
+        - name: SENTRY_ATTACH_STACKTRACE
+          value: {{ .Values.sentry.stacktrace.packages | quote }}
+        - name: SENTRY_STACKTRACE_APP_PACKAGES
+          value: {{ .Values.sentry.stacktrace.packages}}
+          {{- end }}
+        - name: SENTRY_NAME
+          value: {{ .Values.sentry.service.name }}
+        - name: SENTRY_RELEASE
+          value: {{ .Values.sentry.service.release }}
+        - name: SENTRY_ENVIRONMENT
+          value: {{ .Values.sentry.service.environment }}
+        {{- else }}
+        - name: SENTRY_ENABLED
+          value: "false"
+        {{- end }}
         {{- with .Values.extraEnvVarsInit }}
           {{- toYaml . | nindent 8 }}
         {{- end }}
@@ -103,6 +124,28 @@ spec:
             - /etc/radar-schemas-tools/config.yaml
             - /schema/merged
           imagePullPolicy: {{ .Values.image.pullPolicy }}
+          env:
+          {{- if .Values.sentry.dsn }}
+          - name: SENTRY_DSN
+            value: {{ .Values.sentry.dsn }}
+          - name: SENTRY_LOG_LEVEL
+            value: {{ .Values.sentry.level }}
+            {{- if .Values.sentry.stacktrace.enabled }}
+          - name: SENTRY_ATTACH_STACKTRACE
+            value: {{ .Values.sentry.stacktrace.enabled | quote }}
+          - name: SENTRY_STACKTRACE_APP_PACKAGES
+            value: {{ .Values.sentry.stacktrace.packages}}
+            {{- end }}
+          - name: SENTRY_NAME
+            value: {{ .Values.sentry.service.name }}
+          - name: SENTRY_RELEASE
+            value: {{ .Values.sentry.service.release }}
+          - name: SENTRY_ENVIRONMENT
+            value: {{ .Values.sentry.service.environment }}
+          {{- else }}
+          - name: SENTRY_ENABLED
+            value: "false"
+          {{- end }}
           ports:
             - name: http
               containerPort: 9010

diff --git a/charts/catalog-server/values.yaml b/charts/catalog-server/values.yaml
@@ -249,3 +249,22 @@ cc:
   schemaRegistryApiKey: srApiKey
   # -- API secret of the Confluent Cloud based schema registry
   schemaRegistryApiSecret: srApiSecret
+
+# Sentry monitoring configuration
+sentry:
+  # -- DSN (Data Source Name) of the sentry server
+  dsn:
+  # -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
+  level: ERROR
+  service:
+    # -- Name of the sentry service
+    name:
+    # -- App version of the sentry service
+    release:
+    # -- Environment of the sentry service
+    environment: production
+  stacktrace:
+    # -- Set to true, if stack trace should be enabled
+    enabled: true
+    # -- Comma-separated list of package prefixes to be included in the stacktrace
+    packages: ""
diff --git a/charts/data-dashboard-backend/README.md b/charts/data-dashboard-backend/README.md
@@ -69,3 +69,10 @@ API for data in the data dashboard
 | jdbc.dialect | string | `"org.hibernate.dialect.PostgreSQLDialect"` | Hibernate dialect to use for JDBC Connection |
 | jdbc.properties."hibernate.globally_quoted_identifiers" | bool | `true` | Must be _true_ for compatibility with table created by jdbc-connector |
 | 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.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 |
diff --git a/charts/data-dashboard-backend/templates/deployment.yaml b/charts/data-dashboard-backend/templates/deployment.yaml
@@ -52,6 +52,27 @@ spec:
               secretKeyRef:
                 name: {{ template "data-dashboard-backend.secretName" . }}
                 key: databasePassword
+          {{- if .Values.sentry.dsn }}
+          - name: SENTRY_DSN
+            value: {{ .Values.sentry.dsn }}
+          - name: SENTRY_LOG_LEVEL
+            value: {{ .Values.sentry.level }}
+            {{- if .Values.sentry.stacktrace.enabled }}
+          - name: SENTRY_ATTACH_STACKTRACE
+            value: {{ .Values.sentry.stacktrace.enabled | quote }}
+          - name: SENTRY_STACKTRACE_APP_PACKAGES
+            value: {{ .Values.sentry.stacktrace.packages}}
+            {{- end }}
+          - name: SENTRY_NAME
+            value: {{ .Values.sentry.service.name }}
+          - name: SENTRY_RELEASE
+            value: {{ .Values.sentry.service.release }}
+          - name: SENTRY_ENVIRONMENT
+            value: {{ .Values.sentry.service.environment }}
+          {{- else }}
+          - name: SENTRY_ENABLED
+            value: "false"
+          {{- end }}
           ports:
             - name: http
               containerPort: 9000

diff --git a/charts/data-dashboard-backend/values.yaml b/charts/data-dashboard-backend/values.yaml
@@ -164,3 +164,22 @@ jdbc:
     hibernate.globally_quoted_identifiers: true
     # -- Must be _CamelCaseToUppercaseColumnNamingStrategy_ for compatibility with table created by jdbc-connector
     hibernate.physical_naming_strategy: org.radarbase.datadashboard.api.domain.model.CamelCaseToUppercaseColumnNamingStrategy
+
+# Sentry monitoring configuration
+sentry:
+  # -- DSN (Data Source Name) of the sentry server
+  dsn:
+  # -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
+  level: ERROR
+  service:
+    # -- Name of the sentry service
+    name:
+    # -- App version of the sentry service
+    release:
+    # -- Environment of the sentry service
+    environment: production
+  stacktrace:
+    # -- Set to true, if stack trace should be enabled
+    enabled: true
+    # -- Comma-separated list of package prefixes to be included in the stacktrace
+    packages: ""
diff --git a/charts/management-portal/README.md b/charts/management-portal/README.md
@@ -106,6 +106,13 @@ A Helm chart for RADAR-Base Management Portal to manage projects and participant
 | smtp.starttls | bool | `false` | set to true,if ttls should be enabled |
 | smtp.auth | bool | `true` | set to true, if the account should be authenticated before sending emails |
 | 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.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 |
 
 ## 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/deployment.yaml b/charts/management-portal/templates/deployment.yaml
@@ -142,6 +142,27 @@ spec:
           {{- with .Values.extraEnvVars }}
             {{- toYaml . | nindent 10 }}
           {{- end }}
+          {{- if .Values.sentry.dsn }}
+          - name: SENTRY_DSN
+            value: {{ .Values.sentry.dsn }}
+          - name: SENTRY_LOG_LEVEL
+            value: {{ .Values.sentry.level }}
+            {{- if .Values.sentry.stacktrace.enabled }}
+          - name: SENTRY_ATTACH_STACKTRACE
+            value: {{ .Values.sentry.stacktrace.enabled | quote }}
+          - name: SENTRY_STACKTRACE_APP_PACKAGES
+            value: {{ .Values.sentry.stacktrace.packages}}
+            {{- end }}
+          - name: SENTRY_NAME
+            value: {{ .Values.sentry.service.name }}
+          - name: SENTRY_RELEASE
+            value: {{ .Values.sentry.service.release }}
+          - name: SENTRY_ENVIRONMENT
+            value: {{ .Values.sentry.service.environment }}
+          {{- else }}
+          - name: SENTRY_ENABLED
+            value: "false"
+          {{- end }}
           ports:
             - name: http
               containerPort: 8080

diff --git a/charts/management-portal/values.yaml b/charts/management-portal/values.yaml
@@ -597,3 +597,22 @@ oauth_clients:
     authorized_grant_types:
       - client_credentials
     access_token_validity: 900
+
+# Sentry monitoring configuration
+sentry:
+  # -- DSN (Data Source Name) of the sentry server
+  dsn:
+  # -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
+  level: ERROR
+  service:
+    # -- Name of the sentry service
+    name:
+    # -- App version of the sentry service
+    release:
+    # -- Environment of the sentry service
+    environment: production
+  stacktrace:
+    # -- Set to true, if stack trace should be enabled
+    enabled: true
+    # -- Comma-separated list of package prefixes to be included in the stacktrace
+    packages: ""
diff --git a/charts/radar-appserver/README.md b/charts/radar-appserver/README.md
@@ -103,3 +103,10 @@ A Helm chart for the backend application of RADAR-base Appserver
 | upload.storage.secret_key | string | `"secret"` | Secret key of the S3 storage |
 | upload.storage.path.prefix | string | `"output"` | Prefix for the path in the storage; will become <bucket>/<prefix>/<project>/<subject>/<topic> |
 | 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.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 |
diff --git a/charts/radar-appserver/templates/deployment.yaml b/charts/radar-appserver/templates/deployment.yaml
@@ -139,6 +139,27 @@ spec:
                 key: s3SecretKey
             {{- end }}
           {{- end }}
+          {{- if .Values.sentry.dsn }}
+          - name: SENTRY_DSN
+            value: {{ .Values.sentry.dsn }}
+          - name: SENTRY_LOG_LEVEL
+            value: {{ .Values.sentry.level }}
+            {{- if .Values.sentry.stacktrace.enabled }}
+          - name: SENTRY_ATTACH_STACKTRACE
+            value: {{ .Values.sentry.stacktrace.enabled | quote }}
+          - name: SENTRY_STACKTRACE_APP_PACKAGES
+            value: {{ .Values.sentry.stacktrace.packages}}
+            {{- end }}
+          - name: SENTRY_NAME
+            value: {{ .Values.sentry.service.name }}
+          - name: SENTRY_RELEASE
+            value: {{ .Values.sentry.service.release }}
+          - name: SENTRY_ENVIRONMENT
+            value: {{ .Values.sentry.service.environment }}
+          {{- else }}
+          - name: SENTRY_ENABLED
+            value: "false"
+          {{- end }}
           {{- with .Values.extraEnvVars }}
             {{- toYaml . | nindent 10 }}
           {{- end }}

diff --git a/charts/radar-appserver/values.yaml b/charts/radar-appserver/values.yaml
@@ -259,3 +259,22 @@ upload:
       prefix: output
       # -- if set to true, a new folder will be created for each day
       collection_per_day: false
+
+# Sentry monitoring configuration
+sentry:
+  # -- DSN (Data Source Name) of the sentry server
+  dsn:
+  # -- Log level for sentry (TRACE, DEBUG, INFO, WARN, or ERROR)
+  level: ERROR
+  service:
+    # -- Name of the sentry service
+    name:
+    # -- App version of the sentry service
+    release:
+    # -- Environment of the sentry service
+    environment: production
+  stacktrace:
+    # -- Set to true, if stack trace should be enabled
+    enabled: true
+    # -- Comma-separated list of package prefixes to be included in the stacktrace
+    packages: ""
diff --git a/charts/radar-fitbit-connector/README.md b/charts/radar-fitbit-connector/README.md
@@ -87,3 +87,10 @@ A Helm chart for RADAR-base fitbit connector. This application collects data fro
 | fitbit_user_poll_interval | int | `5000` | Polling interval per Fitbit user per request route in seconds. Only use to speed up processing times during e2e testing. |
 | application_loop_interval_ms | int | `300000` | How often to perform the main application loop (only controls how often to poll for new user registrations). Only use to speed up processing times during e2e testing. |
 | 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.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 |
diff --git a/charts/radar-fitbit-connector/templates/deployment.yaml b/charts/radar-fitbit-connector/templates/deployment.yaml
@@ -99,6 +99,27 @@ spec:
           {{- with .Values.extraEnvVars }}
             {{- toYaml . | nindent 10 }}
           {{- end }}
+          {{- if .Values.sentry.dsn }}
+          - name: SENTRY_DSN
+            value: {{ .Values.sentry.dsn }}
+          - name: SENTRY_LOG_LEVEL
+            value: {{ .Values.sentry.level }}
+            {{- if .Values.sentry.stacktrace.enabled }}
+          - name: SENTRY_ATTACH_STACKTRACE
+            value: {{ .Values.sentry.stacktrace.enabled | quote }}
+          - name: SENTRY_STACKTRACE_APP_PACKAGES
+            value: {{ .Values.sentry.stacktrace.packages}}
+            {{- end }}
+          - name: SENTRY_NAME
+            value: {{ .Values.sentry.service.name }}
+          - name: SENTRY_RELEASE
+            value: {{ .Values.sentry.service.release }}
+          - name: SENTRY_ENVIRONMENT
+            value: {{ .Values.sentry.service.environment }}
+          {{- else }}
+          - name: SENTRY_ENABLED
+            value: "false"
+          {{- end }}
           ports:
             - name: http
               containerPort: 80