{"id":47791598,"url":"https://github.com/community-scripts/telemetry-service","last_synced_at":"2026-04-03T15:44:08.869Z","repository":{"id":337999696,"uuid":"1153882715","full_name":"community-scripts/telemetry-service","owner":"community-scripts","description":"Standalone Go service for ProxmoxVE and ProxmoxVE data, cache, and telemetry.","archived":false,"fork":false,"pushed_at":"2026-03-24T15:59:43.000Z","size":753,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-25T09:40:56.447Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/community-scripts.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-09T19:26:29.000Z","updated_at":"2026-03-24T15:59:47.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/community-scripts/telemetry-service","commit_stats":null,"previous_names":["community-scripts/telemetry-service"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/community-scripts/telemetry-service","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/community-scripts%2Ftelemetry-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/community-scripts%2Ftelemetry-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/community-scripts%2Ftelemetry-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/community-scripts%2Ftelemetry-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/community-scripts","download_url":"https://codeload.github.com/community-scripts/telemetry-service/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/community-scripts%2Ftelemetry-service/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31360814,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T15:19:21.178Z","status":"ssl_error","status_checked_at":"2026-04-03T15:19:20.670Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-03T15:44:08.310Z","updated_at":"2026-04-03T15:44:08.856Z","avatar_url":"https://github.com/community-scripts.png","language":"Go","readme":"# Telemetry Service\n\nA standalone Go microservice that collects anonymous telemetry data from [ProxmoxVE](https://github.com/community-scripts/ProxmoxVE) and [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) script installations.\n\n## Overview\n\nThis service acts as a telemetry ingestion layer between the bash installation scripts and a PocketBase backend. When users run scripts from the ProxmoxVE/ProxmoxVED repositories, optional anonymous usage data is sent here for aggregation and analysis.\n\n**What gets collected:**\n\n- Script name and installation status (success/failed)\n- Container/VM type and resource allocation (CPU, RAM, disk)\n- OS type and version\n- Proxmox VE version\n- Anonymous session ID (randomly generated UUID)\n\n**What is NOT collected:**\n\n- IP addresses (not logged, not stored)\n- Hostnames or domain names\n- User credentials or personal information\n- Hardware identifiers (MAC addresses, serial numbers)\n- Network configuration or internal IPs\n- Any data that could identify a person or system\n\n**What this enables:**\n\n- Understanding which scripts are most popular\n- Identifying scripts with high failure rates\n- Tracking resource allocation trends\n- Improving script quality based on real-world data\n\n## Features\n\n- **Telemetry Ingestion** - Receives and validates telemetry data from bash scripts\n- **PocketBase Integration** - Stores data in PocketBase collections\n- **Rate Limiting** - Configurable per-IP rate limiting to prevent abuse\n- **Caching** - In-memory or Redis-backed caching support\n- **Email Alerts** - SMTP-based alerts when failure rates exceed thresholds\n- **Dashboard** - Built-in HTML dashboard for telemetry visualization\n\n## Architecture\n\n```mermaid\nflowchart LR\n    A[Bash Scripts\u003cbr\u003eProxmoxVE/VED] --\u003e B[Telemetry Service]\n    B --\u003e C[(PocketBase)]\n    B --\u003e D[Dashboard]\n```\n\n## Dashboard\n\nThe built-in dashboard is publicly available at `https://telemetry.community-scripts.org/` and is served from `/` (with `/dashboard` kept as a compatibility alias). It provides real-time analytics:\n\n- **Installation Statistics** - Total installs, success/failure rates\n- **Top Applications** - Most installed scripts with counts\n- **Failure Analysis** - Scripts with highest failure rates (min. 10 installs)\n- **Resource Trends** - CPU, RAM, disk allocation over time\n- **OS Distribution** - Popular operating systems\n- **Proxmox Versions** - PVE version distribution\n\n**Dashboard Features:**\n\n- Automatic cache warmup (every 4 minutes)\n- Configurable time range (7, 30, 90, 365 days)\n- Shows actual total count vs. analyzed sample size\n- Loading indicator during data fetch\n\n## Project Structure\n\n```\nservice.go      # Main service, HTTP handlers, rate limiting\ncache.go        # In-memory and Redis caching\nalerts.go       # SMTP alert system\ndashboard.go    # Dashboard HTML generation\nDockerfile      # Container build\nentrypoint.sh   # Container entrypoint\ngo.mod          # Go module definition\n```\n\n## Related Projects\n\n- [ProxmoxVE](https://github.com/community-scripts/ProxmoxVE) - Proxmox VE Helper Scripts\n- [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) - Proxmox VE Helper Scripts (Dev)\n\n## API Endpoints\n\n| Endpoint          | Method | Description                              |\n| ----------------- | ------ | ---------------------------------------- |\n| `/`               | GET    | HTML dashboard UI                        |\n| `/dashboard`      | GET    | Compatibility alias for the dashboard UI |\n| `/telemetry`      | POST   | Receive telemetry data from scripts      |\n| `/healthz`        | GET    | Health check endpoint                    |\n| `/api/dashboard`  | GET    | Dashboard data as JSON                   |\n| `/api/records`    | GET    | Paginated installation log data          |\n| `/api/scripts`    | GET    | Script analysis data                     |\n| `/api/exit-codes` | GET    | Exit-code reference data                 |\n| `/metrics`        | GET    | Prometheus-style metrics output          |\n\nOperational endpoints also exist for alerts and cleanup workflows, including `/api/alerts`, `/api/cleanup/status`, and `POST /api/cleanup/run`.\n\n## Privacy \u0026 Compliance\n\nThis service is designed with privacy in mind and is **GDPR/DSGVO compliant**:\n\n- ✅ **No personal data** - Only anonymous technical metrics are collected\n- ✅ **No IP logging** - Request logging is disabled by default, IPs are never stored\n- ✅ **Transparent** - All collected fields are documented and the code is open source\n- ✅ **No tracking** - Session IDs are randomly generated and cannot be linked to users\n- ✅ **No third parties** - Data is only stored in our self-hosted PocketBase instance\n\nFor full details, see:\n\n- **[Privacy \u0026 Telemetry Documentation](docs/PRIVACY.md)** — What we collect, how, and why\n- **[Records of Processing Activities (ROPA)](docs/ROPA.md)** — GDPR Art. 30\n- **[Technical \u0026 Organizational Measures (TOMS)](docs/TOMS.md)** — GDPR Art. 32\n\n## License\n\nMIT License - see [LICENSE](LICENSE) file.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommunity-scripts%2Ftelemetry-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcommunity-scripts%2Ftelemetry-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommunity-scripts%2Ftelemetry-service/lists"}