Skip to main content

Getting Started with SigNoz

This guide helps you set up and run SigNoz, an open-source observability platform.

Prerequisites​

  • Git: For cloning the repository.
  • Go: For building the backend server.
  • GCC: Required for CGO dependencies.
  • Node.js: For running the frontend.
  • Yarn: For managing frontend dependencies.
  • Docker: For running ClickHouse and other services.

Installation​

  1. Clone the SigNoz repository:

    git clone https://github.com/SigNoz/signoz.git
    cd signoz

  2. Set up ClickHouse:

    make devenv-clickhouse

    This command starts ClickHouse and ZooKeeper using Docker Compose. It also runs schema migrations required for SigNoz.

  3. Start the backend server:

    make go-run-community

    This command starts the community version of the SigNoz backend, connecting to ClickHouse.

  4. Configure the frontend:

    cd frontend
    yarn install
    echo "FRONTEND_API_ENDPOINT=http://localhost:8080" > .env
    yarn dev

    These commands install frontend dependencies, create a .env file specifying the API endpoint, and start the frontend development server.

Usage​

  1. Access the SigNoz UI: Open your web browser and navigate to http://localhost:8080.
  2. Explore the UI: You should now see the SigNoz interface, ready to receive and display observability data.
  3. Generate sample data (optional): To start collecting logs and metrics from your infrastructure, run the following command: 
    cd deploy/docker/generator/infra
    docker compose up -d
  4. Generate Sample Traces(optional): To start generating sample traces, run the following command: 
    cd deploy/docker/generator/hotrod
    docker compose up -d
    In a couple of minutes, you should see the data generated from hotrod in SigNoz UI.

Running in Gitpod​

The project is configured to run in Gitpod. To get started:

  1. Click the Gitpod button in the repository.
  2. The environment will automatically:
    • Start the Docker Compose environment (ClickHouse, Zookeeper and Schema Migrator).
    • Install frontend dependencies.
    • Start the frontend development server.

You can then access the SigNoz UI in the Gitpod preview.

Additional Information​