Merge pull request #313 from RADAR-base/feature/gateway-sentry-config…

…uration

Update radar-gateway helm chart for Sentry config.

charts/radar-gateway/Chart.yaml

@@ -1,8 +1,8 @@
 apiVersion: v2
-appVersion: "0.7.7"
+appVersion: "0.8.0"
 description: A Helm chart for RADAR-base gateway. REST Gateway to Kafka, for incoming participant data. It performs authentication, authorization, content validation and decompression. For more details of the configurations, see https://github.com/RADAR-base/RADAR-Gateway/blob/master/gateway.yml.
 name: radar-gateway
-version: 1.3.0
+version: 1.4.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/radar-gateway

charts/radar-gateway/README.md

@@ -3,7 +3,7 @@
 # radar-gateway
 [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/radar-gateway)](https://artifacthub.io/packages/helm/radar-base/radar-gateway)
 
-![Version: 1.3.0](https://img.shields.io/badge/Version-1.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.7.7](https://img.shields.io/badge/AppVersion-0.7.7-informational?style=flat-square)
+![Version: 1.4.0](https://img.shields.io/badge/Version-1.4.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.8.0](https://img.shields.io/badge/AppVersion-0.8.0-informational?style=flat-square)
 
 A Helm chart for RADAR-base gateway. REST Gateway to Kafka, for incoming participant data. It performs authentication, authorization, content validation and decompression. For more details of the configurations, see https://github.com/RADAR-base/RADAR-Gateway/blob/master/gateway.yml.
 
@@ -101,3 +101,10 @@ A Helm chart for RADAR-base gateway. REST Gateway to Kafka, for incoming partici
 | public_key_endpoints_enabled | bool | `false` | Enables config of public key endpoints for token verification This config option is implemented to fix a compatibility issue with radar-gateway. It can be removed when the publicKeyUrls config option is merged to master. |
 | public_key_endpoints | list | `[]` | List of public key endpoints for token verification |
 | 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 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 |

charts/radar-gateway/templates/deployment.yaml

@@ -69,6 +69,27 @@ spec:
           env:
           - name: JAVA_OPTS
             value: "-XX:GCTimeRatio=19 -XX:MinHeapFreeRatio=20 -XX:MaxHeapFreeRatio=30 --add-opens java.base/java.io=ALL-UNNAMED --add-opens java.management/javax.management.openmbean=ALL-UNNAMED --add-opens java.base/java.lang.reflect=ALL-UNNAMED --add-opens java.management/javax.management=ALL-UNNAMED -Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager"
+          {{- 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 | default (include "radar-gateway.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 }}
+          {{- else }}
+          - name: SENTRY_ENABLED
+            value: "false"
+          {{- end }}
           {{- with .Values.extraEnvVars }}
             {{- toYaml . | nindent 10 }}
           {{- end }}

charts/radar-gateway/values.yaml

@@ -250,3 +250,22 @@ public_key_endpoints: []
 
 # -- Resolvable server name, needed to find the advertised URL and callback URL
 serverName: localhost
+
+# 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"