{
  "schema_version": 1,
  "generated_at": "2026-10-22T00:00:00.000Z",
  "canonical_url": "https://openlogs.fyi/tools/coroot",
  "slug": "coroot",
  "name": "Coroot",
  "tagline": "Observability and APM tool that combines metrics, logs, traces and profiles.",
  "replaces": {
    "summary": "Paid observability services, such as Datadog.",
    "products": [
      {
        "slug": "datadog",
        "name": "Datadog",
        "vendor": "Datadog",
        "url": "https://openlogs.fyi/alternatives/datadog"
      }
    ]
  },
  "stack": [
    {
      "kind": "language",
      "name": "Go"
    },
    {
      "kind": "database",
      "name": "ClickHouse"
    }
  ],
  "deployment_methods": [
    "docker_compose"
  ],
  "requirements": {
    "min_ram_mb": null,
    "min_cpu_cores": null,
    "source_url": null
  },
  "license": {
    "spdx": "Apache-2.0",
    "class": "osi",
    "source_url": "https://github.com/coroot/coroot/blob/15137ef2f43e01d0a87245e44b937b25515e0afe/LICENSE"
  },
  "business_model": {
    "value": "unknown",
    "notes": "The README at the pinned commit does not state a business model, so it stays unknown.",
    "source_url": "https://github.com/coroot/coroot/blob/15137ef2f43e01d0a87245e44b937b25515e0afe/README.md",
    "checked_at": "2026-10-22"
  },
  "difficulty": {
    "value": "hard",
    "reason": "5 services (1 database or broker: clickhouse-server), 9 volume mounts, no env values to set, host access: host_pid, privileged. Heuristic score 7 of 11: hard."
  },
  "repository": {
    "owner": "coroot",
    "name": "coroot",
    "url": "https://github.com/coroot/coroot"
  },
  "compose_check": {
    "status": "config_ok",
    "validated_at": "2026-10-22",
    "summary": "config_ok on 2026-10-22"
  },
  "recipe": {
    "version": 1,
    "source_path": "deploy/docker-compose.yaml",
    "source_repo": "coroot/coroot",
    "source_commit_sha": "15137ef2f43e01d0a87245e44b937b25515e0afe",
    "source_kind": "app_repo",
    "source_url": "https://github.com/coroot/coroot/blob/15137ef2f43e01d0a87245e44b937b25515e0afe/deploy/docker-compose.yaml"
  },
  "install_steps": [
    {
      "order": 1,
      "kind": "prerequisite",
      "language": "text",
      "label": "Docker with the Compose plugin",
      "body": "A host with Docker and the Docker Compose plugin. This entry runs from a compose file.",
      "source_url": "https://github.com/coroot/coroot/blob/15137ef2f43e01d0a87245e44b937b25515e0afe/deploy/docker-compose.yaml",
      "validation_status": "unvalidated"
    },
    {
      "order": 2,
      "kind": "compose",
      "language": "yaml",
      "label": "Save the compose file as docker-compose.yaml",
      "body": "name: coroot\nservices:\n  coroot:\n    restart: always\n    image: ghcr.io/coroot/coroot${LICENSE_KEY:+-ee} # set 'coroot-ee' as the image if LICENSE_KEY is defined\n    pull_policy: always\n    user: root\n    volumes:\n      - coroot_data:/data\n    ports:\n      - 8080:8080\n    command:\n      - '--data-dir=/data'\n      - '--bootstrap-prometheus-url=http://prometheus:9090'\n      - '--bootstrap-refresh-interval=15s'\n      - '--bootstrap-clickhouse-address=clickhouse:9000'\n    environment:\n      - LICENSE_KEY=${LICENSE_KEY:-}\n    depends_on:\n      clickhouse:\n        condition: service_healthy\n      prometheus:\n        condition: service_healthy\n\n  node-agent:\n    restart: always\n    image: ghcr.io/coroot/coroot-node-agent\n    pull_policy: always\n    privileged: true\n    pid: \"host\"\n    volumes:\n      - /sys/kernel/tracing:/sys/kernel/tracing\n      - /sys/kernel/debug:/sys/kernel/debug\n      - /sys/fs/cgroup:/host/sys/fs/cgroup\n      - node_agent_data:/data\n    command:\n      - '--collector-endpoint=http://coroot:8080'\n      - '--cgroupfs-root=/host/sys/fs/cgroup'\n      - '--wal-dir=/data'\n\n  cluster-agent:\n    restart: always\n    image: ghcr.io/coroot/coroot-cluster-agent\n    pull_policy: always\n    volumes:\n      - cluster_agent_data:/data\n    command:\n      - '--coroot-url=http://coroot:8080'\n      - '--metrics-scrape-interval=15s'\n      - '--metrics-wal-dir=/data'\n    depends_on:\n      - coroot\n\n  prometheus:\n    restart: always\n    image: prom/prometheus:v2.53.5\n    volumes:\n      - prometheus_data:/prometheus\n    command:\n      - '--config.file=/etc/prometheus/prometheus.yml'\n      - '--storage.tsdb.path=/prometheus'\n      - '--web.console.libraries=/usr/share/prometheus/console_libraries'\n      - '--web.console.templates=/usr/share/prometheus/consoles'\n      - '--web.enable-lifecycle'\n      - '--web.enable-remote-write-receiver'\n    ports:\n      - '127.0.0.1:9090:9090'\n    healthcheck:\n      test: [\"CMD\", \"wget\", \"--no-verbose\", \"--tries=1\", \"--spider\", \"http://localhost:9090/-/healthy\"]\n      interval: 3s\n      timeout: 5s\n      retries: 5\n      start_period: 10s\n\n  clickhouse:\n    restart: always\n    image: clickhouse/clickhouse-server:24.3\n    environment:\n      CLICKHOUSE_SKIP_USER_SETUP: \"1\"\n    volumes:\n      - clickhouse_data:/var/lib/clickhouse\n      - clickhouse_logs:/var/log/clickhouse-server\n    ports:\n      - '127.0.0.1:9000:9000'\n    ulimits:\n      nofile:\n        soft: 262144\n        hard: 262144\n    configs:\n      - source: clickhouse_logging\n        target: /etc/clickhouse-server/config.d/logging_rules.xml\n      - source: clickhouse_user_logging\n        target: /etc/clickhouse-server/config.d/user_logging.xml\n    healthcheck:\n      test: [\"CMD\", \"wget\", \"--no-verbose\", \"--tries=1\", \"--spider\", \"http://localhost:8123/ping\"]\n      interval: 3s\n      timeout: 5s\n      retries: 5\n      start_period: 10s\n\nvolumes:\n  prometheus_data: {}\n  clickhouse_data: {}\n  clickhouse_logs: {}\n  coroot_data: {}\n  node_agent_data: {}\n  cluster_agent_data: {}\n\nconfigs:\n  clickhouse_logging:\n    content: |\n      <clickhouse>\n        <logger>\n            <level>warning</level>\n            <console>true</console>\n        </logger>\n        <query_thread_log remove=\"remove\"/>\n        <query_log remove=\"remove\"/>\n        <text_log remove=\"remove\"/>\n        <trace_log remove=\"remove\"/>\n        <metric_log remove=\"remove\"/>\n        <asynchronous_metric_log remove=\"remove\"/>\n        <session_log remove=\"remove\"/>\n        <part_log remove=\"remove\"/>\n        <latency_log remove=\"remove\"/>\n        <processors_profile_log remove=\"remove\"/>\n      </clickhouse>\n  clickhouse_user_logging:\n    content: |\n      <clickhouse>\n        <profiles>\n          <default>\n            <log_queries>0</log_queries>\n            <log_query_threads>0</log_query_threads>\n            <log_processors_profiles>0</log_processors_profiles>\n          </default>\n        </profiles>\n      </clickhouse>\n",
      "source_url": "https://github.com/coroot/coroot/blob/15137ef2f43e01d0a87245e44b937b25515e0afe/deploy/docker-compose.yaml",
      "validation_status": "config_ok"
    },
    {
      "order": 3,
      "kind": "shell",
      "language": "bash",
      "label": "Start it",
      "body": "docker compose up -d",
      "source_url": "https://github.com/coroot/coroot/blob/15137ef2f43e01d0a87245e44b937b25515e0afe/deploy/docker-compose.yaml",
      "validation_status": "unvalidated"
    },
    {
      "order": 4,
      "kind": "verify",
      "language": "text",
      "label": "Open the app",
      "body": "Open http://localhost:8080. The compose file publishes host port 8080 for the coroot service.",
      "source_url": "https://github.com/coroot/coroot/blob/15137ef2f43e01d0a87245e44b937b25515e0afe/deploy/docker-compose.yaml",
      "validation_status": "unvalidated"
    }
  ],
  "notes": [
    {
      "kind": "gotcha",
      "title": "Some images use the latest tag or no tag",
      "body": "Images without a pinned version: node-agent: ghcr.io/coroot/coroot-node-agent (no tag), cluster-agent: ghcr.io/coroot/coroot-cluster-agent (no tag). A later pull can get a different version.",
      "source_url": "https://github.com/coroot/coroot/blob/15137ef2f43e01d0a87245e44b937b25515e0afe/deploy/docker-compose.yaml",
      "checked_at": "2026-10-22"
    },
    {
      "kind": "gotcha",
      "title": "The compose file publishes host ports",
      "body": "Host ports: 8080 (coroot), 127.0.0.1:9090 (prometheus), 127.0.0.1:9000 (clickhouse). A port without a host address listens on all host network interfaces.",
      "source_url": "https://github.com/coroot/coroot/blob/15137ef2f43e01d0a87245e44b937b25515e0afe/deploy/docker-compose.yaml",
      "checked_at": "2026-10-22"
    },
    {
      "kind": "gotcha",
      "title": "The compose file mounts host folders",
      "body": "Host paths mounted into containers: /sys/kernel/tracing at /sys/kernel/tracing (node-agent), /sys/kernel/debug at /sys/kernel/debug (node-agent), /sys/fs/cgroup at /host/sys/fs/cgroup (node-agent).",
      "source_url": "https://github.com/coroot/coroot/blob/15137ef2f43e01d0a87245e44b937b25515e0afe/deploy/docker-compose.yaml",
      "checked_at": "2026-10-22"
    },
    {
      "kind": "gotcha",
      "title": "Some services get elevated host access",
      "body": "node-agent runs privileged, node-agent shares the host process list.",
      "source_url": "https://github.com/coroot/coroot/blob/15137ef2f43e01d0a87245e44b937b25515e0afe/deploy/docker-compose.yaml",
      "checked_at": "2026-10-22"
    }
  ],
  "signals": {
    "captured_at": "2026-10-22",
    "stars": 7980,
    "forks": 409,
    "open_issues": 126,
    "last_push": "2026-10-21",
    "days_since_push": 0,
    "latest_release": "v1.28.1",
    "latest_release_date": "2026-10-21",
    "days_since_release": 0
  },
  "links": {
    "html": "https://openlogs.fyi/tools/coroot",
    "markdown": "https://openlogs.fyi/tools/coroot.md",
    "json": "https://openlogs.fyi/tools/coroot.json"
  },
  "updated_at": "2026-10-22"
}