The easiest way to run SigNoz is to use SigNoz Cloud - no installation, maintenance, or scaling needed.
New users get 30 days of free uncapped usage. Click here to sign up.
It is recommended to use the ClickHouse instance that is deployed along with Signoz. However, if you want to use an external ClickHouse instance, you can do so by relevant instructions below.
- Must have at least one Zookeeper instance
- Distributed cluster named
clusterset up required: clickhouse-cluster.xml
- User credentaials passed must have enough privileges to create/manage databases and tables
- Secure connection is not supported between Signoz and ClickHouse yet
- (Optional) UDF script and histogram quantile binary required: custom-function.xml and histogramQuantile binary
The name of the cluster must be
cluster as it is hardcoded in the SigNoz OtelCollector
migration files due to the limitations of
Setting up ClickHouse
- Run at least an instance of Zookeeper.
- Create configuration for distributed cluster named
clusteras described in clickhouse-cluster.xml and include it in
- Include Zookeeper information in above clickhouse-cluster.xml file as well.
- (Optional) Below steps are only required if you want to use histogram quantile functions using Query Builder.
- Run at least an instance of ClickHouse with the above configuration.
For Docker and Docker Swarm Users
In Docker and Docker Swarm, we will be modifying the
docker-compose.yml file to use an
- Comment out
- Comment out
clickhouse:9000with relavant ClickHouse endpoint and TCP port in the files below:
- Start SigNoz using relevant instructions.
For Kubernetes Users
In Kubernetes, we will update
override-values.yaml file to use an external ClickHouse.
At first, we will disable the default ClickHouse instance by setting
Then, we will include the external ClickHouse information in the
To install SigNoz using the above configuration, run the following command:
kubectl create namespace platform
helm --namespace platform install my-release signoz/signoz -f override-values.yaml