Deploying to Local Kubernetes

Use Self Hosted SigNoz if you need

Full on-prem control
Custom build tweaks
Zero outbound traffic

Otherwise, try SigNoz Cloud to

Onboard in 5 minutes
Auto-scale & upgrades
Zero ops maintenance

Start your 30 day free trial

Prerequisites

Kubernetes version >= 1.22
Currently supports x86-64, amd64 and arm64 architectures
Helm version >= 3.8
You must have kubectl access to your cluster
The following table describes the hardware requirements that are needed to install SigNoz on Kubernetes:
Component Minimal Requirements Recommended
Memory 8 GB 16 GB
CPU 4 cores 8 cores
Storage 30 GB 80 GB

Component	Minimal Requirements	Recommended
Memory	8 GB	16 GB
CPU	4 cores	8 cores
Storage	30 GB	80 GB

Set up a Local Kubernetes Cluster

Choose one of the following options to set up your local Kubernetes cluster:

Follow the official Minikube installation guide
Recommended configuration for SigNoz:
```
minikube start --memory=8g --cpus=4
```

Install SigNoz

Helm Installation

The SigNoz Helm chart will install the following components into your Kubernetes cluster:

SigNoz
SigNoz Collector
Clickhouse
Zookeeper

Find a storage class to use in your cluster:

kubectl get storageclass

Create a values.yaml file that will contain the configuration for the chart. Here is a minimal example to get started:

global:
  storageClass: <storage-class>

clickhouse:
  installCustomStorageClass: true

You can find an exhaustive list of the parameters here.

Install SigNoz:

helm repo add signoz https://charts.signoz.io
helm repo update
helm install signoz signoz/signoz \
   --namespace <namespace> --create-namespace \
   --wait \
   --timeout 1h \
   -f values.yaml

Test the installation

In another terminal, port-forward signoz on its http port. (By default, signoz exposes its http server on port 8080.)

kubectl port-forward -n <namespace> svc/signoz 8080:8080

Run the following command to check the health of signoz:

curl -X GET http://localhost:8080/api/v1/health

If the installation is successful, you should see the following output:

{"status":"ok"}

✅ Info

By default, retention period is set to 7 days for logs and traces, and 30 days for metrics. To change this, navigate to the General tab on the Settings page of SigNoz UI.

For more details, refer to https://signoz.io/docs/userguide/retention-period.

(Optional) Install OpenTelemetry Demo

The OpenTelemetry Demo is a microservice-based distributed system intended to illustrate the implementation of OpenTelemetry in a near real-world environment. See more details at OpenTelemetry Demo.

Get the address of the SigNoz collector:

kubectl get svc -n <namespace> svc/signoz-otel-collector

This value will be used in the next step to configure the OpenTelemetry Demo to send data to the SigNoz collector.

Create a values.yaml file that will contain the configuration for the chart and send it to your SigNoz installation:

default:
  env:
    - name: OTEL_SERVICE_NAME
      valueFrom:
        fieldRef:
          apiVersion: v1
          fieldPath: "metadata.labels['app.kubernetes.io/component']"
    - name: OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
      value: cumulative
    - name: OTEL_RESOURCE_ATTRIBUTES
      value: 'service.name=$(OTEL_SERVICE_NAME),service.namespace=opentelemetry-demo,service.version={{ .Values.appVersion }}'
    - name: OTEL_COLLECTOR_NAME
      value: signoz-otel-collector.<namespace>.svc.cluster.local

Note: The OTEL_COLLECTOR_NAME is the address obtained in the previous step.

Install OpenTelemetry Demo:

helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts
helm repo update
helm install otel-demo open-telemetry/opentelemetry-demo -f values.yaml

More details on the installation can be found here.

Next Steps

Was this page helpful?

Other Platform

Deploying with ArgoCD