From b357020daa22cac573837e84d519886e205cd275 Mon Sep 17 00:00:00 2001 From: Kent Quirk Date: Tue, 26 Nov 2024 14:07:54 -0500 Subject: [PATCH] fix: documentation bug (#1449) ## Which problem is this PR solving? - Customer reported a doc error; they were right. ## Short description of the changes - Fix the name of an environment variable - Regenerate necessary docs Co-authored-by: Yingrong Zhao <22300958+VinozzZ@users.noreply.github.com> --- config.md | 6 +++--- config/metadata/configMeta.yaml | 4 ++-- refinery_config.md | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/config.md b/config.md index 817d0a98d4..39b2b0fc7b 100644 --- a/config.md +++ b/config.md @@ -1,7 +1,7 @@ # Honeycomb Refinery Configuration Documentation This is the documentation for the configuration file for Honeycomb's Refinery. -It was automatically generated on 2024-11-22 at 17:59:58 UTC. +It was automatically generated on 2024-11-26 at 18:43:37 UTC. ## The Config file @@ -589,7 +589,7 @@ It is recommended that you create a separate team and key for Refinery metrics. - Not eligible for live reload. - Type: `string` - Example: `SetThisToAHoneycombKey` -- Environment variable: `REFINERY_HONEYCOMB_METRICS_API_KEY, HONEYCOMB_API_KEY` +- Environment variable: `REFINERY_HONEYCOMB_METRICS_API_KEY, REFINERY_HONEYCOMB_API_KEY` ### `Dataset` @@ -647,7 +647,7 @@ If this is blank, then Refinery will not set the Honeycomb-specific headers for - Not eligible for live reload. - Type: `string` - Example: `SetThisToAHoneycombKey` -- Environment variable: `REFINERY_OTEL_METRICS_API_KEY, HONEYCOMB_API_KEY` +- Environment variable: `REFINERY_OTEL_METRICS_API_KEY, REFINERY_HONEYCOMB_API_KEY` ### `Dataset` diff --git a/config/metadata/configMeta.yaml b/config/metadata/configMeta.yaml index 318e052609..ab1e473c6c 100644 --- a/config/metadata/configMeta.yaml +++ b/config/metadata/configMeta.yaml @@ -715,7 +715,7 @@ groups: validations: - type: format arg: apikey - envvar: REFINERY_HONEYCOMB_METRICS_API_KEY, HONEYCOMB_API_KEY + envvar: REFINERY_HONEYCOMB_METRICS_API_KEY, REFINERY_HONEYCOMB_API_KEY commandline: legacy-metrics-api-key summary: is the API key used by Refinery to send its metrics to Honeycomb. Setting this value via a command line flag may expose credentials - it is recommended to use the environment variable or a configuration file. description: > @@ -785,7 +785,7 @@ groups: validations: - type: format arg: apikey - envvar: REFINERY_OTEL_METRICS_API_KEY, HONEYCOMB_API_KEY + envvar: REFINERY_OTEL_METRICS_API_KEY, REFINERY_HONEYCOMB_API_KEY commandline: otel-metrics-api-key firstversion: v2.0 summary: is the API key used to send Honeycomb metrics via OpenTelemetry. Setting this value via a command line flag may expose credentials - it is recommended to use the environment variable or a configuration file. diff --git a/refinery_config.md b/refinery_config.md index 0c3bd98c8d..0c89ceee32 100644 --- a/refinery_config.md +++ b/refinery_config.md @@ -572,7 +572,7 @@ It is recommended that you create a separate team and key for Refinery metrics. - Not eligible for live reload. - Type: `string` - Example: `SetThisToAHoneycombKey` -- Environment variable: `REFINERY_HONEYCOMB_METRICS_API_KEY, HONEYCOMB_API_KEY` +- Environment variable: `REFINERY_HONEYCOMB_METRICS_API_KEY, REFINERY_HONEYCOMB_API_KEY` ### `Dataset` @@ -630,7 +630,7 @@ If this is blank, then Refinery will not set the Honeycomb-specific headers for - Not eligible for live reload. - Type: `string` - Example: `SetThisToAHoneycombKey` -- Environment variable: `REFINERY_OTEL_METRICS_API_KEY, HONEYCOMB_API_KEY` +- Environment variable: `REFINERY_OTEL_METRICS_API_KEY, REFINERY_HONEYCOMB_API_KEY` ### `Dataset`