From 1d95bde1dfe7ae6adfb18582ab8fea1929a7d41d Mon Sep 17 00:00:00 2001 From: Mark Wolfe Date: Wed, 24 Jul 2024 10:30:25 +1000 Subject: [PATCH] provide clearer direction on boolean environment variables --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a4aee49..9a2c698 100644 --- a/README.md +++ b/README.md @@ -68,11 +68,11 @@ It requires a `provided.al2` environment and respects the following env vars: - `BUILDKITE_QUEUE` : A comma separated list of Buildkite queues to process (e.g. `backend-deploy,ui-deploy`). - `BUILDKITE_QUIET` : A boolean specifying that only `ERROR` log lines must be - printed. (e.g. `1`, `true`). + printed. This accepts either `1` or `true` to enable. - `BUILDKITE_CLOUDWATCH_DIMENSIONS` : A comma separated list in the form of `Key=Value,Other=Value` containing the Cloudwatch dimensions to index metrics under. - - `BUILDKITE_CLOUDWATCH_HIGH_RESOLUTION` : Whether to enable [High-Resolution Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics) which incurs additional charges. + - `BUILDKITE_CLOUDWATCH_HIGH_RESOLUTION` : Whether to enable [High-Resolution Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics) which incurs additional charges. This accepts either `1` or `true` to enable. To adjust timeouts, and connection pooling in the HTTP client use the following env vars: @@ -80,6 +80,11 @@ To adjust timeouts, and connection pooling in the HTTP client use the following - `BUILDKITE_AGENT_METRICS_MAX_IDLE_CONNS` : Maximum number of idle (keep-alive) HTTP connections for Buildkite Agent API. Zero means no limit, -1 disables pooling (default 100). +To assist with debugging the following env vars are provided: + +- `BUILDKITE_AGENT_METRICS_DEBUG` : A boolean which enables debug logging. This accepts either `1` or `true` to enable. +- `BUILDKITE_AGENT_METRICS_DEBUG_HTTP` : A boolean which enables printing of the HTTP responses. This accepts either `1` or `true` to enable. + Additionally, one of the following groups of environment variables must be set in order to define how the Lambda function should obtain the required Buildkite Agent API token: