Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add environment variables #589

Merged
merged 1 commit into from
Jan 20, 2023
Merged

docs: add environment variables #589

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,21 @@ By default, a Refinery process will register itself in Redis using its local hos
In environments where domain name resolution is slow or unreliable, override the reliance on name lookups by specifying the name of the peering network interface with the `IdentifierInterfaceName` configuration option.
See the [Refinery documentation](https://docs.honeycomb.io/manage-data-volume/refinery/) for more details on tuning a cluster.

### Environment Variables

Refinery supports the following environment variables. Environment variables take precedence over file configuration.

| Environment Variable | Config Field |
|-------------------------------------------------------------------|----------------------------------|
| `REFINERY_GRPC_LISTEN_ADDRESS` | `GRPCListenAddr` |
| `REFINERY_REDIS_HOST` | `PeerManagement.RedisHost` |
| `REFINERY_REDIS_USERNAME` | `PeerManagement.RedisUsername` |
| `REFINERY_REDIS_PASSWORD` | `PeerManagement.RedisPassword` |
| `REFINERY_HONEYCOMB_API_KEY` | `HoneycombLogger.LoggerAPIKey` |
| `REFINERY_HONEYCOMB_METRICS_API_KEY` `REFINERY_HONEYCOMB_API_KEY` | `HoneycombMetrics.MetricsAPIKey` |
| `REFINERY_QUERY_AUTH_TOKEN` | `QueryAuthToken` |

Note, `REFINERY_HONEYCOMB_METRICS_API_KEY` takes precedence over `REFINERY_HONEYCOMB_API_KEY` for the `HoneycombMetrics.MetricsAPIKey` configuration.

### Mixing Classic and Environment & Services Rule Definitions

Expand Down