{"id":19308680,"url":"https://github.com/mtulio/statuscake-exporter","last_synced_at":"2025-04-22T13:32:30.344Z","repository":{"id":57712521,"uuid":"154748745","full_name":"mtulio/statuscake-exporter","owner":"mtulio","description":"Prometheus StatusCake exporter","archived":false,"fork":false,"pushed_at":"2019-11-24T20:28:19.000Z","size":105,"stargazers_count":4,"open_issues_count":9,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-02T00:11:54.940Z","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mtulio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-10-25T23:11:51.000Z","updated_at":"2022-10-14T09:45:25.000Z","dependencies_parsed_at":"2022-09-26T21:30:41.440Z","dependency_job_id":null,"html_url":"https://github.com/mtulio/statuscake-exporter","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtulio%2Fstatuscake-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtulio%2Fstatuscake-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtulio%2Fstatuscake-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtulio%2Fstatuscake-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mtulio","download_url":"https://codeload.github.com/mtulio/statuscake-exporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250248807,"owners_count":21399340,"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":[],"created_at":"2024-11-10T00:16:02.273Z","updated_at":"2025-04-22T13:32:30.041Z","avatar_url":"https://github.com/mtulio.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# statuscake-exporter\n\nPrometheus StatusCake exporter\n\nExporter [consumes data from StatusCake API](https://www.statuscake.com/api/Period%20Data/Get%20Period%20Data.md) using the [official lib](https://godoc.org/github.com/DreamItGetIT/statuscake) exposing it to Prometheus on port X.\n\nSupported metrics:\n\n`statuscake_test_up`: Current status at last test\n`statuscake_test_uptime`: 7 Day Uptime\n\n## BUILD\n\n`make build`\n\nThe binary will be created on `./bin` dir.\n\n## OPTIONS\n\n`-web.listen-address`: Exporter HTTP listening port\n`-web.telemetry-path`: Exporter metrics path\n`-stk.username`: StatusCake Username\n`-stk.apikey`: StatusCake APIKEY\n`-stk.tags`: Test's Tags to limit the scrape\n`-stk.interval`: Interval in seconds to gather metrics from API\n`-stk.enable-tests`: Enable Test module collector\n`-stk.enable-ssl`: Enable SSL module collector\n`-stk.ssl-flags`: SSL Flags to be enabled as metrics\n`-v`: Show the build version\n\n## USAGE\n\n* Show metrics from all StatusCake Tests\n\n`./bin/statuscake-exporter -stk.username my_stk_user -stk.apikey my_stk_apikey`\n\n```\n# HELP statuscake_test_up Status Cake test Status\n# TYPE statuscake_test_up gauge\nstatuscake_test_up{name=\"MyApp01_-_api\"} 1\nstatuscake_test_up{name=\"MyApp02_-_front\"} 1\n# HELP statuscake_test_uptime Status Cake test Uptime from the last 7 day\n# TYPE statuscake_test_uptime gauge\nstatuscake_test_uptime{name=\"MyApp01_-_api\"} 100\nstatuscake_test_uptime{name=\"MyApp02_-_front\"} 100\n```\n\n* Show metrics filtering by Tags from StatusCake Tests\n\n`./bin/statuscake-exporter -stk.username my_stk_user -stk.apikey my_stk_apikey -stk.tags \"MyApp01\"`\n\n```\n# HELP statuscake_test_up Status Cake test Status\n# TYPE statuscake_test_up gauge\nstatuscake_test_up{name=\"MyApp01_-_api\"} 1\n# HELP statuscake_test_uptime Status Cake test Uptime from the last 7 day\n# TYPE statuscake_test_uptime gauge\nstatuscake_test_uptime{name=\"MyApp01_-_api\"} 100\n```\n\n## USAGE DOCKER\n\n```bash\ndocker run -it mtulio/statuscake-exporter:v0.3.1 \\\n  -stk.username $STATUSCAKE_USER \\\n  -stk.apikey $STATUSCAKE_APIKEY\n```\n\nOR, to build your own Docker image:\n\n`make build`\n\nThe binary will be created on `./bin` dir.\n\n`docker build  .`\n\nThis will create a docker image.\n\nSet STATUSCAKE_APIKEY and STATUSCAKE_USER variables for Docker image, and  `docker run $image-id-here`\n\n## CONTRIBUTOR\n\nYou can contribute with three ways: using, testing and developing.\n\n* Fork me\n* Open an PR with enhancements, bugfixes, etc\n* Open an issue\n\nYou are welcome. =)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmtulio%2Fstatuscake-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmtulio%2Fstatuscake-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmtulio%2Fstatuscake-exporter/lists"}