Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.trench.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Setting up Grafana with Trench

This guide will walk you through setting up Grafana with Trench to visualize your analytics data.

​
Prerequisites

​
Setup Steps

1

Run Grafana Container

Run the following command to start Grafana. This will make Grafana available at http://localhost:3001 and connect it to your Trench installation.
docker run -d \
  --name grafana-trench \
  --network trench_app-network \
  -p 3001:3000 \
  grafana/grafana:latest
2

Login to Grafana, use default credentials:

  • Username: admin
  • Password: admin
Grafana Login
3

Install the ClickHouse plugin in Grafana.

Go to plugins section and install the ClickHouse plugin.Grafana Install ClickHouse
4

Configure ClickHouse Data Source

  1. Go to Data Sources section and click on Add data source.
  2. Select ClickHouse as the data source.
  3. Configure the data source with these settings:
    • Host: clickhouse
    • Port: 8123
    • Protocol: http
    • Username: user
    • Password: password
Grafana ClickHouse Config
5

Setup Grafana Dashboard

You can import the pre-built dashboard using the JSON configuration provided. Download the JSON configuration and import it into Grafana.The Dashboard includes:
  • Unique pageviews over time
  • Time series visualization
  • 6-hour time window by default
6

Test Setup

Here’s an example of sending pageview data:
curl --location 'http://localhost:4000/events' \
--header 'Authorization: Bearer public-d613be4e-di03-4b02-9058-70aa4j04ff28' \
--header 'Content-Type: application/json' \
--data '{
"events": [
    {
      "userId": "550e8400-e29b-41d4-a716-4466554400",
      "type": "track",
      "event": "$pageview",
      "properties": {
        "totalAccounts": 4,
        "country": "Denmark"
      }
    }
  ]
}'
7

View the dashboard

New pageviews should be visible in the dashboard.Grafana Pageviews

​
Next Steps

  • Customize the dashboard based on your needs
  • Add more panels for different metrics
  • Set up alerts