Skip to content

pintoinc/hyperdx-helm

Repository files navigation

HyperDX

HyperDX helps engineers figure out why production is broken faster by centralizing and correlating logs, metrics, traces, exceptions and session replays in one place. An open source and developer-friendly alternative to Datadog and New Relic.

  • 🕵️ Correlate end to end, go from browser session replay to logs and traces in just a few clicks
  • 🔥 Blazing fast performance powered by Clickhouse
  • 🔍 Intuitive full-text search and property search syntax (ex. level:err)
  • 🤖 Automatically cluster event patterns from billions of events
  • 📈 Dashboard high cardinality events without a complex query language
  • 🔔 Set up alerts in just a few clicks
  • { Automatic JSON/structured log parsing
  • 🔭 OpenTelemetry native

Prerequisites

  • Kubernetes 1.23+
  • Helm 3.8.0+
  • Persistent volume provisioner support in the underlying infrastructure

Deployment

This chart is still in development and requires a few involved steps. If you wish to deploy Hyperdx on a k8s cluster to be used outside of a local dev setup, you will need to build a custom docker image for the Dashboard.

FYI
  • For the installation to be useful outside of a local playground, the user needs to build their own image because the dashboard code reads the build time envs but the envs are only available during runtime on the server side in the pod. (TODO: fix this in dashboard so the same image can be used for any environments)
  • The current latest release is ghcr.io/hyperdxio/hyperdx:1.10.0-app and is built with
     PORT=8080
     SERVER_URL=localhost:8000
     OTEL_EXPORTER_OTLP_ENDPOINT=localhost:4317
    
    therefore this image only works locally in a dev environment IF AND ONLY IF the api, collector, and dashboard are all port-forwarded with the corresponding ports. If you wish to do this, then running helm dependency build && helm install hyperdx . -n hyperdx --set kong.enabled=false and following the console instructions thereafter is sufficient
  • An API gateway is required to host the api, collector, and dashboard on the same domain in order to not get CORS issues since the dashboard app directly makes requests from the browser client to the api and collector without going through nextjs server side.
From the root directory of the project run
DOMAIN=https://hyperdx.mydomain.com
IMAGE_REGISTRY=docker.io
IMAGE_REPO=myuniquereponame/hyperdx
IMAGE_TAG=1.10.0-app
docker build \
  --build-arg CODE_VERSION=1.10.0 \
  --build-arg OTEL_EXPORTER_OTLP_ENDPOINT=$DOMAIN/collector \
  --build-arg OTEL_SERVICE_NAME="hdx-oss-app" \
  --build-arg PORT=8080 \
  --build-arg SERVER_URL=$DOMAIN/api/v1/ \
  . -f ./packages/app/Dockerfile -t $IMAGE_REGISTRY/$IMAGE_REPO:$IMAGE_TAG \
  --target prod --platform linux/amd64 --push
helm dependency build
helm upgrade --install hyperdx . --namespace hyperdx --create-namespace \
  --set publicUrl=$DOMAIN \
  --set app.image.registry=$IMAGE_REGISTRY \
  --set app.image.repository=$IMAGE_REPO \
  --set app.image.tag=$IMAGE_TAG

Parameters

Global parameters

Name Description Value
global.imageRegistry Global Docker image registry ""
global.imagePullSecrets Global Docker registry secret names as an array []
global.storageClass Global StorageClass for Persistent Volume(s) ""

Common parameters

Name Description Value
kubeVersion Override Kubernetes version ""
nameOverride String to partially override common.names.name ""
fullnameOverride String to fully override common.names.fullname ""
namespaceOverride String to fully override common.names.namespace ""
commonLabels Labels to add to all deployed objects {}
commonAnnotations Annotations to add to all deployed objects {}
clusterDomain Kubernetes cluster domain name cluster.local
extraDeploy Array of extra objects to deploy with the release []
diagnosticMode.enabled Enable diagnostic mode (all probes will be disabled and the command will be overridden) false
diagnosticMode.command Command to override all containers in the deployment ["sleep"]
diagnosticMode.args Args to override all containers in the deployment ["infinity"]

Hyperdx Common parameters

Name Description Value
apiKey the Hyperdx api key. TODO: If not specified, use the ingestion api key for self-instrumentation. ""
logLevel the logging level across all Hyperdx pipeline components. Allowed values: error, warn, info, http, verbose, debug, silly info
publicUrl Type A DNS record that points to the the LoadBalancer service of the API gateway (Kong) ""

Hyperdx dashboard app Parameters

Name Description Value
app.enabled Enable hyperdx dashboard app true
app.replicaCount Number of Hyperdx app replicas to deploy 1
app.defaultConfig Hyperdx app default configuration ""
app.extraConfig Hyperdx app extra configuration {}
app.existingConfigmap The name of an existing ConfigMap with the default configuration ""
app.extraConfigExistingConfigmap The name of an existing ConfigMap with extra configuration ""
app.image.registry app image registry ghcr.io
app.image.repository app image repository hyperdxio/hyperdx
app.image.digest app image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended) ""
app.image.pullPolicy app image pull policy IfNotPresent
app.image.pullSecrets app image pull secrets []
app.containerPorts.http Hyperdx dashboard app HTTP container port 8080
app.livenessProbe.enabled Enable livenessProbe on Hyperdx app containers true
app.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 5
app.livenessProbe.periodSeconds Period seconds for livenessProbe 10
app.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
app.livenessProbe.failureThreshold Failure threshold for livenessProbe 6
app.livenessProbe.successThreshold Success threshold for livenessProbe 1
app.readinessProbe.enabled Enable readinessProbe on Hyperdx app containers true
app.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 5
app.readinessProbe.periodSeconds Period seconds for readinessProbe 10
app.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 5
app.readinessProbe.failureThreshold Failure threshold for readinessProbe 6
app.readinessProbe.successThreshold Success threshold for readinessProbe 1
app.startupProbe.enabled Enable startupProbe on Hyperdx app containers false
app.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 5
app.startupProbe.periodSeconds Period seconds for startupProbe 10
app.startupProbe.timeoutSeconds Timeout seconds for startupProbe 5
app.startupProbe.failureThreshold Failure threshold for startupProbe 6
app.startupProbe.successThreshold Success threshold for startupProbe 1
app.customLivenessProbe Custom livenessProbe that overrides the default one {}
app.customReadinessProbe Custom readinessProbe that overrides the default one {}
app.customStartupProbe Custom startupProbe that overrides the default one {}
app.resources.limits The resources limits for the Hyperdx app containers {}
app.resources.requests The requested resources for the Hyperdx app containers {}
app.podSecurityContext.enabled Enabled Hyperdx app pods' Security Context true
app.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy Always
app.podSecurityContext.sysctls Set kernel settings using the sysctl interface []
app.podSecurityContext.supplementalGroups Set filesystem extra groups []
app.podSecurityContext.fsGroup Set Hyperdx app pod's Security Context fsGroup 1001
app.containerSecurityContext.enabled Enabled containers' Security Context true
app.containerSecurityContext.seLinuxOptions Set SELinux options in container nil
app.containerSecurityContext.runAsUser Set containers' Security Context runAsUser 1001
app.containerSecurityContext.runAsNonRoot Set container's Security Context runAsNonRoot true
app.containerSecurityContext.privileged Set container's Security Context privileged false
app.containerSecurityContext.readOnlyRootFilesystem Set container's Security Context readOnlyRootFilesystem false
app.containerSecurityContext.allowPrivilegeEscalation Set container's Security Context allowPrivilegeEscalation false
app.containerSecurityContext.capabilities.drop List of capabilities to be dropped ["ALL"]
app.containerSecurityContext.seccompProfile.type Set container's Security Context seccomp profile RuntimeDefault
app.command Override default container command (useful when using custom images) []
app.args Override default container args (useful when using custom images) []
app.automountServiceAccountToken Mount Service Account token in pod false
app.hostAliases Hyperdx app pods host aliases []
app.podLabels Extra labels for Hyperdx app pods {}
app.podAnnotations Annotations for Hyperdx app pods {}
app.podAffinityPreset Pod affinity preset. Ignored if app.affinity is set. Allowed values: soft or hard ""
app.podAntiAffinityPreset Pod anti-affinity preset. Ignored if app.affinity is set. Allowed values: soft or hard soft
app.nodeAffinityPreset.type Node affinity preset type. Ignored if app.affinity is set. Allowed values: soft or hard ""
app.nodeAffinityPreset.key Node label key to match. Ignored if app.affinity is set ""
app.nodeAffinityPreset.values Node label values to match. Ignored if app.affinity is set []
app.affinity Affinity for Hyperdx app pods assignment {}
app.nodeSelector Node labels for Hyperdx app pods assignment {}
app.tolerations Tolerations for Hyperdx app pods assignment []
app.updateStrategy.type Hyperdx app statefulset strategy type RollingUpdate
app.priorityClassName Hyperdx app pods' priorityClassName ""
app.topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template []
app.schedulerName Name of the k8s scheduler (other than default) for Hyperdx app pods ""
app.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully ""
app.lifecycleHooks for the Hyperdx app container(s) to automate configuration before or after startup {}
app.extraEnvVars Array with extra environment variables to add to Hyperdx app nodes []
app.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Hyperdx app nodes ""
app.extraEnvVarsSecret Name of existing Secret containing extra env vars for Hyperdx app nodes ""
app.extraVolumes Optionally specify extra list of additional volumes for the Hyperdx app pod(s) []
app.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Hyperdx app container(s) []
app.sidecars Add additional sidecar containers to the Hyperdx app pod(s) []
app.initContainers Add additional init containers to the Hyperdx app pod(s) []

Hyperdx app Traffic Exposure Parameters

Name Description Value
app.service.type Hyperdx app service type ClusterIP
app.service.ports.http Hyperdx app service HTTP port 80
app.service.nodePorts.http Node port for HTTP ""
app.service.clusterIP Hyperdx app service Cluster IP ""
app.service.loadBalancerIP Hyperdx app service Load Balancer IP ""
app.service.loadBalancerSourceRanges Hyperdx app service Load Balancer sources []
app.service.externalTrafficPolicy Hyperdx app service external traffic policy Cluster
app.service.annotations Additional custom annotations for Hyperdx app service {}
app.service.extraPorts Extra ports to expose in Hyperdx app service (normally used with the sidecars value) []
app.service.sessionAffinity Control where app requests go, to the same pod or round-robin None
app.service.sessionAffinityConfig Additional settings for the sessionAffinity {}

Hyperdx api Parameters

Name Description Value
api.enabled Enable Hyperdx api true
api.replicaCount Number of Hyperdx api replicas to deploy 1
api.defaultConfig Default configuration for the Hyperdx api service ""
api.extraConfig Extra configuration for the Hyperdx api service {}
api.existingConfigmap The name of an existing ConfigMap with the default configuration ""
api.extraConfigExistingConfigmap The name of an existing ConfigMap with extra configuration ""
api.image.registry api image registry ghcr.io
api.image.repository api image repository hyperdxio/hyperdx
api.image.digest api image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended) ""
api.image.pullPolicy api image pull policy IfNotPresent
api.image.pullSecrets api image pull secrets []
api.containerPorts.http Hyperdx api HTTP container port 8000
api.livenessProbe.enabled Enable livenessProbe on Hyperdx api containers true
api.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 5
api.livenessProbe.periodSeconds Period seconds for livenessProbe 10
api.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
api.livenessProbe.failureThreshold Failure threshold for livenessProbe 6
api.livenessProbe.successThreshold Success threshold for livenessProbe 1
api.readinessProbe.enabled Enable readinessProbe on Hyperdx api containers true
api.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 5
api.readinessProbe.periodSeconds Period seconds for readinessProbe 10
api.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 5
api.readinessProbe.failureThreshold Failure threshold for readinessProbe 6
api.readinessProbe.successThreshold Success threshold for readinessProbe 1
api.startupProbe.enabled Enable startupProbe on Hyperdx api containers false
api.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 5
api.startupProbe.periodSeconds Period seconds for startupProbe 10
api.startupProbe.timeoutSeconds Timeout seconds for startupProbe 5
api.startupProbe.failureThreshold Failure threshold for startupProbe 6
api.startupProbe.successThreshold Success threshold for startupProbe 1
api.customLivenessProbe Custom livenessProbe that overrides the default one {}
api.customReadinessProbe Custom readinessProbe that overrides the default one {}
api.customStartupProbe Custom startupProbe that overrides the default one {}
api.resources.limits The resources limits for the Hyperdx api containers {}
api.resources.requests The requested resources for the Hyperdx api containers {}
api.podSecurityContext.enabled Enabled Hyperdx api pods' Security Context true
api.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy Always
api.podSecurityContext.sysctls Set kernel settings using the sysctl interface []
api.podSecurityContext.supplementalGroups Set filesystem extra groups []
api.podSecurityContext.fsGroup Set Hyperdx api pod's Security Context fsGroup 1001
api.containerSecurityContext.enabled Enabled containers' Security Context true
api.containerSecurityContext.seLinuxOptions Set SELinux options in container nil
api.containerSecurityContext.runAsUser Set containers' Security Context runAsUser 1001
api.containerSecurityContext.runAsNonRoot Set container's Security Context runAsNonRoot true
api.containerSecurityContext.privileged Set container's Security Context privileged false
api.containerSecurityContext.readOnlyRootFilesystem Set container's Security Context readOnlyRootFilesystem false
api.containerSecurityContext.allowPrivilegeEscalation Set container's Security Context allowPrivilegeEscalation false
api.containerSecurityContext.capabilities.drop List of capabilities to be dropped ["ALL"]
api.containerSecurityContext.seccompProfile.type Set container's Security Context seccomp profile RuntimeDefault
api.command Override default container command (useful when using custom images) []
api.args Override default container args (useful when using custom images) []
api.automountServiceAccountToken Mount Service Account token in pod false
api.hostAliases Hyperdx api pods host aliases []
api.podLabels Extra labels for Hyperdx api pods {}
api.podAnnotations Annotations for Hyperdx api pods {}
api.podAffinityPreset Pod affinity preset. Ignored if api.affinity is set. Allowed values: soft or hard ""
api.podAntiAffinityPreset Pod anti-affinity preset. Ignored if api.affinity is set. Allowed values: soft or hard soft
api.nodeAffinityPreset.type Node affinity preset type. Ignored if api.affinity is set. Allowed values: soft or hard ""
api.nodeAffinityPreset.key Node label key to match. Ignored if api.affinity is set ""
api.nodeAffinityPreset.values Node label values to match. Ignored if api.affinity is set []
api.affinity Affinity for Hyperdx api pods assignment {}
api.nodeSelector Node labels for Hyperdx api pods assignment {}
api.tolerations Tolerations for Hyperdx api pods assignment []
api.updateStrategy.type Hyperdx api statefulset strategy type RollingUpdate
api.priorityClassName Hyperdx api pods' priorityClassName ""
api.topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template []
api.schedulerName Name of the k8s scheduler (other than default) for Hyperdx api pods ""
api.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully ""
api.lifecycleHooks for the Hyperdx api container(s) to automate configuration before or after startup {}
api.extraEnvVars Array with extra environment variables to add to Hyperdx api nodes []
api.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Hyperdx api nodes ""
api.extraEnvVarsSecret Name of existing Secret containing extra env vars for Hyperdx api nodes ""
api.extraVolumes Optionally specify extra list of additional volumes for the Hyperdx api pod(s) []
api.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Hyperdx api container(s) []
api.sidecars Add additional sidecar containers to the Hyperdx api pod(s) []
api.initContainers Add additional init containers to the Hyperdx api pod(s) []

Hyperdx Rest Traffic Exposure Parameters

Name Description Value
api.service.type Hyperdx api service type ClusterIP
api.service.ports.http Hyperdx api service HTTP port 80
api.service.nodePorts.http Node port for HTTP ""
api.service.clusterIP Hyperdx api service Cluster IP ""
api.service.loadBalancerIP Hyperdx api service Load Balancer IP ""
api.service.loadBalancerSourceRanges Hyperdx api service Load Balancer sources []
api.service.externalTrafficPolicy Hyperdx api service external traffic policy Cluster
api.service.annotations Additional custom annotations for Hyperdx api service {}
api.service.extraPorts Extra ports to expose in Hyperdx api service (normally used with the sidecars value) []
api.service.sessionAffinity Control where api requests go, to the same pod or round-robin None
api.service.sessionAffinityConfig Additional settings for the sessionAffinity {}

Hyperdx Ingestor Parameters

Name Description Value
ingestor.enabled Enable Hyperdx ingestor true
ingestor.replicaCount Number of Hyperdx ingestor replicas to deploy 1
ingestor.defaultConfig Default configuration for the Hyperdx ingestor service ""
ingestor.extraConfig Extra configuration for the Hyperdx ingestor service {}
ingestor.existingConfigmap The name of an existing ConfigMap with the default configuration ""
ingestor.extraConfigExistingConfigmap The name of an existing ConfigMap with extra configuration ""
ingestor.image.registry ingestor image registry ghcr.io
ingestor.image.repository ingestor image repository hyperdxio/hyperdx
ingestor.image.digest ingestor image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended) ""
ingestor.image.pullPolicy ingestor image pull policy IfNotPresent
ingestor.image.pullSecrets ingestor image pull secrets []
ingestor.containerPorts.http Hyperdx ingestor HTTP container port 8002
ingestor.containerPorts.health Hyperdx ingestor HTTP health container port 8686
ingestor.livenessProbe.enabled Enable livenessProbe on Hyperdx ingestor containers true
ingestor.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 5
ingestor.livenessProbe.periodSeconds Period seconds for livenessProbe 10
ingestor.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
ingestor.livenessProbe.failureThreshold Failure threshold for livenessProbe 6
ingestor.livenessProbe.successThreshold Success threshold for livenessProbe 1
ingestor.readinessProbe.enabled Enable readinessProbe on Hyperdx ingestor containers true
ingestor.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 5
ingestor.readinessProbe.periodSeconds Period seconds for readinessProbe 10
ingestor.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 5
ingestor.readinessProbe.failureThreshold Failure threshold for readinessProbe 6
ingestor.readinessProbe.successThreshold Success threshold for readinessProbe 1
ingestor.startupProbe.enabled Enable startupProbe on Hyperdx ingestor containers false
ingestor.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 5
ingestor.startupProbe.periodSeconds Period seconds for startupProbe 10
ingestor.startupProbe.timeoutSeconds Timeout seconds for startupProbe 5
ingestor.startupProbe.failureThreshold Failure threshold for startupProbe 6
ingestor.startupProbe.successThreshold Success threshold for startupProbe 1
ingestor.customLivenessProbe Custom livenessProbe that overrides the default one {}
ingestor.customReadinessProbe Custom readinessProbe that overrides the default one {}
ingestor.customStartupProbe Custom startupProbe that overrides the default one {}
ingestor.resources.limits The resources limits for the Hyperdx ingestor containers {}
ingestor.resources.requests The requested resources for the Hyperdx ingestor containers {}
ingestor.podSecurityContext.enabled Enabled Hyperdx ingestor pods' Security Context true
ingestor.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy Always
ingestor.podSecurityContext.sysctls Set kernel settings using the sysctl interface []
ingestor.podSecurityContext.supplementalGroups Set filesystem extra groups []
ingestor.podSecurityContext.fsGroup Set Hyperdx ingestor pod's Security Context fsGroup 1001
ingestor.containerSecurityContext.enabled Enabled containers' Security Context true
ingestor.containerSecurityContext.seLinuxOptions Set SELinux options in container nil
ingestor.containerSecurityContext.runAsUser Set containers' Security Context runAsUser 1001
ingestor.containerSecurityContext.runAsNonRoot Set container's Security Context runAsNonRoot true
ingestor.containerSecurityContext.privileged Set container's Security Context privileged false
ingestor.containerSecurityContext.readOnlyRootFilesystem Set container's Security Context readOnlyRootFilesystem false
ingestor.containerSecurityContext.allowPrivilegeEscalation Set container's Security Context allowPrivilegeEscalation false
ingestor.containerSecurityContext.capabilities.drop List of capabilities to be dropped ["ALL"]
ingestor.containerSecurityContext.seccompProfile.type Set container's Security Context seccomp profile RuntimeDefault
ingestor.command Override default container command (useful when using custom images) []
ingestor.args Override default container args (useful when using custom images) []
ingestor.automountServiceAccountToken Mount Service Account token in pod false
ingestor.hostAliases Hyperdx ingestor pods host aliases []
ingestor.podLabels Extra labels for Hyperdx ingestor pods {}
ingestor.podAnnotations Annotations for Hyperdx ingestor pods {}
ingestor.podAffinityPreset Pod affinity preset. Ignored if ingestor.affinity is set. Allowed values: soft or hard ""
ingestor.podAntiAffinityPreset Pod anti-affinity preset. Ignored if ingestor.affinity is set. Allowed values: soft or hard soft
ingestor.nodeAffinityPreset.type Node affinity preset type. Ignored if ingestor.affinity is set. Allowed values: soft or hard ""
ingestor.nodeAffinityPreset.key Node label key to match. Ignored if ingestor.affinity is set ""
ingestor.nodeAffinityPreset.values Node label values to match. Ignored if ingestor.affinity is set []
ingestor.affinity Affinity for Hyperdx ingestor pods assignment {}
ingestor.nodeSelector Node labels for Hyperdx ingestor pods assignment {}
ingestor.tolerations Tolerations for Hyperdx ingestor pods assignment []
ingestor.updateStrategy.type Hyperdx ingestor statefulset strategy type RollingUpdate
ingestor.priorityClassName Hyperdx ingestor pods' priorityClassName ""
ingestor.topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template []
ingestor.schedulerName Name of the k8s scheduler (other than default) for Hyperdx ingestor pods ""
ingestor.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully ""
ingestor.lifecycleHooks for the Hyperdx ingestor container(s) to automate configuration before or after startup {}
ingestor.extraEnvVars Array with extra environment variables to add to Hyperdx ingestor nodes []
ingestor.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Hyperdx ingestor nodes ""
ingestor.extraEnvVarsSecret Name of existing Secret containing extra env vars for Hyperdx ingestor nodes ""
ingestor.extraVolumes Optionally specify extra list of additional volumes for the Hyperdx ingestor pod(s) []
ingestor.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Hyperdx ingestor container(s) []
ingestor.sidecars Add additional sidecar containers to the Hyperdx ingestor pod(s) []
ingestor.initContainers Add additional init containers to the Hyperdx ingestor pod(s) []

Hyperdx Rest Traffic Exposure Parameters

Name Description Value
ingestor.service.type Hyperdx ingestor service type ClusterIP
ingestor.service.ports.http Hyperdx ingestor service HTTP port 80
ingestor.service.nodePorts.http Node port for HTTP ""
ingestor.service.clusterIP Hyperdx ingestor service Cluster IP ""
ingestor.service.loadBalancerIP Hyperdx ingestor service Load Balancer IP ""
ingestor.service.loadBalancerSourceRanges Hyperdx ingestor service Load Balancer sources []
ingestor.service.externalTrafficPolicy Hyperdx ingestor service external traffic policy Cluster
ingestor.service.annotations Additional custom annotations for Hyperdx ingestor service {}
ingestor.service.extraPorts Extra ports to expose in Hyperdx ingestor service (normally used with the sidecars value) []
ingestor.service.sessionAffinity Control where ingestor requests go, to the same pod or round-robin None
ingestor.service.sessionAffinityConfig Additional settings for the sessionAffinity {}

Hyperdx aggregator Parameters

Name Description Value
aggregator.enabled Enable Hyperdx aggregator true
aggregator.replicaCount Number of Hyperdx aggregator replicas to deploy 1
aggregator.defaultConfig Default configuration for the Hyperdx aggregator service ""
aggregator.extraConfig Extra configuration for the Hyperdx aggregator service {}
aggregator.existingConfigmap The name of an existing ConfigMap with the default configuration ""
aggregator.extraConfigExistingConfigmap The name of an existing ConfigMap with extra configuration ""
aggregator.image.registry aggregator image registry ghcr.io
aggregator.image.repository aggregator image repository hyperdxio/hyperdx
aggregator.image.digest aggregator image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended) ""
aggregator.image.pullPolicy aggregator image pull policy IfNotPresent
aggregator.image.pullSecrets aggregator image pull secrets []
aggregator.containerPorts.http Hyperdx aggregator HTTP container port 8001
aggregator.livenessProbe.enabled Enable livenessProbe on Hyperdx aggregator containers true
aggregator.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 5
aggregator.livenessProbe.periodSeconds Period seconds for livenessProbe 10
aggregator.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
aggregator.livenessProbe.failureThreshold Failure threshold for livenessProbe 6
aggregator.livenessProbe.successThreshold Success threshold for livenessProbe 1
aggregator.readinessProbe.enabled Enable readinessProbe on Hyperdx aggregator containers true
aggregator.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 5
aggregator.readinessProbe.periodSeconds Period seconds for readinessProbe 10
aggregator.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 5
aggregator.readinessProbe.failureThreshold Failure threshold for readinessProbe 6
aggregator.readinessProbe.successThreshold Success threshold for readinessProbe 1
aggregator.startupProbe.enabled Enable startupProbe on Hyperdx aggregator containers false
aggregator.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 5
aggregator.startupProbe.periodSeconds Period seconds for startupProbe 10
aggregator.startupProbe.timeoutSeconds Timeout seconds for startupProbe 5
aggregator.startupProbe.failureThreshold Failure threshold for startupProbe 6
aggregator.startupProbe.successThreshold Success threshold for startupProbe 1
aggregator.customLivenessProbe Custom livenessProbe that overrides the default one {}
aggregator.customReadinessProbe Custom readinessProbe that overrides the default one {}
aggregator.customStartupProbe Custom startupProbe that overrides the default one {}
aggregator.resources.limits The resources limits for the Hyperdx aggregator containers {}
aggregator.resources.requests The requested resources for the Hyperdx aggregator containers {}
aggregator.podSecurityContext.enabled Enabled Hyperdx aggregator pods' Security Context true
aggregator.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy Always
aggregator.podSecurityContext.sysctls Set kernel settings using the sysctl interface []
aggregator.podSecurityContext.supplementalGroups Set filesystem extra groups []
aggregator.podSecurityContext.fsGroup Set Hyperdx aggregator pod's Security Context fsGroup 1001
aggregator.containerSecurityContext.enabled Enabled containers' Security Context true
aggregator.containerSecurityContext.seLinuxOptions Set SELinux options in container nil
aggregator.containerSecurityContext.runAsUser Set containers' Security Context runAsUser 1001
aggregator.containerSecurityContext.runAsNonRoot Set container's Security Context runAsNonRoot true
aggregator.containerSecurityContext.privileged Set container's Security Context privileged false
aggregator.containerSecurityContext.readOnlyRootFilesystem Set container's Security Context readOnlyRootFilesystem false
aggregator.containerSecurityContext.allowPrivilegeEscalation Set container's Security Context allowPrivilegeEscalation false
aggregator.containerSecurityContext.capabilities.drop List of capabilities to be dropped ["ALL"]
aggregator.containerSecurityContext.seccompProfile.type Set container's Security Context seccomp profile RuntimeDefault
aggregator.command Override default container command (useful when using custom images) []
aggregator.args Override default container args (useful when using custom images) []
aggregator.automountServiceAccountToken Mount Service Account token in pod false
aggregator.hostAliases Hyperdx aggregator pods host aliases []
aggregator.podLabels Extra labels for Hyperdx aggregator pods {}
aggregator.podAnnotations Annotations for Hyperdx aggregator pods {}
aggregator.podAffinityPreset Pod affinity preset. Ignored if aggregator.affinity is set. Allowed values: soft or hard ""
aggregator.podAntiAffinityPreset Pod anti-affinity preset. Ignored if aggregator.affinity is set. Allowed values: soft or hard soft
aggregator.nodeAffinityPreset.type Node affinity preset type. Ignored if aggregator.affinity is set. Allowed values: soft or hard ""
aggregator.nodeAffinityPreset.key Node label key to match. Ignored if aggregator.affinity is set ""
aggregator.nodeAffinityPreset.values Node label values to match. Ignored if aggregator.affinity is set []
aggregator.affinity Affinity for Hyperdx aggregator pods assignment {}
aggregator.nodeSelector Node labels for Hyperdx aggregator pods assignment {}
aggregator.tolerations Tolerations for Hyperdx aggregator pods assignment []
aggregator.updateStrategy.type Hyperdx aggregator statefulset strategy type RollingUpdate
aggregator.priorityClassName Hyperdx aggregator pods' priorityClassName ""
aggregator.topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template []
aggregator.schedulerName Name of the k8s scheduler (other than default) for Hyperdx aggregator pods ""
aggregator.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully ""
aggregator.lifecycleHooks for the Hyperdx aggregator container(s) to automate configuration before or after startup {}
aggregator.extraEnvVars Array with extra environment variables to add to Hyperdx aggregator nodes []
aggregator.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Hyperdx aggregator nodes ""
aggregator.extraEnvVarsSecret Name of existing Secret containing extra env vars for Hyperdx aggregator nodes ""
aggregator.extraVolumes Optionally specify extra list of additional volumes for the Hyperdx aggregator pod(s) []
aggregator.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Hyperdx aggregator container(s) []
aggregator.sidecars Add additional sidecar containers to the Hyperdx aggregator pod(s) []
aggregator.initContainers Add additional init containers to the Hyperdx aggregator pod(s) []

Hyperdx Rest Traffic Exposure Parameters

Name Description Value
aggregator.service.type Hyperdx aggregator service type ClusterIP
aggregator.service.ports.http Hyperdx aggregator service HTTP port 80
aggregator.service.nodePorts.http Node port for HTTP ""
aggregator.service.clusterIP Hyperdx aggregator service Cluster IP ""
aggregator.service.loadBalancerIP Hyperdx aggregator service Load Balancer IP ""
aggregator.service.loadBalancerSourceRanges Hyperdx aggregator service Load Balancer sources []
aggregator.service.externalTrafficPolicy Hyperdx aggregator service external traffic policy Cluster
aggregator.service.annotations Additional custom annotations for Hyperdx aggregator service {}
aggregator.service.extraPorts Extra ports to expose in Hyperdx aggregator service (normally used with the sidecars value) []
aggregator.service.sessionAffinity Control where aggregator requests go, to the same pod or round-robin None
aggregator.service.sessionAffinityConfig Additional settings for the sessionAffinity {}

Hyperdx goParser Parameters

Name Description Value
goParser.enabled Enable Hyperdx goParser true
goParser.replicaCount Number of Hyperdx goParser replicas to deploy 1
goParser.defaultConfig Default configuration for the Hyperdx goParser service ""
goParser.extraConfig Extra configuration for the Hyperdx goParser service {}
goParser.existingConfigmap The name of an existing ConfigMap with the default configuration ""
goParser.extraConfigExistingConfigmap The name of an existing ConfigMap with extra configuration ""
goParser.image.registry go parser image registry ghcr.io
goParser.image.repository go parser image repository hyperdxio/hyperdx
goParser.image.digest go parser image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended) ""
goParser.image.pullPolicy go parser image pull policy IfNotPresent
goParser.image.pullSecrets go parser image pull secrets []
goParser.containerPorts.http Hyperdx goParser HTTP container port 7777
goParser.livenessProbe.enabled Enable livenessProbe on Hyperdx goParser containers true
goParser.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 5
goParser.livenessProbe.periodSeconds Period seconds for livenessProbe 10
goParser.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
goParser.livenessProbe.failureThreshold Failure threshold for livenessProbe 6
goParser.livenessProbe.successThreshold Success threshold for livenessProbe 1
goParser.readinessProbe.enabled Enable readinessProbe on Hyperdx goParser containers true
goParser.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 5
goParser.readinessProbe.periodSeconds Period seconds for readinessProbe 10
goParser.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 5
goParser.readinessProbe.failureThreshold Failure threshold for readinessProbe 6
goParser.readinessProbe.successThreshold Success threshold for readinessProbe 1
goParser.startupProbe.enabled Enable startupProbe on Hyperdx goParser containers false
goParser.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 5
goParser.startupProbe.periodSeconds Period seconds for startupProbe 10
goParser.startupProbe.timeoutSeconds Timeout seconds for startupProbe 5
goParser.startupProbe.failureThreshold Failure threshold for startupProbe 6
goParser.startupProbe.successThreshold Success threshold for startupProbe 1
goParser.customLivenessProbe Custom livenessProbe that overrides the default one {}
goParser.customReadinessProbe Custom readinessProbe that overrides the default one {}
goParser.customStartupProbe Custom startupProbe that overrides the default one {}
goParser.resources.limits The resources limits for the Hyperdx goParser containers {}
goParser.resources.requests The requested resources for the Hyperdx goParser containers {}
goParser.podSecurityContext.enabled Enabled Hyperdx goParser pods' Security Context true
goParser.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy Always
goParser.podSecurityContext.sysctls Set kernel settings using the sysctl interface []
goParser.podSecurityContext.supplementalGroups Set filesystem extra groups []
goParser.podSecurityContext.fsGroup Set Hyperdx goParser pod's Security Context fsGroup 1001
goParser.containerSecurityContext.enabled Enabled containers' Security Context true
goParser.containerSecurityContext.seLinuxOptions Set SELinux options in container nil
goParser.containerSecurityContext.runAsUser Set containers' Security Context runAsUser 1001
goParser.containerSecurityContext.runAsNonRoot Set container's Security Context runAsNonRoot true
goParser.containerSecurityContext.privileged Set container's Security Context privileged false
goParser.containerSecurityContext.readOnlyRootFilesystem Set container's Security Context readOnlyRootFilesystem false
goParser.containerSecurityContext.allowPrivilegeEscalation Set container's Security Context allowPrivilegeEscalation false
goParser.containerSecurityContext.capabilities.drop List of capabilities to be dropped ["ALL"]
goParser.containerSecurityContext.seccompProfile.type Set container's Security Context seccomp profile RuntimeDefault
goParser.command Override default container command (useful when using custom images) []
goParser.args Override default container args (useful when using custom images) []
goParser.automountServiceAccountToken Mount Service Account token in pod false
goParser.hostAliases Hyperdx goParser pods host aliases []
goParser.podLabels Extra labels for Hyperdx goParser pods {}
goParser.podAnnotations Annotations for Hyperdx goParser pods {}
goParser.podAffinityPreset Pod affinity preset. Ignored if goParser.affinity is set. Allowed values: soft or hard ""
goParser.podAntiAffinityPreset Pod anti-affinity preset. Ignored if goParser.affinity is set. Allowed values: soft or hard soft
goParser.nodeAffinityPreset.type Node affinity preset type. Ignored if goParser.affinity is set. Allowed values: soft or hard ""
goParser.nodeAffinityPreset.key Node label key to match. Ignored if goParser.affinity is set ""
goParser.nodeAffinityPreset.values Node label values to match. Ignored if goParser.affinity is set []
goParser.affinity Affinity for Hyperdx goParser pods assignment {}
goParser.nodeSelector Node labels for Hyperdx goParser pods assignment {}
goParser.tolerations Tolerations for Hyperdx goParser pods assignment []
goParser.updateStrategy.type Hyperdx goParser statefulset strategy type RollingUpdate
goParser.priorityClassName Hyperdx goParser pods' priorityClassName ""
goParser.topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template []
goParser.schedulerName Name of the k8s scheduler (other than default) for Hyperdx goParser pods ""
goParser.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully ""
goParser.lifecycleHooks for the Hyperdx goParser container(s) to automate configuration before or after startup {}
goParser.extraEnvVars Array with extra environment variables to add to Hyperdx goParser nodes []
goParser.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Hyperdx goParser nodes ""
goParser.extraEnvVarsSecret Name of existing Secret containing extra env vars for Hyperdx goParser nodes ""
goParser.extraVolumes Optionally specify extra list of additional volumes for the Hyperdx goParser pod(s) []
goParser.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Hyperdx goParser container(s) []
goParser.sidecars Add additional sidecar containers to the Hyperdx goParser pod(s) []
goParser.initContainers Add additional init containers to the Hyperdx goParser pod(s) []

Hyperdx Rest Traffic Exposure Parameters

Name Description Value
goParser.service.type Hyperdx goParser service type ClusterIP
goParser.service.ports.http Hyperdx goParser service HTTP port 80
goParser.service.nodePorts.http Node port for HTTP ""
goParser.service.clusterIP Hyperdx goParser service Cluster IP ""
goParser.service.loadBalancerIP Hyperdx goParser service Load Balancer IP ""
goParser.service.loadBalancerSourceRanges Hyperdx goParser service Load Balancer sources []
goParser.service.externalTrafficPolicy Hyperdx goParser service external traffic policy Cluster
goParser.service.annotations Additional custom annotations for Hyperdx goParser service {}
goParser.service.extraPorts Extra ports to expose in Hyperdx goParser service (normally used with the sidecars value) []
goParser.service.sessionAffinity Control where goParser requests go, to the same pod or round-robin None
goParser.service.sessionAffinityConfig Additional settings for the sessionAffinity {}

Hyperdx miner Parameters

Name Description Value
miner.enabled Enable Hyperdx miner true
miner.replicaCount Number of Hyperdx miner replicas to deploy 1
miner.defaultConfig Default configuration for the Hyperdx miner service ""
miner.extraConfig Extra configuration for the Hyperdx miner service {}
miner.existingConfigmap The name of an existing ConfigMap with the default configuration ""
miner.extraConfigExistingConfigmap The name of an existing ConfigMap with extra configuration ""
miner.image.registry miner image registry ghcr.io
miner.image.repository miner image repository hyperdxio/hyperdx
miner.image.digest miner image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended) ""
miner.image.pullPolicy miner image pull policy IfNotPresent
miner.image.pullSecrets miner image pull secrets []
miner.containerPorts.http Hyperdx miner HTTP container port 5123
miner.livenessProbe.enabled Enable livenessProbe on Hyperdx miner containers true
miner.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 5
miner.livenessProbe.periodSeconds Period seconds for livenessProbe 10
miner.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
miner.livenessProbe.failureThreshold Failure threshold for livenessProbe 6
miner.livenessProbe.successThreshold Success threshold for livenessProbe 1
miner.readinessProbe.enabled Enable readinessProbe on Hyperdx miner containers true
miner.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 5
miner.readinessProbe.periodSeconds Period seconds for readinessProbe 10
miner.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 5
miner.readinessProbe.failureThreshold Failure threshold for readinessProbe 6
miner.readinessProbe.successThreshold Success threshold for readinessProbe 1
miner.startupProbe.enabled Enable startupProbe on Hyperdx miner containers false
miner.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 5
miner.startupProbe.periodSeconds Period seconds for startupProbe 10
miner.startupProbe.timeoutSeconds Timeout seconds for startupProbe 5
miner.startupProbe.failureThreshold Failure threshold for startupProbe 6
miner.startupProbe.successThreshold Success threshold for startupProbe 1
miner.customLivenessProbe Custom livenessProbe that overrides the default one {}
miner.customReadinessProbe Custom readinessProbe that overrides the default one {}
miner.customStartupProbe Custom startupProbe that overrides the default one {}
miner.resources.limits The resources limits for the Hyperdx miner containers {}
miner.resources.requests The requested resources for the Hyperdx miner containers {}
miner.podSecurityContext.enabled Enabled Hyperdx miner pods' Security Context true
miner.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy Always
miner.podSecurityContext.sysctls Set kernel settings using the sysctl interface []
miner.podSecurityContext.supplementalGroups Set filesystem extra groups []
miner.podSecurityContext.fsGroup Set Hyperdx miner pod's Security Context fsGroup 1001
miner.containerSecurityContext.enabled Enabled containers' Security Context true
miner.containerSecurityContext.seLinuxOptions Set SELinux options in container nil
miner.containerSecurityContext.runAsUser Set containers' Security Context runAsUser 1001
miner.containerSecurityContext.runAsNonRoot Set container's Security Context runAsNonRoot true
miner.containerSecurityContext.privileged Set container's Security Context privileged false
miner.containerSecurityContext.readOnlyRootFilesystem Set container's Security Context readOnlyRootFilesystem false
miner.containerSecurityContext.allowPrivilegeEscalation Set container's Security Context allowPrivilegeEscalation false
miner.containerSecurityContext.capabilities.drop List of capabilities to be dropped ["ALL"]
miner.containerSecurityContext.seccompProfile.type Set container's Security Context seccomp profile RuntimeDefault
miner.command Override default container command (useful when using custom images) []
miner.args Override default container args (useful when using custom images) []
miner.automountServiceAccountToken Mount Service Account token in pod false
miner.hostAliases Hyperdx miner pods host aliases []
miner.podLabels Extra labels for Hyperdx miner pods {}
miner.podAnnotations Annotations for Hyperdx miner pods {}
miner.podAffinityPreset Pod affinity preset. Ignored if miner.affinity is set. Allowed values: soft or hard ""
miner.podAntiAffinityPreset Pod anti-affinity preset. Ignored if miner.affinity is set. Allowed values: soft or hard soft
miner.nodeAffinityPreset.type Node affinity preset type. Ignored if miner.affinity is set. Allowed values: soft or hard ""
miner.nodeAffinityPreset.key Node label key to match. Ignored if miner.affinity is set ""
miner.nodeAffinityPreset.values Node label values to match. Ignored if miner.affinity is set []
miner.affinity Affinity for Hyperdx miner pods assignment {}
miner.nodeSelector Node labels for Hyperdx miner pods assignment {}
miner.tolerations Tolerations for Hyperdx miner pods assignment []
miner.updateStrategy.type Hyperdx miner statefulset strategy type RollingUpdate
miner.priorityClassName Hyperdx miner pods' priorityClassName ""
miner.topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template []
miner.schedulerName Name of the k8s scheduler (other than default) for Hyperdx miner pods ""
miner.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully ""
miner.lifecycleHooks for the Hyperdx miner container(s) to automate configuration before or after startup {}
miner.extraEnvVars Array with extra environment variables to add to Hyperdx miner nodes []
miner.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Hyperdx miner nodes ""
miner.extraEnvVarsSecret Name of existing Secret containing extra env vars for Hyperdx miner nodes ""
miner.extraVolumes Optionally specify extra list of additional volumes for the Hyperdx miner pod(s) []
miner.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Hyperdx miner container(s) []
miner.sidecars Add additional sidecar containers to the Hyperdx miner pod(s) []
miner.initContainers Add additional init containers to the Hyperdx miner pod(s) []

Hyperdx Rest Traffic Exposure Parameters

Name Description Value
miner.service.type Hyperdx miner service type ClusterIP
miner.service.ports.http Hyperdx miner service HTTP port 80
miner.service.nodePorts.http Node port for HTTP ""
miner.service.clusterIP Hyperdx miner service Cluster IP ""
miner.service.loadBalancerIP Hyperdx miner service Load Balancer IP ""
miner.service.loadBalancerSourceRanges Hyperdx miner service Load Balancer sources []
miner.service.externalTrafficPolicy Hyperdx miner service external traffic policy Cluster
miner.service.annotations Additional custom annotations for Hyperdx miner service {}
miner.service.extraPorts Extra ports to expose in Hyperdx miner service (normally used with the sidecars value) []
miner.service.sessionAffinity Control where miner requests go, to the same pod or round-robin None
miner.service.sessionAffinityConfig Additional settings for the sessionAffinity {}

Hyperdx open-telemetry collector Parameters

Name Description Value
otelCollector.enabled Enable Hyperdx open-telemetry collector true
otelCollector.replicaCount Number of Hyperdx otelCollector replicas to deploy 1
otelCollector.defaultConfig Default configuration for the Hyperdx otelCollector service ""
otelCollector.extraConfig Extra configuration for the Hyperdx otelCollector service {}
otelCollector.existingConfigmap The name of an existing ConfigMap with the default configuration ""
otelCollector.extraConfigExistingConfigmap The name of an existing ConfigMap with extra configuration ""
otelCollector.image.registry otelCollector image registry ghcr.io
otelCollector.image.repository otelCollector image repository hyperdxio/hyperdx
otelCollector.image.digest otelCollector image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended) ""
otelCollector.image.pullPolicy otelCollector image pull policy IfNotPresent
otelCollector.image.pullSecrets otelCollector image pull secrets []
otelCollector.containerPorts.http Hyperdx otelCollector HTTP container port 4318
otelCollector.containerPorts.health Hyperdx otelCollector health container port 13133
otelCollector.containerPorts.grpc Hyperdx otelCollector grpc container port 4317
otelCollector.containerPorts.pprof Hyperdx otelCollector pprof container port 1888
otelCollector.containerPorts.fluentd Hyperdx otelCollector fluentd container port 24225
otelCollector.containerPorts.zpages Hyperdx otelCollector zpages container port 55679
otelCollector.containerPorts.metrics Hyperdx otelCollector metrics container port 8888
otelCollector.containerPorts.zipkin Hyperdx otelCollector zipkin container port 9411
otelCollector.livenessProbe.enabled Enable livenessProbe on Hyperdx otelCollector containers true
otelCollector.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 5
otelCollector.livenessProbe.periodSeconds Period seconds for livenessProbe 10
otelCollector.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
otelCollector.livenessProbe.failureThreshold Failure threshold for livenessProbe 6
otelCollector.livenessProbe.successThreshold Success threshold for livenessProbe 1
otelCollector.readinessProbe.enabled Enable readinessProbe on Hyperdx otelCollector containers true
otelCollector.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 5
otelCollector.readinessProbe.periodSeconds Period seconds for readinessProbe 10
otelCollector.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 5
otelCollector.readinessProbe.failureThreshold Failure threshold for readinessProbe 6
otelCollector.readinessProbe.successThreshold Success threshold for readinessProbe 1
otelCollector.startupProbe.enabled Enable startupProbe on Hyperdx otelCollector containers false
otelCollector.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 5
otelCollector.startupProbe.periodSeconds Period seconds for startupProbe 10
otelCollector.startupProbe.timeoutSeconds Timeout seconds for startupProbe 5
otelCollector.startupProbe.failureThreshold Failure threshold for startupProbe 6
otelCollector.startupProbe.successThreshold Success threshold for startupProbe 1
otelCollector.customLivenessProbe Custom livenessProbe that overrides the default one {}
otelCollector.customReadinessProbe Custom readinessProbe that overrides the default one {}
otelCollector.customStartupProbe Custom startupProbe that overrides the default one {}
otelCollector.resources.limits The resources limits for the Hyperdx otelCollector containers {}
otelCollector.resources.requests The requested resources for the Hyperdx otelCollector containers {}
otelCollector.podSecurityContext.enabled Enabled Hyperdx otelCollector pods' Security Context true
otelCollector.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy Always
otelCollector.podSecurityContext.sysctls Set kernel settings using the sysctl interface []
otelCollector.podSecurityContext.supplementalGroups Set filesystem extra groups []
otelCollector.podSecurityContext.fsGroup Set Hyperdx otelCollector pod's Security Context fsGroup 1001
otelCollector.containerSecurityContext.enabled Enabled containers' Security Context true
otelCollector.containerSecurityContext.seLinuxOptions Set SELinux options in container nil
otelCollector.containerSecurityContext.runAsUser Set containers' Security Context runAsUser 1001
otelCollector.containerSecurityContext.runAsNonRoot Set container's Security Context runAsNonRoot true
otelCollector.containerSecurityContext.privileged Set container's Security Context privileged false
otelCollector.containerSecurityContext.readOnlyRootFilesystem Set container's Security Context readOnlyRootFilesystem false
otelCollector.containerSecurityContext.allowPrivilegeEscalation Set container's Security Context allowPrivilegeEscalation false
otelCollector.containerSecurityContext.capabilities.drop List of capabilities to be dropped ["ALL"]
otelCollector.containerSecurityContext.seccompProfile.type Set container's Security Context seccomp profile RuntimeDefault
otelCollector.command Override default container command (useful when using custom images) []
otelCollector.args Override default container args (useful when using custom images) []
otelCollector.automountServiceAccountToken Mount Service Account token in pod false
otelCollector.hostAliases Hyperdx otelCollector pods host aliases []
otelCollector.podLabels Extra labels for Hyperdx otelCollector pods {}
otelCollector.podAnnotations Annotations for Hyperdx otelCollector pods {}
otelCollector.podAffinityPreset Pod affinity preset. Ignored if otelCollector.affinity is set. Allowed values: soft or hard ""
otelCollector.podAntiAffinityPreset Pod anti-affinity preset. Ignored if otelCollector.affinity is set. Allowed values: soft or hard soft
otelCollector.nodeAffinityPreset.type Node affinity preset type. Ignored if otelCollector.affinity is set. Allowed values: soft or hard ""
otelCollector.nodeAffinityPreset.key Node label key to match. Ignored if otelCollector.affinity is set ""
otelCollector.nodeAffinityPreset.values Node label values to match. Ignored if otelCollector.affinity is set []
otelCollector.affinity Affinity for Hyperdx otelCollector pods assignment {}
otelCollector.nodeSelector Node labels for Hyperdx otelCollector pods assignment {}
otelCollector.tolerations Tolerations for Hyperdx otelCollector pods assignment []
otelCollector.updateStrategy.type Hyperdx otelCollector statefulset strategy type RollingUpdate
otelCollector.priorityClassName Hyperdx otelCollector pods' priorityClassName ""
otelCollector.topologySpreadConstraints Topology Spread Constraints for pod assignment spread across your cluster among failure-domains. Evaluated as a template []
otelCollector.schedulerName Name of the k8s scheduler (other than default) for Hyperdx otelCollector pods ""
otelCollector.terminationGracePeriodSeconds Seconds Redmine pod needs to terminate gracefully ""
otelCollector.lifecycleHooks for the Hyperdx otelCollector container(s) to automate configuration before or after startup {}
otelCollector.extraEnvVars Array with extra environment variables to add to Hyperdx otelCollector nodes []
otelCollector.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Hyperdx otelCollector nodes ""
otelCollector.extraEnvVarsSecret Name of existing Secret containing extra env vars for Hyperdx otelCollector nodes ""
otelCollector.extraVolumes Optionally specify extra list of additional volumes for the Hyperdx otelCollector pod(s) []
otelCollector.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Hyperdx otelCollector container(s) []
otelCollector.sidecars Add additional sidecar containers to the Hyperdx otelCollector pod(s) []
otelCollector.initContainers Add additional init containers to the Hyperdx otelCollector pod(s) []

Hyperdx Rest Traffic Exposure Parameters

Name Description Value
otelCollector.service.type Hyperdx otelCollector service type ClusterIP
otelCollector.service.ports.http Hyperdx otelCollector service HTTP port 80
otelCollector.service.nodePorts.http Node port for HTTP ""
otelCollector.service.clusterIP Hyperdx otelCollector service Cluster IP ""
otelCollector.service.loadBalancerIP Hyperdx otelCollector service Load Balancer IP ""
otelCollector.service.loadBalancerSourceRanges Hyperdx otelCollector service Load Balancer sources []
otelCollector.service.externalTrafficPolicy Hyperdx otelCollector service external traffic policy Cluster
otelCollector.service.annotations Additional custom annotations for Hyperdx otelCollector service {}
otelCollector.service.extraPorts Extra ports to expose in Hyperdx otelCollector service (normally used with the sidecars value) []
otelCollector.service.sessionAffinity Control where otelCollector requests go, to the same pod or round-robin None
otelCollector.service.sessionAffinityConfig Additional settings for the sessionAffinity {}

Hyperdx task check alerts Parameters

Name Description Value
taskCheckAlerts.enabled Enable the task-check-alerts Cronjob which checks for alert criteria and fires off any alerts as needed false
taskCheckAlerts.defaultConfig Hyperdx taskCheckAlerts default configuration ""
taskCheckAlerts.image.registry taskCheckAlerts image registry ghcr.io
taskCheckAlerts.image.repository taskCheckAlerts image repository hyperdxio/hyperdx
taskCheckAlerts.image.digest taskCheckAlerts image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended) ""
taskCheckAlerts.image.pullPolicy taskCheckAlerts image pull policy IfNotPresent
taskCheckAlerts.image.pullSecrets taskCheckAlerts image pull secrets []
taskCheckAlerts.cronjob.schedule Kubernetes CronJob schedule * * * * *
taskCheckAlerts.cronjob.concurrencyPolicy Set the cronjob parameter concurrencyPolicy Forbid
taskCheckAlerts.cronjob.failedJobsHistoryLimit Set the cronjob parameter failedJobsHistoryLimit 1
taskCheckAlerts.cronjob.successfulJobsHistoryLimit Set the cronjob parameter successfulJobsHistoryLimit 3
taskCheckAlerts.cronjob.ttlSecondsAfterFinished Set the cronjob parameter ttlSecondsAfterFinished ""
taskCheckAlerts.cronjob.restartPolicy Set the cronjob parameter restartPolicy OnFailure
taskCheckAlerts.cronjob.affinity Affinity for CronJob pod assignment {}
taskCheckAlerts.cronjob.command Override default container command (useful when using custom images) []
taskCheckAlerts.cronjob.args Override default container args (useful when using custom images) []
taskCheckAlerts.cronjob.containerSecurityContext.enabled Enabled containers' Security Context true
taskCheckAlerts.cronjob.containerSecurityContext.seLinuxOptions Set SELinux options in container nil
taskCheckAlerts.cronjob.containerSecurityContext.runAsUser Set containers' Security Context runAsUser 1001
taskCheckAlerts.cronjob.containerSecurityContext.runAsNonRoot Set container's Security Context runAsNonRoot true
taskCheckAlerts.cronjob.containerSecurityContext.privileged Set container's Security Context privileged false
taskCheckAlerts.cronjob.containerSecurityContext.readOnlyRootFilesystem Set container's Security Context readOnlyRootFilesystem false
taskCheckAlerts.cronjob.containerSecurityContext.allowPrivilegeEscalation Set container's Security Context allowPrivilegeEscalation false
taskCheckAlerts.cronjob.containerSecurityContext.capabilities.drop List of capabilities to be dropped ["ALL"]
taskCheckAlerts.cronjob.containerSecurityContext.seccompProfile.type Set container's Security Context seccomp profile RuntimeDefault
taskCheckAlerts.cronjob.podAnnotations Additional pod annotations {}
taskCheckAlerts.cronjob.podLabels Additional pod labels {}

Kong chart configurations

Name Description Value
kong.enabled Enable Kong true
kong.image.registry kong image registry docker.io
kong.image.repository kong image repository bitnami/kong
kong.image.digest kong image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag ""
kong.image.pullPolicy kong image pull policy IfNotPresent
kong.image.pullSecrets Specify docker-registry secret names as an array []
kong.image.debug Enable image debug mode false
kong.replicaCount Number of Kong replicas 1
kong.initContainers Add additional init containers to the Kong pods - name: render-kong-declarative-conf
image: '{{ include "kong.image" . }}'
command:
- /bin/bash
args:
- -ec
- |
#!/bin/bash
# https://github.com/bitnami/containers/blob/main/bitnami/kong/3/debian-11/prebuildfs/opt/bitnami/scripts/liblog.sh
. /opt/bitnami/scripts/liblog.sh
info "Rendering hyperdx declarative config template for Kong"
# https://github.com/bitnami/render-template
render-template /bitnami/kong/declarative-template/kong.yml.tpl > "/bitnami/kong/declarative-conf/kong.yml"
volumeMounts:
- name: declarative-conf-template
mountPath: /bitnami/kong/declarative-template/
- name: rendered-declarative-conf
mountPath: /bitnami/kong/declarative-conf/
{{- if .Values.containerSecurityContext.enabled }}
securityContext: {{- omit .Values.containerSecurityContext "enabled" | toYaml | nindent 6 }}
{{- end }}
kong.ingressController.enabled Enable Kong Ingress Controller false
kong.extraVolumes Adittional volumes to be added to the Kong deployment pods (evaluated as template). Requires settingkong.kong.extraVolumeMounts []
kong.kong.extraVolumeMounts Additional volumeMounts to be added to the Kong Container (evaluated as template). Normally used withkong.extraVolumes. []
kong.kong.extraEnvVars Additional env variables to configure Kong. []
kong.ingress.enabled Enable Ingress rule false
kong.service.loadBalancerIP Kubernetes service LoadBalancer IP ""
kong.service.type Kong Kubernetes service type LoadBalancer
kong.service.ports.proxyHttp Kong proxy service HTTP port 80
kong.database Select which database backend Kong will use. Can be 'postgresql', 'cassandra' or 'off'. off
kong.postgresql.enabled Switch to enable or disable the PostgreSQL helm chart inside the Kong subchart false
mongodb.enabled Switch to enable or disable the mongodb helm chart true
mongodb.image.registry mongodb image registry docker.io
mongodb.image.repository mongodb image repository bitnami/mongodb
mongodb.image.digest mongodb image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag ""
mongodb.image.pullPolicy mongodb image pull policy IfNotPresent
mongodb.image.pullSecrets Specify image pull secrets []
mongodb.image.debug Specify if debug values should be set false
mongodb.auth.enabled Enable authentication false
mongodb.auth.rootUser root user root
mongodb.auth.rootPassword root password root
mongodb.architecture MongoDB architecture (standaloneorreplicaset) standalone
mongodb.service.ports.mongodb mongodb service port 27017
redis.enabled Switch to enable or disable the Redis helm chart true
redis.image.registry Redis image registry docker.io
redis.image.repository Redis image repository bitnami/redis
redis.image.digest Redis image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag ""
redis.image.pullPolicy Redis image pull policy IfNotPresent
redis.image.pullSecrets Specify image pull secrets []
redis.image.debug Specify if debug values should be set false
redis.architecture Redis architecture. Allowed values:standaloneorreplication standalone
redis.service.ports.redis Redis service port 5432
redis.auth.enabled Enable password authentication false
clickhouse.enabled Switch to enable or disable the Clickhouse helm chart true
clickhouse.image.registry ClickHouse image registry docker.io
clickhouse.image.repository ClickHouse image repository bitnami/clickhouse
clickhouse.image.digest ClickHouse image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag ""
clickhouse.image.pullPolicy ClickHouse image pull policy IfNotPresent
clickhouse.image.pullSecrets ClickHouse image pull secrets []
clickhouse.image.debug Enable ClickHouse image debug mode false
clickhouse.auth.username ClickHouse Admin username default
clickhouse.auth.password ClickHouse Admin password default
clickhouse.auth.existingSecret Name of a secret containing the Admin password ""
clickhouse.auth.existingSecretKey Name of the key inside the existing secret ""
clickhouse.shards Number of ClickHouse shards to deploy 1
clickhouse.replicaCount Number of ClickHouse replicas per shard to deploy 1

ClickHouse keeper configuration parameters

Name Description Value
clickhouse.keeper.enabled Deploy ClickHouse keeper. Support is experimental. false

Zookeeper subchart parameters

Name Description Value
clickhouse.zookeeper.enabled Deploy Zookeeper subchart false
clickhouse.service.type ClickHouse service type ClusterIP
clickhouse.service.ports.http ClickHouse service HTTP port 8123
clickhouse.service.ports.https ClickHouse service HTTPS port 443
clickhouse.service.ports.tcp ClickHouse service TCP port 9000
clickhouse.service.ports.tcpSecure ClickHouse service TCP (secure) port 9440
clickhouse.service.ports.keeper ClickHouse keeper TCP container port 2181
clickhouse.service.ports.keeperSecure ClickHouse keeper TCP (secure) container port 3181
clickhouse.service.ports.keeperInter ClickHouse keeper interserver TCP container port 9444
clickhouse.service.ports.mysql ClickHouse service MySQL port 9004
clickhouse.service.ports.postgresql ClickHouse service PostgreSQL port 9005
clickhouse.service.ports.interserver ClickHouse service Interserver port 9009
clickhouse.service.ports.metrics ClickHouse service metrics port 8001
clickhouse.extraOverrides Extra configuration overrides (evaluated as a template) apart from the default <clickhouse>
<query_log>
<database>system</database>
<table>query_log</table>
</query_log>
<max_connections>4096</max_connections>
<keep_alive_timeout>64</keep_alive_timeout>
<max_concurrent_queries>100</max_concurrent_queries>
<uncompressed_cache_size>8589934592</uncompressed_cache_size>
<mark_cache_size>5368709120</mark_cache_size>
<default_profile>default</default_profile>
<default_database>default</default_database>
<timezone>UTC</timezone>
<mlock_executable>false</mlock_executable>
<!--
OpenTelemetry log contains OpenTelemetry trace spans.
-->
<opentelemetry_span_log>
<!--
The default table creation code is insufficient, this <engine> spec
is a workaround. There is no 'event_time' for this log, but two times,
start and finish. It is sorted by finish time, to avoid inserting
data too far away in the past (probably we can sometimes insert a span
that is seconds earlier than the last span in the table, due to a race
between several spans inserted in parallel). This gives the spans a
global order that we can use to e.g. retry insertion into some external
system.
-->
<engine>
engine MergeTree
partition by toYYYYMM(finish_date)
order by (finish_date, finish_time_us, trace_id)
</engine>
<database>system</database>
<table>opentelemetry_span_log</table>
<flush_interval_milliseconds>7500</flush_interval_milliseconds>
</opentelemetry_span_log>
<distributed_ddl>
<path>/clickhouse/task_queue/ddl</path>
</distributed_ddl>
<format_schema_path>/var/lib/clickhouse/format_schemas/</format_schema_path>
</clickhouse>
clickhouse.usersExtraOverrides Users extra configuration overrides (evaluated as a template) apart from the default <clickhouse>
<profiles>
<default>
<max_memory_usage>10000000000</max_memory_usage>
<use_uncompressed_cache>0</use_uncompressed_cache>
<load_balancing>in_order</load_balancing>
<log_queries>1</log_queries>
</default>
</profiles>
<users>
<default>
<password></password>
<profile>default</profile>
<networks>
<ip>::/0</ip>
</networks>
<quota>default</quota>
</default>
<api>
<password>api</password>
<profile>default</profile>
<networks>
<ip>::/0</ip>
</networks>
<quota>default</quota>
</api>
<aggregator>
<password>aggregator</password>
<profile>default</profile>
<networks>
<ip>::/0</ip>
</networks>
<quota>default</quota>
</aggregator>
<worker>
<password>worker</password>
<profile>default</profile>
<networks>
<ip>::/0</ip>
</networks>
<quota>default</quota>
</worker>
</users>
<quotas>
<default>
<interval>
<duration>3600</duration>
<queries>0</queries>
<errors>0</errors>
<result_rows>0</result_rows>
<read_rows>0</read_rows>
<execution_time>0</execution_time>
</interval>
</default>
</quotas>
</clickhouse>