{"id":27773543,"url":"https://github.com/aanttrax/observability","last_synced_at":"2025-04-30T01:09:48.003Z","repository":{"id":290112690,"uuid":"971995364","full_name":"Aanttrax/observability","owner":"Aanttrax","description":"This repository sets up a full observability environment for Docker Compose services, using: Prometheus: Metric collection, Grafana: Visualization of metrics and logs, cAdvisor: Monitoring of Docker containers, Node Exporter: Monitoring of the host system, Loki: Log storage, Promtail: Log collection from containers","archived":false,"fork":false,"pushed_at":"2025-04-26T23:43:34.000Z","size":5,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-30T01:09:44.078Z","etag":null,"topics":["cadvisor","devops","docker-compose","grafana","loki","node-exporter","observability","prometheus","promtail"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Aanttrax.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2025-04-24T11:29:31.000Z","updated_at":"2025-04-26T23:51:37.000Z","dependencies_parsed_at":"2025-04-27T00:33:51.327Z","dependency_job_id":null,"html_url":"https://github.com/Aanttrax/observability","commit_stats":null,"previous_names":["aanttrax/observability"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aanttrax%2Fobservability","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aanttrax%2Fobservability/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aanttrax%2Fobservability/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aanttrax%2Fobservability/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Aanttrax","download_url":"https://codeload.github.com/Aanttrax/observability/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251608442,"owners_count":21616858,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["cadvisor","devops","docker-compose","grafana","loki","node-exporter","observability","prometheus","promtail"],"created_at":"2025-04-30T01:09:47.339Z","updated_at":"2025-04-30T01:09:47.997Z","avatar_url":"https://github.com/Aanttrax.png","language":null,"readme":"\n# 📈 Docker Observability Stack\n\nThis repository sets up a full **observability** environment for Docker Compose services, using:\n\n- **Prometheus**: Metric collection.\n- **Grafana**: Visualization of metrics and logs.\n- **cAdvisor**: Monitoring of Docker containers.\n- **Node Exporter**: Monitoring of the host system.\n- **Loki**: Log storage.\n- **Promtail**: Log collection from containers.\n- **Nginx**: Service to expose to a master nginx.\n\n---\n\n## 🚀 Technologies Used\n\n| Component  | Description |\n|:-----------|:------------|\n| **Prometheus** | Scrapes metrics from containers and the host system. |\n| **Grafana** | Dashboard for visualizing metrics and logs. |\n| **cAdvisor** | Metrics for each container (CPU, RAM, Disk, Network). |\n| **Node Exporter** | Metrics for the host OS (CPU, RAM, Disk, Network). |\n| **Loki** | Log database. |\n| **Promtail** | Log collector for Loki. |\n| **Nginx** | Service to expose to a master nginx. |\n\n---\n\n## 🛠️ How to Run the Stack\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/Aanttrax/observability.git\ncd observability\n```\n\n2. Create the `.env` file for Grafana credentials:\n\n```bash\necho \"GF_SECURITY_ADMIN_USER=admin\" \u003e\u003e .env\necho \"GF_SECURITY_ADMIN_PASSWORD=admin\" \u003e\u003e .env\n```\n\n(Modify values for enhanced security)\n\n3. Launch the services:\n\n```bash\ndocker-compose up -d\n```\n\n4. Access Grafana:\n\n- URL: [http://localhost:3000](http://localhost:3000)\n- Username: `admin`\n- Password: `admin` (or whatever you set in `.env`)\n\n---\n\n## 📄 Repository Structure\n\n```plaintext\n├── docker-compose.yml\n├── prometheus.yml\n├── grafana.ini\n├── loki-config.yml\n├── promtail-config.yml\n├── observability.conf\n└── README.md\n```\n\n---\n\n## 🔥 Exposed Services\n\n| Service          | Access URL                  |\n|:-----------------|:----------------------------|\n| **Grafana**      | [http://localhost:3000](http://localhost:3000) |\n\n---\n\n## 📊 Recommended Dashboards\n\n- Node Exporter Full (by Prometheus)\n- Docker Containers Metrics (by cAdvisor)\n- Loki Logs Explorer (by Loki)\n- Prometheus Metrics Overview\n\n*(You can import these dashboards directly in Grafana using their ID from Grafana.com or by uploading the JSON files.)*\n\n---\n\n## 🧠 Important Notes\n\n- **cAdvisor** automatically detects all running containers.\n- **Promtail** collects logs from `/var/log/containers/` automatically.\n- This stack is **not production-ready** (e.g., Grafana without HTTPS). Use it only in controlled environments.\n\n---\n\n## 🧹 To Clean Up\n\n```bash\ndocker-compose down -v\n```\n*(This removes containers, networks, and volumes.)*\n\n---\n\n# ✨ Author\n\u003e Stack created by Aanttrax — inspired by modern observability practices.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faanttrax%2Fobservability","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faanttrax%2Fobservability","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faanttrax%2Fobservability/lists"}