{"id":16650264,"url":"https://github.com/hfreire/whgroup-exporter","last_synced_at":"2026-01-21T12:02:30.506Z","repository":{"id":36972252,"uuid":"420636820","full_name":"hfreire/whgroup-exporter","owner":"hfreire","description":"Prometheus exporter for WH Group warehouse stock balance","archived":false,"fork":false,"pushed_at":"2024-07-22T04:17:40.000Z","size":1397,"stargazers_count":1,"open_issues_count":15,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-07T23:28:10.739Z","etag":null,"topics":["docker","github-actions","github-handyman","prometheus","prometheus-exporter","whgroup","wine"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/hfreire.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","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},"funding":{"github":"hfreire","custom":"https://paypal.me/hfreire"}},"created_at":"2021-10-24T09:13:03.000Z","updated_at":"2024-06-25T21:51:08.000Z","dependencies_parsed_at":"2023-11-16T06:26:31.617Z","dependency_job_id":"64ac4401-51df-48b5-87e3-3cbf624373c3","html_url":"https://github.com/hfreire/whgroup-exporter","commit_stats":null,"previous_names":[],"tags_count":117,"template":false,"template_full_name":null,"purl":"pkg:github/hfreire/whgroup-exporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfreire%2Fwhgroup-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfreire%2Fwhgroup-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfreire%2Fwhgroup-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfreire%2Fwhgroup-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hfreire","download_url":"https://codeload.github.com/hfreire/whgroup-exporter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfreire%2Fwhgroup-exporter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28632781,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T04:47:28.174Z","status":"ssl_error","status_checked_at":"2026-01-21T04:47:22.943Z","response_time":86,"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":["docker","github-actions","github-handyman","prometheus","prometheus-exporter","whgroup","wine"],"created_at":"2024-10-12T09:16:04.010Z","updated_at":"2026-01-21T12:02:30.490Z","avatar_url":"https://github.com/hfreire.png","language":"JavaScript","funding_links":["https://github.com/sponsors/hfreire","https://paypal.me/hfreire","https://paypal.me/hfreire/5"],"categories":[],"sub_categories":[],"readme":"# Prometheus exporter for WH Group warehouse stock balance\n\n[![](https://github.com/hfreire/whgroup-exporter/workflows/ci/badge.svg)](https://github.com/hfreire/whgroup-exporter/actions?workflow=ci)\n[![](https://github.com/hfreire/whgroup-exporter/workflows/cd/badge.svg)](https://github.com/hfreire/whgroup-exporter/actions?workflow=cd)\n[![Coverage Status](https://coveralls.io/repos/github/hfreire/whgroup-exporter/badge.svg?branch=master)](https://coveralls.io/github/hfreire/whgroup-exporter?branch=master)\n[![Known Vulnerabilities](https://snyk.io/test/github/hfreire/whgroup-exporter/badge.svg)](https://snyk.io/test/github/hfreire/whgroup-exporter)\n[![](https://img.shields.io/github/release/hfreire/whgroup-exporter.svg)](https://github.com/hfreire/whgroup-exporter/releases)\n\n\u003e Export WHGroup warehouse metrics like physical stock and much more [WHGroup](https://whgroup.se/).\n\n### Features\n* 8 metrics out-of-the-box: physical stock, reserved, reservable, in purchase, in order, on the shelf, balance 3pl, balance difference 3pl\n* Uses your existing long-lived session cookie to authorize requests to WhGroup Portal - WhCloud.\n* Uses [Request on Steroids](https://github.com/hfreire/request-on-steroids) to rate limit, retry and circuit break outgoing HTTP requests :white_check_mark:\n* Launch :rocket: inside a Docker container :whale: so you don't need to manage the dependencies :raised_hands: :white_check_mark:\n\n### How to use\n\n#### Use it in your terminal\nUsing it in your terminal requires [Docker](https://www.docker.com) installed in your system.\n\n##### Run the Docker image in a container\nDetach from the container and expose port `9749`.\n```\ndocker run -d -p \"9749:3000\" ghcr.io/hfreire/whgroup-exporter\n```\n\n##### Use curl to fetch the metrics\n```\ncurl http://localhost:9749/metrics\n```\n\n#### Available REST API endpoints\nSwagger documentation available at `http://localhost:9749/docs`.\n\n#### Available usage environment variables\nVariable | Description | Required | Default value\n:---:|:---:|:---:|:---:\nPORT | The port to be used by the HTTP server. | false | `3000`\nAPI_KEYS | The secret keys that should be used when securing endpoints. | false | `undefined`\nSO_TIMEOUT | TCP socket connection timeout. | false | `120000`\nBASE_PATH | Base path to be prefixed to all available endpoint paths. | false | `/`\nPING_PATH | Endpoint path for pinging app. | false | `/ping`\nHEALTHCHECK_PATH | Endpoint for checking app health. | false | `/healthcheck`\nLOG_LEVEL | The log level verbosity. | false | `info`\nENVIRONMENT | The environment the app is running on. | false | `undefined`\nROLLBAR_API_KEY | The server API key used to talk with Rollbar. | false | `undefined`\nWHCLOUD_SESSION_COOKIE | WhCloud session cookie to authorize requests. | true | `undefined`\n\n### How to build\n##### Clone the GitHub repo\n```\ngit clone https://github.com/hfreire/whgroup-exporter.git\n```\n\n##### Change current directory\n\n```\ncd whgroup-exporter\n```\n\n##### Run the NPM script that will build any required assets\n\n```\nnpm run build --if-present\n```\n\n##### Run the NPM script that will start the server\n\n```\nnpm run start\n```\n\n### How to contribute\n\nYou can contribute either with code (e.g., new features, bug fixes and documentation) or\nby [donating 5 EUR](https://paypal.me/hfreire/5). You can read the [contributing guidelines](CONTRIBUTING.md) for\ninstructions on how to contribute with code.\n\nAll donation proceedings will go to the [Sverige för UNHCR](https://sverigeforunhcr.se), a swedish partner of\nthe [UNHCR - The UN Refugee Agency](http://www.unhcr.org), a global organisation dedicated to saving lives, protecting\nrights and building a better future for refugees, forcibly displaced communities and stateless people.\n\n### License\n\nRead the [license](./LICENSE.md) for permissions and limitations.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhfreire%2Fwhgroup-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhfreire%2Fwhgroup-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhfreire%2Fwhgroup-exporter/lists"}