Skip to main content

Deploy 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 ways in the following sections:


1. Using Install Script

note

The install script installs Docker automatically on linux distros mentioned below. If you're using Mac OS, Docker Desktop must be installed before proceeding. Download Docker Desktop for Mac.

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)

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


note

[Update December 2, 2021]
Currently, we have not tested these instructions to run SigNoz on Windows. But you can try it.


  1. To clone the SigNoz repository and enter the new directory, run:

    git clone https://github.com/SigNoz/signoz.git && cd signoz/deploy/
  2. To run SigNoz:
    Check that you are in signoz/deploy folder. Now run

    ./install.sh
  3. 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. For example, if you installed SigNoz on your local host, you can access the dashboard at http://localhost:3000/

  4. 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/
  2. We will now set up SigNoz via docker compose. This will set up the required dependencies and also load a sample app.

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 --env-file ./docker/clickhouse-setup/env/x86_64.env -f docker/clickhouse-setup/docker-compose.yaml up -d

For v0.5.0 and earlier

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

 

How to instrument your own applications

The current docker-compose.yaml includes sample application (HotR.O.D) that generates tracing data. You can explore SigNoz dashboard with the data from the sample app.

Instrument your own application

Having issues running SigNoz?

Checkout Troubleshooting Section