{"id":42944675,"url":"https://github.com/jtara1/tele","last_synced_at":"2026-01-30T20:34:12.621Z","repository":{"id":227766868,"uuid":"772319933","full_name":"jtara1/tele","owner":"jtara1","description":"Dashboard to view system resources and query logs","archived":false,"fork":false,"pushed_at":"2024-08-22T00:38:42.000Z","size":181,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-22T02:18:06.011Z","etag":null,"topics":["alerts","dashboard","docker","grafana","journald","logs","metrics","nginx","nix","telemetry"],"latest_commit_sha":null,"homepage":"","language":"Nix","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jtara1.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":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-15T00:42:21.000Z","updated_at":"2024-08-22T00:38:46.000Z","dependencies_parsed_at":"2024-03-15T03:55:55.763Z","dependency_job_id":"7c85ad1a-219d-434f-a4be-76ac54068344","html_url":"https://github.com/jtara1/tele","commit_stats":null,"previous_names":["jtara1/logs-app","jtara1/tele"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/jtara1/tele","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtara1%2Ftele","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtara1%2Ftele/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtara1%2Ftele/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtara1%2Ftele/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jtara1","download_url":"https://codeload.github.com/jtara1/tele/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jtara1%2Ftele/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28918480,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T20:25:28.696Z","status":"ssl_error","status_checked_at":"2026-01-30T20:25:13.426Z","response_time":66,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["alerts","dashboard","docker","grafana","journald","logs","metrics","nginx","nix","telemetry"],"created_at":"2026-01-30T20:34:12.031Z","updated_at":"2026-01-30T20:34:12.596Z","avatar_url":"https://github.com/jtara1.png","language":"Nix","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tele\n\n[![FlakeHub](https://img.shields.io/endpoint?url=https://flakehub.com/f/jtara1/tele/badge)](https://flakehub.com/flake/jtara1/tele)\n\nDashboard to view system resources and query logs\n\n\n## Features\n\n- view timeseries graphs for: cpu, memory, storage, \u0026 networking\n- receive email alerts when a resource (cpu, memory, or storage) is in high use\n- ingest docker (rootless) container logs\n- ingest nginx access logs\n- query the logs\n\nYou're not required to use docker, nginx, or setup email (to receive alerts).\n\n\n## Requirements\n\nNixOS and Nix Flakes on remote host for usage. \n\n\n## Setup\n\nassumptions for simplification:\n- docker containers run on same host\n- nginx runs on same host\n\npromtail should safely fail for its respective scrape job if you're not running docker or nginx\n\n\n### NixOS Flake\n\n#### Import\n\nin your system `flake.nix` `inputs`, add\n```text\n    tele.url = \"github:jtara1/tele\";\n```\n\nin your `modules` or an `imports`, append\n```text\n    inputs.tele.nixosModules.default\n```\nwhere `inputs` is the 1st parameter in the function assigned to `outputs`.\n\n#### Configure\n\nin a nix module, enable it with config such as\n```text\n  services.tele = {\n    enable = true;\n    email = {\n      host = \"mail.example.com:587\";\n      senderAddress = \"admin@example.com\";\n      receiverAddress = \"admin@example.com\";\n      secretsFilePath = /etc/tele/secrets.json;\n    };\n  };\n```\n\n`email` is optional and used for sending emails for notifications based on alert rules.\n\n`secretsFilePath` should be a file path to a file containing:\n```json\n{\n  \"emailPlaintextPassword\": \"your-email-password\"\n}\n```\n\n### Publish\n\nOn host OS and its network, you should expose or redirect to its `http://localhost:3010`, \ngrafana, the dashboard for querying and graphs\n\n### Security\n\nAdd security. Change grafana dashboard password. Allowlist your IP from which you're accessing it. \nEncrypt the channel via TLS or other. etc.\n\n\n## Usage\n\nGo to the url for grafana, defaults to http://localhost:3010\n\ndefault login:\n```text\nusername: admin\npassword: admin\n```\n\nYou can query logs, create visualizations, load a dashboard, or check alerts:\n- Explore\n- Dashboards\n  - Node Exporter Full http://localhost:3010/d/rYdddlPWk/node-exporter-full?orgId=1\u0026refresh=1m\n- Alerting\n\n## TODO\n\n- [x] migrate everything to nixos config declaration\n- [x] nixos config services.promtail\n- [x] relabel docker apps logs for readability (container name instead of container id, the long-hashes)\n- [x] ~~.sh instead of ansible? Makefile instead of ansible?~~ can import nix flake\n- [x] promtail to ingest logs for non-rootless (default) docker containers\n- [ ] config to conditionally set docker deamon.json instead of docker rootless\n- [x] improve promtail job, docker\n- [x] re-add nginx access logs pipeline\n- [x] prometheus for system monitoring and metrics\n- [x] 1st alerts rule for memory\n- [x] alert notifications via SMTPS/email\n- [x] alert rules for core resources: cpu, storage, memory\n- [ ] ingest logs from multiple virtual machines in dedicated tele server?\n- [x] fix and test the nginx config for local dev and for my server\n- [ ] refactor into nix module(s) to be more portable for non-flake NixOS users\n- [x] core health dashboard - pre-configured visualization for core resources\n- [ ] improve management of email password for ease of secure and declarative use\n- [x] publish to flakehub\n- [ ] error: timestamp of a queried log is invalid\n- [ ] alerts may need variable datasource uid\n\n\n## References\n\n- [How to Setup Prometheus, Grafana and Loki on NixOS](https://xeiaso.net/blog/prometheus-grafana-loki-nixos-2020-11-20/)\n- [nix config: grafana](https://discourse.nixos.org/t/how-to-use-exported-grafana-dashboard/27739/2?u=jtara1)\n- [pure nix config for all](https://gist.github.com/rickhull/895b0cb38fdd537c1078a858cf15d63e)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjtara1%2Ftele","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjtara1%2Ftele","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjtara1%2Ftele/lists"}