sentry configuration for helm charts

charts/app-config/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: "0.5.2"
 description: A Helm chart for RADAR-base application config (app-config) backend service which is used as mobile app configuration engine with per-project and per-user configuration.
 name: app-config
-version: 1.6.0
+version: 1.7.0
 icon: "http://radar-base.org/wp-content/uploads/2022/09/Logo_RADAR-Base-RGB.png"
 sources:
 - https://github.com/RADAR-base/radar-helm-charts/tree/main/charts/app-config

charts/app-config/README.md

@@ -3,7 +3,7 @@
 # app-config
 [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/app-config)](https://artifacthub.io/packages/helm/radar-base/app-config)
 
-![Version: 1.6.0](https://img.shields.io/badge/Version-1.6.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.2](https://img.shields.io/badge/AppVersion-0.5.2-informational?style=flat-square)
+![Version: 1.7.0](https://img.shields.io/badge/Version-1.7.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.2](https://img.shields.io/badge/AppVersion-0.5.2-informational?style=flat-square)
 
 A Helm chart for RADAR-base application config (app-config) backend service which is used as mobile app configuration engine with per-project and per-user configuration.
 
@@ -100,3 +100,16 @@ A Helm chart for RADAR-base application config (app-config) backend service whic
 | jdbc.parameters | string | `nil` | Additional JDBC connection parameters e.g. sslmode=verify-full Ignored when using 'urlSecret'. |
 | jdbc.driver | string | `"org.postgresql.Driver"` | JDBC Driver to connect to the database. |
 | jdbc.dialect | string | `"org.hibernate.dialect.PostgreSQLDialect"` |  |
+| 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 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 | `"org.radarbase.gateway,org.apache.avro"` | Comma-separated list of package prefixes to be included in the stacktrace |
+| openTelemetry.agent.enabled | bool | `false` | Enable OpenTelemetry agent (currently only Sentry agent is supported) |
+| openTelemetry.agent.agentJar | string | `"sentry-opentelemetry-agent-8.1.0.jar"` | OpenTelemetry Sentry agent jar file name, depends on version of 'io.sentry:sentry-opentelemetry-agent' |
+| openTelemetry.exporter.tracesSampleRate | float | `1` | Sample rate for traces (0.0 to 1.0) |
+| openTelemetry.exporter.metricsExporterEnabled | bool | `false` | Enable OpenTelemetry metrics exporter other than Sentry |
+| openTelemetry.exporter.tracesExporterEnabled | bool | `false` | Enable OpenTelemetry traces exporter other than Sentry |
+| openTelemetry.exporter.logsExporterEnabled | bool | `true` | Enable OpenTelemetry logs exporter other than Sentry |

charts/app-config/templates/deployment.yaml

@@ -82,6 +82,46 @@ 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_ATTACHSTACKTRACE
+            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 | default (include "app-config.fullname" .) }}
+          - name: SENTRY_RELEASE
+            value: {{ .Values.sentry.service.release | default (printf "%s-%s" .Chart.Version .Chart.AppVersion) }}
+          - name: SENTRY_ENVIRONMENT
+            value: {{ .Values.sentry.service.environment }}
+            {{- if .Values.openTelemetry.agent.enabled }}
+          - name: SENTRY_TRACES_SAMPLE_RATE
+            value: {{ .Values.openTelemetry.exporter.tracesSampleRate | quote }}
+              {{- if not .Values.openTelemetry.exporter.metricsExporterEnabled }}
+          - name: OTEL_METRICS_EXPORTER
+            value: none
+              {{- end }}
+              {{- if not .Values.openTelemetry.exporter.tracesExporterEnabled }}
+          - name: OTEL_TRACES_EXPORTER
+            value: none
+              {{- end }}
+              {{- if not .Values.openTelemetry.exporter.logsExporterEnabled }}
+          - name: OTEL_LOGS_EXPORTER
+            value: none
+              {{- end }}
+            {{- end }}
+          {{- else }}
+          - name: SENTRY_ENABLED
+            value: "false"
+          {{- end }}
+          {{- with .Values.extraEnvVars }}
+            {{- toYaml . | nindent 10 }}
+          {{- end }}
           volumeMounts:
           - name: config
             mountPath: /etc/radar-app-config/

charts/app-config/values.yaml

@@ -241,3 +241,39 @@ jdbc:
   # -- JDBC Driver to connect to the database.
   driver: org.postgresql.Driver
   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 service to be displayed in the sentry dashboard
+    name:
+    # -- App version to be displayed in the sentry dashboard
+    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: "org.radarbase.gateway,org.apache.avro"
+
+# OpenTelemetry monitoring configuration
+openTelemetry:
+  agent:
+    # -- Enable OpenTelemetry agent (currently only Sentry agent is supported)
+    enabled: false
+    # -- OpenTelemetry Sentry agent jar file name, depends on version of 'io.sentry:sentry-opentelemetry-agent'
+    agentJar: sentry-opentelemetry-agent-8.1.0.jar
+  exporter:
+    # -- Sample rate for traces (0.0 to 1.0)
+    tracesSampleRate: 1.0
+    # -- Enable OpenTelemetry metrics exporter other than Sentry
+    metricsExporterEnabled: false
+    # -- Enable OpenTelemetry traces exporter other than Sentry
+    tracesExporterEnabled: false
+    # -- Enable OpenTelemetry logs exporter other than Sentry
+    logsExporterEnabled: true

charts/catalog-server/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: "0.8.11"
 description: A Helm chart for RADAR-base catalogue server. This application creates RADAR-base topics in Kafka, registers schemas in Schema Registry and keeps a catalog of available source types.
 name: catalog-server
-version: 0.8.0
+version: 0.9.0
 icon: "http://radar-base.org/wp-content/uploads/2022/09/Logo_RADAR-Base-RGB.png"
 sources:
 - https://github.com/RADAR-base/radar-helm-charts/tree/main/charts/catalog-server

charts/catalog-server/README.md

@@ -3,7 +3,7 @@
 # catalog-server
 [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/catalog-server)](https://artifacthub.io/packages/helm/radar-base/catalog-server)
 
-![Version: 0.8.0](https://img.shields.io/badge/Version-0.8.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.8.11](https://img.shields.io/badge/AppVersion-0.8.11-informational?style=flat-square)
+![Version: 0.9.0](https://img.shields.io/badge/Version-0.9.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.8.11](https://img.shields.io/badge/AppVersion-0.8.11-informational?style=flat-square)
 
 A Helm chart for RADAR-base catalogue server. This application creates RADAR-base topics in Kafka, registers schemas in Schema Registry and keeps a catalog of available source types.
 
@@ -110,3 +110,16 @@ 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 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 | `"org.radarbase.gateway,org.apache.avro"` | Comma-separated list of package prefixes to be included in the stacktrace |
+| openTelemetry.agent.enabled | bool | `false` | Enable OpenTelemetry agent (currently only Sentry agent is supported) |
+| openTelemetry.agent.agentJar | string | `"sentry-opentelemetry-agent-8.1.0.jar"` | OpenTelemetry Sentry agent jar file name, depends on version of 'io.sentry:sentry-opentelemetry-agent' |
+| openTelemetry.exporter.tracesSampleRate | float | `1` | Sample rate for traces (0.0 to 1.0) |
+| openTelemetry.exporter.metricsExporterEnabled | bool | `false` | Enable OpenTelemetry metrics exporter other than Sentry |
+| openTelemetry.exporter.tracesExporterEnabled | bool | `false` | Enable OpenTelemetry traces exporter other than Sentry |
+| openTelemetry.exporter.logsExporterEnabled | bool | `true` | Enable OpenTelemetry logs exporter other than Sentry |

charts/catalog-server/templates/deployment.yaml

@@ -85,6 +85,46 @@ spec:
         {{- with .Values.extraEnvVarsInit }}
           {{- toYaml . | nindent 8 }}
         {{- 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_ATTACHSTACKTRACE
+          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 | default (include "catalog-server.fullname" .) }}
+        - name: SENTRY_RELEASE
+          value: {{ .Values.sentry.service.release | default (printf "%s-%s" .Chart.Version .Chart.AppVersion) }}
+        - name: SENTRY_ENVIRONMENT
+          value: {{ .Values.sentry.service.environment }}
+          {{- if .Values.openTelemetry.agent.enabled }}
+        - name: SENTRY_TRACES_SAMPLE_RATE
+          value: {{ .Values.openTelemetry.exporter.tracesSampleRate | quote }}
+            {{- if not .Values.openTelemetry.exporter.metricsExporterEnabled }}
+        - name: OTEL_METRICS_EXPORTER
+          value: none
+            {{- end }}
+            {{- if not .Values.openTelemetry.exporter.tracesExporterEnabled }}
+        - name: OTEL_TRACES_EXPORTER
+          value: none
+            {{- end }}
+            {{- if not .Values.openTelemetry.exporter.logsExporterEnabled }}
+        - name: OTEL_LOGS_EXPORTER
+          value: none
+            {{- end }}
+          {{- end }}
+        {{- else }}
+        - name: SENTRY_ENABLED
+          value: "false"
+        {{- end }}
+        {{- with .Values.extraEnvVars }}
+          {{- toYaml . | nindent 10 }}
+        {{- end }}
         volumeMounts:
           - name: config
             mountPath: /etc/radar-schemas-tools

charts/catalog-server/values.yaml

@@ -274,3 +274,39 @@ 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 service to be displayed in the sentry dashboard
+    name:
+    # -- App version to be displayed in the sentry dashboard
+    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: "org.radarbase.gateway,org.apache.avro"
+
+# OpenTelemetry monitoring configuration
+openTelemetry:
+  agent:
+    # -- Enable OpenTelemetry agent (currently only Sentry agent is supported)
+    enabled: false
+    # -- OpenTelemetry Sentry agent jar file name, depends on version of 'io.sentry:sentry-opentelemetry-agent'
+    agentJar: sentry-opentelemetry-agent-8.1.0.jar
+  exporter:
+    # -- Sample rate for traces (0.0 to 1.0)
+    tracesSampleRate: 1.0
+    # -- Enable OpenTelemetry metrics exporter other than Sentry
+    metricsExporterEnabled: false
+    # -- Enable OpenTelemetry traces exporter other than Sentry
+    tracesExporterEnabled: false
+    # -- Enable OpenTelemetry logs exporter other than Sentry
+    logsExporterEnabled: true

charts/management-portal/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: "2.1.8"
 description: A Helm chart for RADAR-Base Management Portal to manage projects and participants throughout RADAR-base.
 name: management-portal
-version: 1.6.0
+version: 1.7.0
 icon: "http://radar-base.org/wp-content/uploads/2022/09/Logo_RADAR-Base-RGB.png"
 sources:
 - https://github.com/RADAR-base/radar-helm-charts/tree/main/charts/management-portal

charts/management-portal/README.md

@@ -3,7 +3,7 @@
 # management-portal
 [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/management-portal)](https://artifacthub.io/packages/helm/radar-base/management-portal)
 
-![Version: 1.6.0](https://img.shields.io/badge/Version-1.6.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.1.8](https://img.shields.io/badge/AppVersion-2.1.8-informational?style=flat-square)
+![Version: 1.7.0](https://img.shields.io/badge/Version-1.7.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.1.8](https://img.shields.io/badge/AppVersion-2.1.8-informational?style=flat-square)
 
 A Helm chart for RADAR-Base Management Portal to manage projects and participants throughout RADAR-base.
 
@@ -124,6 +124,19 @@ 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 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 | `"org.radarbase.gateway,org.apache.avro"` | Comma-separated list of package prefixes to be included in the stacktrace |
+| openTelemetry.agent.enabled | bool | `false` | Enable OpenTelemetry agent (currently only Sentry agent is supported) |
+| openTelemetry.agent.agentJar | string | `"sentry-opentelemetry-agent-8.1.0.jar"` | OpenTelemetry Sentry agent jar file name, depends on version of 'io.sentry:sentry-opentelemetry-agent' |
+| openTelemetry.exporter.tracesSampleRate | float | `1` | Sample rate for traces (0.0 to 1.0) |
+| openTelemetry.exporter.metricsExporterEnabled | bool | `false` | Enable OpenTelemetry metrics exporter other than Sentry |
+| openTelemetry.exporter.tracesExporterEnabled | bool | `false` | Enable OpenTelemetry traces exporter other than Sentry |
+| openTelemetry.exporter.logsExporterEnabled | bool | `true` | Enable OpenTelemetry logs exporter other than Sentry |
 
 ## 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.

charts/management-portal/templates/deployment.yaml

@@ -149,6 +149,46 @@ 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_ATTACHSTACKTRACE
+            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 | default (include "management-portal.fullname" .) }}
+          - name: SENTRY_RELEASE
+            value: {{ .Values.sentry.service.release | default (printf "%s-%s" .Chart.Version .Chart.AppVersion) }}
+          - name: SENTRY_ENVIRONMENT
+            value: {{ .Values.sentry.service.environment }}
+            {{- if .Values.openTelemetry.agent.enabled }}
+          - name: SENTRY_TRACES_SAMPLE_RATE
+            value: {{ .Values.openTelemetry.exporter.tracesSampleRate | quote }}
+              {{- if not .Values.openTelemetry.exporter.metricsExporterEnabled }}
+          - name: OTEL_METRICS_EXPORTER
+            value: none
+              {{- end }}
+              {{- if not .Values.openTelemetry.exporter.tracesExporterEnabled }}
+          - name: OTEL_TRACES_EXPORTER
+            value: none
+              {{- end }}
+              {{- if not .Values.openTelemetry.exporter.logsExporterEnabled }}
+          - name: OTEL_LOGS_EXPORTER
+            value: none
+              {{- end }}
+            {{- end }}
+          {{- else }}
+          - name: SENTRY_ENABLED
+            value: "false"
+          {{- end }}
+          {{- with .Values.extraEnvVars }}
+            {{- toYaml . | nindent 10 }}
+          {{- end }}
           ports:
             - name: http
               containerPort: 8080