Repository navigation
feat: rename the hyperdx values key to clickstack - #311
Conversation
🦋 Changeset detectedLatest commit: 1a32754 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Helm template coverage
Uncovered detailscharts/clickstack/templates/NOTES.txtUncovered lines: none Uncovered branches: 38:default:fallback charts/clickstack/templates/_helpers.tplUncovered lines: 17 Uncovered branches: 163:range:empty, 165:range:empty, 16:if:true, 203:and(2):false, 234:or(1):true, 287:default:fallback, 297:default:fallback, 298:or(1):true, 314:if:false, 444:range:empty, 465:range:empty, 46:range:empty charts/clickstack/templates/additional-manifests.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/clickhouse/cluster.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/clickhouse/keeper.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/hyperdx/configmap.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/hyperdx/cronjob-check-alerts.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/hyperdx/dashboard-configmap.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/hyperdx/dashboard-provisioner-rbac.yamlUncovered lines: none Uncovered branches: 41:range:empty, 61:range:empty charts/clickstack/templates/hyperdx/deployment.yamlUncovered lines: none Uncovered branches: 122:default:fallback, 132:default:fallback, 197:default:fallback, 202:with:empty, 21:with:empty, 27:default:fallback, 42:if:false, 43:with:empty charts/clickstack/templates/hyperdx/hpa.yamlUncovered lines: none Uncovered branches: 17:with:empty charts/clickstack/templates/hyperdx/ingress.yamlUncovered lines: none Uncovered branches: 16:with:empty, 36:if:false, 41:range:empty, 46:range:empty, 49:with:empty, 55:range:empty, 59:range:empty, 60:or(2):true, 60:or(3):true charts/clickstack/templates/hyperdx/networkpolicy.yamlUncovered lines: none Uncovered branches: 12:with:empty charts/clickstack/templates/hyperdx/pdb.yamlUncovered lines: none Uncovered branches: 11:with:empty charts/clickstack/templates/hyperdx/secret.yamlUncovered lines: none Uncovered branches: 2:or(2):true, 2:or(3):true charts/clickstack/templates/hyperdx/service.yamlUncovered lines: none Uncovered branches: 10:with:empty, 15:default:fallback charts/clickstack/templates/hyperdx/serviceaccount.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/mongodb/community.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/mongodb/password-secret.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/otel-collector/custom-config.yamlUncovered lines: none Uncovered branches: none |
Deep ReviewScope: 81 files vs base ✅ No critical issues found. The core merge logic in
🟡 P2 — recommended
🔵 P3 nitpicks (2)
Reviewers (7): correctness, adversarial, testing, maintainability, project-standards, api-contract, previous-comments. Testing gaps: complete-render assertion for the legacy-only ( No finding blocks merge automatically. A maintainer will expect P0/P1 findings in code this PR changes to be fixed; P2/P3 are your call -- fix or reply. Never fix findings about surrounding code here; reply instead. Do not widen the PR. |
# Conflicts: # .changeset/browser-telemetry-endpoint.md # .changeset/usage-stats-old-key.md # AGENTS.md # charts/clickstack/README.md # charts/clickstack/templates/hyperdx/configmap.yaml # charts/clickstack/templates/hyperdx/pdb.yaml # charts/clickstack/tests/otel-collector_test.yaml # charts/clickstack/values.yaml
# Conflicts: # charts/clickstack/README.md
Renames the chart's top-level
hyperdxvalues key toclickstack, matching the chart's name. Values that still usehyperdxkeep working: the chart merges them in and prints a deprecation warning in the install notes.Key decisions
hyperdxwins where both keys set the same value. Makingclickstackwin would mean comparing every value against the shipped defaults inside the templates.templates/hyperdx/and theclickstack.hyperdx.*helpers stay as they are, so an upgrade renames nothing in the cluster.helm templateand Argo CD users won't see it; the upgrade guide covers them.Backwards compatibility
--set hyperdx.*flags render the same manifests as main. Checked for the examples and integration values under Helm 4.3 and 3.19.nullunderhyperdxstill removes the default, sohyperdx.secrets: nullkeeps skipping the Secret..Values.hyperdx.*still resolve.helm upgrade --reuse-valuesfrom 3.5.0 renders the same as before. Moving settings toclickstackin that upgrade needs-f, because the storedhyperdxvalues win; the upgrade guide and the warning say so.Other impact
use hyperdx.*. Its checks still catch the 1.x keys, but whichever PR lands second should switch the hints toclickstack.*.{{- include "clickstack.normalizeValues" . -}}. AGENTS.md says so; nothing enforces it.Implementation detail
clickstack.normalizeValuesruns once per render. It overlays a user-sethyperdxmap ontoclickstack(maps merge, lists and scalars replace, a null deletes), then points.Values.hyperdxat the result and recordshyperdxKeyUsedfor NOTES. Under--reuse-valuesfrom an older releaseclickstackis absent, so it starts from an empty map and the storedhyperdxvalues supply everything.Existing tests moved to
clickstack. New tests cover the legacy key overriding defaults, precedence, top-level and nested nulls, tpl aliasing, the--reuse-valuesshape (clickstack: null), and the warning. The 1.xhyperdx.usageStatsEnabledcheck keeps its legacy name. Coverage is 99.86% line and 91.67% branch.