Export WHGroup warehouse metrics like physical stock and much more WHGroup.
- 8 metrics out-of-the-box: physical stock, reserved, reservable, in purchase, in order, on the shelf, balance 3pl, balance difference 3pl
- Uses your existing long-lived session cookie to authorize requests to WhGroup Portal - WhCloud.
- Uses Request on Steroids to rate limit, retry and circuit break outgoing HTTP requests ✅
- Launch 🚀 inside a Docker container 🐳 so you don't need to manage the dependencies 🙌 ✅
Using it in your terminal requires Docker installed in your system.
Detach from the container and expose port 9749.
docker run -d -p "9749:3000" ghcr.io/hfreire/whgroup-exporter
curl http://localhost:9749/metrics
Swagger documentation available at http://localhost:9749/docs.
| Variable | Description | Required | Default value |
|---|---|---|---|
| PORT | The port to be used by the HTTP server. | false | 3000 |
| API_KEYS | The secret keys that should be used when securing endpoints. | false | undefined |
| SO_TIMEOUT | TCP socket connection timeout. | false | 120000 |
| BASE_PATH | Base path to be prefixed to all available endpoint paths. | false | / |
| PING_PATH | Endpoint path for pinging app. | false | /ping |
| HEALTHCHECK_PATH | Endpoint for checking app health. | false | /healthcheck |
| LOG_LEVEL | The log level verbosity. | false | info |
| ENVIRONMENT | The environment the app is running on. | false | undefined |
| ROLLBAR_API_KEY | The server API key used to talk with Rollbar. | false | undefined |
| WHCLOUD_SESSION_COOKIE | WhCloud session cookie to authorize requests. | true | undefined |
git clone https://github.com/hfreire/whgroup-exporter.git
cd whgroup-exporter
npm run build --if-present
npm run start
You can contribute either with code (e.g., new features, bug fixes and documentation) or by donating 5 EUR. You can read the contributing guidelines for instructions on how to contribute with code.
All donation proceedings will go to the Sverige för UNHCR, a swedish partner of the UNHCR - The UN Refugee Agency, a global organisation dedicated to saving lives, protecting rights and building a better future for refugees, forcibly displaced communities and stateless people.
Read the license for permissions and limitations.