{"id":15567928,"url":"https://github.com/circa10a/mcbroken-dashboard","last_synced_at":"2025-10-12T21:30:54.018Z","repository":{"id":55564350,"uuid":"323378576","full_name":"circa10a/mcbroken-dashboard","owner":"circa10a","description":"Entry for digitalocean app platform hackathon","archived":true,"fork":false,"pushed_at":"2021-03-10T04:37:58.000Z","size":20,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-09T17:46:40.933Z","etag":null,"topics":["grafana","mcbroken","mcbroken-exporter","metrics-visualization","monitoring","prometheus","prometheus-exporter"],"latest_commit_sha":null,"homepage":"https://dev.to/circa10a/the-mcbroken-dashboard-1eij","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/circa10a.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}},"created_at":"2020-12-21T15:40:14.000Z","updated_at":"2024-09-14T23:09:54.000Z","dependencies_parsed_at":"2022-08-15T03:20:13.294Z","dependency_job_id":null,"html_url":"https://github.com/circa10a/mcbroken-dashboard","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circa10a%2Fmcbroken-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circa10a%2Fmcbroken-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circa10a%2Fmcbroken-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circa10a%2Fmcbroken-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/circa10a","download_url":"https://codeload.github.com/circa10a/mcbroken-dashboard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236274592,"owners_count":19122692,"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":["grafana","mcbroken","mcbroken-exporter","metrics-visualization","monitoring","prometheus","prometheus-exporter"],"created_at":"2024-10-02T17:13:55.085Z","updated_at":"2025-10-12T21:30:48.666Z","avatar_url":"https://github.com/circa10a.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mcbroken-dashboard \u003cimg src=\"https://i.imgur.com/tyKUBDv.png\" height=\"5%\" width=\"5%\" align=\"left\"/\u003e\n\nEntry for digitalocean app platform hackathon. Deploy your own by clicking the button below!\n\n[![Deploy to DO](https://mp-assets1.sfo2.digitaloceanspaces.com/deploy-to-do/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/circa10a/mcbroken-dashboard/tree/main)\n\n![Build Status](https://github.com/circa10a/digitalocean-hackathon/workflows/deploy/badge.svg)\n\n\u003cimg src=\"https://i.imgur.com/4Ib3Z8G.jpg\" height=\"50%\" width=\"50%\" align=\"right\"/\u003e\n\n## Mcbroken Dashboard Overview\n\nThe mcbroken dashboard is an app template of 3 applications(listed below) which pre-configure a dashboard that is powered by [mcbroken.com](https://mcbroken.com). It's purpose is to provide availability information of all the broken Mcdonald's ice cream machines in the United States.\n\nStats include:\n\n- Current broken percentage of mcdonald's ice cream machines in the US\n- City with the most broken machines and it's outage percentage\n- Outage percentage of most major US cities\n\n## Screenshots\n\n### Desktop view\n\n\u003cimg src=\"https://i.imgur.com/okz3zQO.png\" height=\"70%\" width=\"70%\"/\u003e\n\n### Mobile view\n\n\u003cimg src=\"https://i.imgur.com/I5tkTQi.png\" height=\"30%\" width=\"30%\"/\u003e\n\n## Components\n\nThere are 3 components(services) that make up this application.\n\n- [mcbroken exporter](#mcbroken-exporter)\n- [prometheus](#prometheus)\n- [grafana](#grafana)\n\n### Mcbroken exporter\n\nAccess the exporter metrics here: https://mcbroken-dashboard-t7vfw.ondigitalocean.app/mcbroken/metrics\n\nThe primary component is a custom prometheus exporter that collects data from [mcbroken.com](https://mcbroken.com)\n\nTechnical components(go files) are located in the root of the repo and is deployed via the go buildpack.\n\n#### Development\n\n```bash\n# build\nmake build\n# run (listens on 8080)\nmake run\n# docker build\nmake docker-build\n# docker run\nmake docker-run\n```\n\nAccessible at http://localhost:8080/metrics\n\n### Prometheus\n\nAccess prometheus here: https://mcbroken-dashboard-t7vfw.ondigitalocean.app/\n\n\u003e It's worth nothing that stateful workloads such as prometheus are not ideal for the digitalocean app platform in its current state as of 12/2020. This is due to prometheus needing persistent storage to reliably hold data. The app platform currently only supports ephemeral storage. Prometheus would be better served on a droplet, but it was a good learning experience to wire up all of these componentes together on the app platform.\n\n[Prometheus](https://prometheus.io/) is an an open source time series database that scrapes our custom exporter on short intervals and holds the data for 15 days by default.\n\nPrometheus application and deployment configuration is housed in the [prometheus directory](/prometheus) and is deployed via [Dockerfile](/prometheus/Dockerfile).\n\n### Grafana\n\nAccess Grafana here: https://mcbroken-dashboard-t7vfw.ondigitalocean.app/grafana\n\n[Grafana](https://grafana.com/) is an open source dashboard front end that has the ability to connect to a variety of different data sources such as prometheus. Grafan application and deployment configuration is housed in the [grafana directory](/grafana) and is deployed via [Dockerfile](/grafana/Dockerfile).\n\n## Deployment\n\nDeployments are handled by github actions in the [.github/workflows directory](/.github/workflows) by using the [digitalocean CLI(doctl)](https://www.digitalocean.com/docs/apis-clis/doctl/how-to/install/) to update [the app template](/deployment.yaml) for all of the components.\n\n\u003cimg src=\"https://i.imgur.com/t1N6bjH.png\" height=\"80%\" width=\"80%\"/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirca10a%2Fmcbroken-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcirca10a%2Fmcbroken-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirca10a%2Fmcbroken-dashboard/lists"}