Skip to main content

Deploying with Docker

Steps:#

  1. Install SigNoz backend as instructed in this page
  2. Instrument your application as instructed in Instructions Page

You can install SigNoz backend in following 2 ways:

  1. Using Install Script
  2. Using Docker Compose

We have explained each of these way in the following sections


1. Using Install Script#

If you are on Mac or any of the following linux distributions, using our install script should be the easiest way to get started:

  • Ubuntu
  • Debian
  • OpenSuse
  • CentOS
  • SUSE Linux Enterprise Server (SLES)
  • RedHat
  • Amazon Linux

If you are neither on any of the above distributions nor on Mac, please install directly using Docker Compose

Here's a quick guide to install Docker Compose if you don't have it set up already


note

[Update Aug 23, 2021] If you are trying to test SigNoz on Mac M1 (Apple Silicon Chip), the below methods would throw an error as Clickhouse doesn't provide an official arm build for docker. We recommend you try installing on a cloud virtual machine on Ubuntu or any of the other supported linux distros.

We are working on finding a way to solve this ASAP.


  1. To clone the SigNoz repository and enter the new directory, run:
git clone https://github.com/SigNoz/signoz.git && cd signoz/deploy/

  1. To run SigNoz:

Check that you are in signoz/deploy folder. Now run

./install.sh

  1. You will be given choice to either chose Clickhouse or Kafka+Druid as the storage backend
👉 Two ways to go forward
1) ClickHouse as database (default)
2) Kafka + Druid as datastore

Once install.sh runs successfully, the UI should be accessible at port 3000 on the domain you set up or the IP of your instance.


info

Wait for 2-3 mins for the data to be available to frontend. If you are running on local machine, checkout http://localhost:3000. You would want to open port 3000 to be accessible from outside world if you want to use public url of machine.



2. Using Docker Compose#

  1. To clone the SigNoz repository and enter the new directory, run:
git clone https://github.com/SigNoz/signoz.git && cd signoz/deploy/

  1. You can chose either ClickHouse or Druid as the datastore. You need to have docker-compose correctly setup before running this.

If you don't have docker-compose set up, please follow this guide to set up docker compose before proceeding with the next steps.

sudo docker-compose -f ./docker/clickhouse-setup/docker-compose.yaml up -d

Production Settings for Kafka + Druid setup#

A standard instance of SigNoz needs around 8GB of memory. The setup uses docker-compose.yaml file at deploy/docker/druid-kafka-setup

If you are interested in configuring S3 deep storage for production usage, check out this section


How to instrument your own applications#

The current docker-compose.yaml includes sample application (HotR.O.D) that generates tracing data. To see your own application data, follow the steps below

Checkout Instrumentation Section


Having issues running SigNoz?#

Checkout Troubleshooting Section

Deep Storage with S3 for Kafka+Druid Setup#

Checkout Configuration Section