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

fix: documentation bug #1449

Merged
merged 2 commits into from
Nov 26, 2024
Merged

fix: documentation bug #1449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8814cb7
Fix documentation bug
kentquirk Nov 26, 2024
19526b9
Merge branch 'main' into kent.fix_key_docs
VinozzZ Nov 26, 2024
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
6 changes: 3 additions & 3 deletions config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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`

Expand Down Expand Up @@ -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`

Expand Down
4 changes: 2 additions & 2 deletions config/metadata/configMeta.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: >
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions refinery_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down Expand Up @@ -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`

Expand Down