{"id":36766544,"url":"https://github.com/mowlcoder/heimdall","last_synced_at":"2026-01-12T13:01:08.666Z","repository":{"id":301801664,"uuid":"1010255084","full_name":"MowlCoder/heimdall","owner":"MowlCoder","description":"🔍 Lightweight service monitoring tool with notifications. Zero dependencies and instant alerts when services go down.","archived":false,"fork":false,"pushed_at":"2025-09-16T11:17:57.000Z","size":134,"stargazers_count":12,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-16T13:35:35.024Z","etag":null,"topics":["cli","contributions-welcome","go","golang","good-first-issue","good-first-pr","open-source","utility"],"latest_commit_sha":null,"homepage":"","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/MowlCoder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null}},"created_at":"2025-06-28T17:20:45.000Z","updated_at":"2025-09-16T11:28:31.000Z","dependencies_parsed_at":"2025-06-28T23:31:49.500Z","dependency_job_id":null,"html_url":"https://github.com/MowlCoder/heimdall","commit_stats":null,"previous_names":["mowlcoder/heimdall"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/MowlCoder/heimdall","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MowlCoder%2Fheimdall","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MowlCoder%2Fheimdall/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MowlCoder%2Fheimdall/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MowlCoder%2Fheimdall/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MowlCoder","download_url":"https://codeload.github.com/MowlCoder/heimdall/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MowlCoder%2Fheimdall/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28338990,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T12:22:26.515Z","status":"ssl_error","status_checked_at":"2026-01-12T12:22:10.856Z","response_time":98,"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":["cli","contributions-welcome","go","golang","good-first-issue","good-first-pr","open-source","utility"],"created_at":"2026-01-12T13:00:41.083Z","updated_at":"2026-01-12T13:01:08.656Z","avatar_url":"https://github.com/MowlCoder.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\r\n  \u003cimg src=\"./logo.png\" alt=\"Heimdall Logo\" width=\"150\"\"\u003e\r\n\u003c/p\u003e\r\n\r\n\u003ch2 align=\"center\"\u003e\r\n  🔍 Heimdall - Service Monitoring Guardian 🔍\r\n\u003c/h2\u003e\r\n\r\n\u003cp align=\"center\"\u003e\r\n  \u003cem\u003eWatchful protector of your services\u003c/em\u003e\r\n\u003c/p\u003e\r\n\r\n\u003cp align=\"center\"\u003e\r\n  \u003cimg src=\"https://img.shields.io/badge/Go-1.24.2+-blue.svg\" alt=\"Go Version\"\u003e\r\n  \u003cimg src=\"https://img.shields.io/badge/License-MIT-green.svg\" alt=\"License\"\u003e\r\n  \u003cimg src=\"https://goreportcard.com/badge/github.com/MowlCoder/heimdall\" alt=\"Go Report Card\"\u003e\r\n  \u003cimg src=\"https://img.shields.io/badge/Dependencies-None-green.svg\" alt=\"Dependencies\"\u003e\r\n\r\n  \u003chr\u003e\r\n\u003c/p\u003e\r\n\r\n**Heimdall** - A lightweight, high-performance service monitoring tool that continuously checks your services' health and sends instant notifications when they become unavailable.\r\n\r\n## ✨ Features\r\n\r\n- **🔄 Continuous Monitoring**: Real-time health checks with configurable intervals\r\n- **📱 Multi-Platform Notifications**: Instant alerts via Telegram, Discord, Slack, or custom webhook\r\n- **⚡ High Performance**: Lightweight Go implementation with minimal resource usage\r\n- **🎯 Flexible Configuration**: Support for both strict and lenient health checks\r\n- **🚀 Zero Dependencies**: No external dependencies - only Go standard library\r\n\r\n## 🚀 Quick Start\r\n\r\n### Prerequisites\r\n\r\n- Go 1.24.2 or higher\r\n- Telegram Bot Token (for Telegram notifications)\r\n- Discord Webhook URL (for Discord notifications)\r\n- Slack Bot Token (for Slack notifications)\r\n\r\n### Installation\r\n\r\n1. **Clone the repository**\r\n   ```bash\r\n   git clone https://github.com/MowlCoder/heimdall.git\r\n   cd heimdall\r\n   ```\r\n\r\n2. **Build the application**\r\n   ```bash\r\n   # Using Task (recommended)\r\n   task build\r\n\r\n   # Using Docker (recommended)\r\n   docker build . -t heimdall\r\n   \r\n   # Or using Go directly\r\n   go build -o bin/heimdall ./cmd/heimdall/main.go\r\n   ```\r\n\r\n3. **Create configuration file**\r\n   ```bash\r\n   cp config.example.json config.json\r\n   ```\r\n\r\n4. **Configure your services and notifiers**\r\n   ```json\r\n   {\r\n     \"services\": [\r\n       {\r\n         \"name\": \"My Website\",\r\n         \"url\": \"https://example.com\",\r\n         \"interval\": \"30s\",\r\n         \"strict\": true,\r\n         \"headers\": {\r\n           \"User-Agent\": \"Heimdall-Monitor/1.0\",\r\n           \"Authorization\": \"Bearer your-token\"\r\n         }\r\n       },\r\n       {\r\n         \"name\": \"API Service\",\r\n         \"url\": \"https://api.example.com/health\",\r\n         \"interval\": \"1m\",\r\n         \"strict\": false,\r\n         \"timeout\": 5000\r\n       }\r\n     ],\r\n     \"notifiers\": {\r\n       \"telegram\": {\r\n         \"chatId\": \"YOUR_CHAT_ID\",\r\n         \"botToken\": \"YOUR_BOT_TOKEN\",\r\n         \"enabled\": true\r\n       },\r\n       \"discord\": {\r\n         \"webhook\": \"YOUR_DISCORD_WEBHOOK_URL\",\r\n         \"enabled\": false\r\n       },\r\n       \"slack\": {\r\n         \"chatId\": \"YOUR_CHANNEL_ID\",\r\n         \"botToken\": \"YOUR_SLACK_BOT_TOKEN\",\r\n         \"enabled\": true\r\n       },\r\n       \"webhook\": {\r\n         \"webhook\": \"YOUR_CUSTOM_WEBHOOK_URL\",\r\n         \"enabled\": false\r\n       }\r\n     }\r\n   }\r\n   ```\r\n\r\n5. **Run the service**\r\n   ```bash\r\n   # Using Task\r\n   task run\r\n\r\n   # Using Docker\r\n   docker run -d heimdall or\r\n   docker run -d heimdall --config config.json\r\n   \r\n   # Or directly\r\n   ./bin/heimdall --config ./config.json\r\n   ```\r\n\r\n## 📋 Configuration\r\n\r\n### Service Configuration\r\n\r\nEach service in the `services` array supports the following parameters:\r\n\r\n| Parameter | Type | Required | Description | Example |\r\n|-----------|------|----------|-------------|---------|\r\n| `name` | string | ✅ | Human-readable service name | `\"My API\"` |\r\n| `url` | string | ✅ | Service URL to monitor | `\"https://api.example.com\"` |\r\n| `interval` | string | ✅ | Check interval (supports Go duration or milliseconds) | `\"30s\"`, `\"1m\"`, `\"30000\"` |\r\n| `strict` | boolean | ❌ | Strict mode (only 200 OK considered healthy) | `true` |\r\n| `timeout` | integer | ❌ | Request timeout in milliseconds | `600` |\r\n| `headers` | object | ❌ | Custom HTTP headers to send with requests | `{\"Authorization\": \"Bearer token\"}` |\r\n\r\n### Notifiers Configuration\r\n\r\n#### Telegram Notifier\r\n\r\n| Parameter | Type | Required | Description |\r\n|-----------|------|----------|-------------|\r\n| `chatId` | string | ✅ | Telegram chat ID where notifications will be sent |\r\n| `botToken` | string | ✅ | Telegram bot token from @BotFather |\r\n| `enabled` | boolean | ❌ | Enable/disable Telegram notifications (default: `true`) |\r\n\r\n#### Discord Notifier\r\n\r\n| Parameter | Type | Required | Description |\r\n|-----------|------|----------|-------------|\r\n| `webhook` | string | ✅ | Discord webhook URL for the channel |\r\n| `enabled` | boolean | ❌ | Enable/disable Discord notifications (default: `true`) |\r\n\r\n#### Slack Notifier\r\n\r\n| Parameter | Type | Required | Description |\r\n|-----------|------|----------|-------------|\r\n| `chatId` | string | ✅ | Slack channel ID where notifications will be sent |\r\n| `botToken` | string | ✅ | Slack bot token |\r\n| `enabled` | boolean | ❌ | Enable/disable Slack notifications (default: `true`) |\r\n\r\n#### Custom Webhook Notifier\r\n\r\n| Parameter | Type | Required | Description |\r\n|-----------|------|----------|-------------|\r\n| `webhook` | string | ✅ | Custom webhook URL where notifications will be sent |\r\n| `enabled` | boolean | ❌ | Enable/disable custom webhook notifications (default: `true`) |\r\n\r\n**Webhook Payload Structure:**\r\n```json\r\n{\r\n  \"name\": \"Service Name\",\r\n  \"statusCode\": 500,\r\n  \"body\": \"Error response body\",\r\n  \"error\": \"Error message\"\r\n}\r\n```\r\n\r\n### Health Check Modes\r\n\r\n#### Strict Mode (`strict: true`)\r\n- Only HTTP 200 status code is considered healthy\r\n- Any other status code triggers a notification\r\n- Ideal for APIs that should always return 200 OK\r\n\r\n#### Lenient Mode (`strict: false` or omitted)\r\n- HTTP 200-499 status codes are considered healthy\r\n- Only 5xx server errors trigger notifications\r\n- Suitable for services that may return redirects or client errors\r\n\r\n## 🤝 Contributing\r\n\r\n1. Fork the repository\r\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\r\n3. Commit your changes (`git commit -m 'Add amazing feature'`)\r\n4. Push to the branch (`git push origin feature/amazing-feature`)\r\n5. Open a Pull Request\r\n\r\n## 📄 License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## 🙏 Acknowledgments\r\n\r\n- Named after Heimdall, the Norse god who watches over the Bifröst bridge\r\n- Built with Go for performance and reliability\r\n- Telegram Bot API, Discord Webhooks, Slack API, and custom webhooks for instant notifications\r\n- Rich message formatting with emojis, timestamps, and structured information\r\n\r\n---\r\n\r\n**Made with ❤️ for reliable service monitoring**","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmowlcoder%2Fheimdall","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmowlcoder%2Fheimdall","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmowlcoder%2Fheimdall/lists"}