console/packages/services/rate-limit
renovate[bot] eb47b0b2a0
chore(deps): update dependency pino-pretty to v11.3.0 (#5783)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-10-27 18:24:00 +02:00
..
src Deprecate cleanId, use slug instead (#5684) 2024-10-21 13:06:29 +02:00
.env.template run integration tests locally against local running services (#5096) 2024-07-15 11:21:23 +00:00
package.json chore(deps): update dependency pino-pretty to v11.3.0 (#5783) 2024-10-27 18:24:00 +02:00
README.md distributed tracing (#4219) 2024-04-07 11:57:03 +03:00
tsconfig.json TS skipLibCheck everywhere, starting from root tsconfig (#588) 2022-11-03 15:00:58 +00:00

Rate Limit

The rate limit service is responsible of enforcing account limitations. If you are self-hosting Hive you don't need this service.

Configuration

Name Required Description Example Value
PORT Yes The HTTP port of the service. 4012
LIMIT_CACHE_UPDATE_INTERVAL_MS No The cache update interval limit in milliseconds. 60_000
POSTGRES_HOST Yes Host of the postgres database 127.0.0.1
POSTGRES_PORT Yes Port of the postgres database 5432
POSTGRES_DB Yes Name of the postgres database. registry
POSTGRES_USER Yes User name for accessing the postgres database. postgres
POSTGRES_PASSWORD Yes Password for accessing the postgres database. postgres
USAGE_ESTIMATOR_ENDPOINT Yes The endpoint of the usage estimator service. http://127.0.0.1:4011
EMAILS_ENDPOINT No (if not provided no limit emails will be sent.) The endpoint of the GraphQL Hive Email service. http://127.0.0.1:6260
ENVIRONMENT No The environment of your Hive app. (Note: This will be used for Sentry reporting.) staging
SENTRY No Whether Sentry error reporting should be enabled. 1 (enabled) or 0 (disabled)
SENTRY_DSN No The DSN for reporting errors to Sentry. https://dooobars@o557896.ingest.sentry.io/12121212
PROMETHEUS_METRICS No Whether Prometheus metrics should be enabled 1 (enabled) or 0 (disabled)
PROMETHEUS_METRICS_LABEL_INSTANCE No The instance label added for the prometheus metrics. rate-limit
WEB_APP_URL No The base url of the web app https://your-instance.com
REQUEST_LOGGING No Log http requests 1 (enabled) or 0 (disabled)
LOG_LEVEL No The verbosity of the service logs. One of trace, debug, info, warn ,error, fatal or silent info (default)
OPENTELEMETRY_COLLECTOR_ENDPOINT No OpenTelemetry Collector endpoint. The expected traces transport is HTTP (port 4318). http://localhost:4318/v1/traces