Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update helm charts for Sentry configuration #311

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ewelinagr
Copy link
Collaborator

Implements RB-152

Some of the components have been enhanced with Sentry monitoring. This PR:

  • Updates the helm charts to accept the Sentry-specific helm values
  • Maps those helm values to ENV VARS

@ewelinagr ewelinagr requested a review from pvannierop January 6, 2025 15:08
Copy link

github-actions bot commented Jan 6, 2025

Great PR! Please pay attention to the following items before merging:

Files matching charts/*/values.yaml:

  • Is the PR adding a new container? Please reviewer, add it to the models (internal process)
  • Is the PR adding a new parameter? Please, ensure it’s documented in the README.md

This is an automatically generated QA checklist based on modified files.

@ewelinagr ewelinagr force-pushed the feature/sentry-configuration branch from c520c7a to 2dcd892 Compare January 6, 2025 15:16
*/}}
{{- define "app-config.sentryName" -}}
{{- if .Values.sentry.service.name }}
{{- printf "%s" .Values.sentry.service.name -}}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please explain why these should be configurable?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those two don't need to be configurable, I made it that way just to give more flexibility in how the service names are displayed in Sentry as an extra option. I can remove that, if this is problematic or just not needed.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not problematic and in general it's good to have the flexibility. However this adds a bit of complexity to the charts and since I haven't used the Sentry interface I don't know how much benefit this brings. You can decide on this.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, thanks for clarification, I removed the conditional values for now.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I think in this case we can use existing chart variables such as {{ include "catalog-server.name" . }}, {{ include "catalog-server.chart" . }}, {{ .Release.Name }}, {{ .Release.Service }} instead of creating new functions in _helpers.tpl.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pvannierop, before I change something here, could you double-check if this is what you had in mind for those 2 variables (sentryName, sentryRelease), or you think it is better to use a different combination of variables for sentryName, e.g. instead of the fullName defined above, fix it to some string containing .Chart.Name .Chart.Version or .Release.Name

@ewelinagr ewelinagr force-pushed the feature/sentry-configuration branch from 2dcd892 to 7562af7 Compare January 9, 2025 13:33
@ewelinagr ewelinagr requested a review from keyvaann January 9, 2025 13:34
Copy link
Collaborator

@pvannierop pvannierop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Nice work! One small thing is that would it be more efficient to replace package definitions like:

    packages: "org.radarbase.oura,org.radarbase.connect"

to more simple

    packages: "org.radarbase"

? So to basically trace from org.radarbase.*?

# -- 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.appconfig,org.radarbase.lang,comparisons"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this package string correct? The comparisons part looks strange to me.

Copy link
Collaborator Author

@ewelinagr ewelinagr Jan 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes,this is the one that is packaged under comparisons:
radar-expression-lang/src/main/kotlin/comparisons/Library.kt
If not needed, I can remove it

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ewelinagr Did you perhaps miss this comment?

@ewelinagr
Copy link
Collaborator Author

Looks good. Nice work! One small thing is that would it be more efficient to replace package definitions like:

    packages: "org.radarbase.oura,org.radarbase.connect"

to more simple

    packages: "org.radarbase"

? So to basically trace from org.radarbase.*?

Yes, it could be simplified to org.radarabase, if we want to be more generic and always include all with that prefix

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants