Skip to content

Commit

Permalink
feat: add SendKey envvar config metadata (#1331)
Browse files Browse the repository at this point in the history
## Which problem is this PR solving?

Add SendKey envvar to config metadata and generate docs

## Short description of the changes

- docs
  • Loading branch information
VinozzZ authored Sep 13, 2024
1 parent aeea1d4 commit 1c45efc
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 8 deletions.
5 changes: 3 additions & 2 deletions config.md
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-09-05 at 17:40:33 UTC.
It was automatically generated on 2024-09-13 at 18:50:43 UTC.

## The Config file

Expand Down Expand Up @@ -178,14 +178,15 @@ This setting is applied **before** the `SendKey` and `SendKeyMode` settings.

### `SendKey`

SendKey is an optional Honeycomb API key that Refinery can use to send data to Honeycomb, depending on configuration.
SendKey is an optional Honeycomb API key that Refinery can use to send data to Honeycomb, depending on configuration. Setting this value via a command line flag may expose credentials - it is recommended to use the environment variable or a configuration file.

If `SendKey` is set to a valid Honeycomb key, then Refinery can use the listed key to send data.
The exact behavior depends on the value of `SendKeyMode`.

- Eligible for live reload.
- Type: `string`
- Example: `SetThisToAHoneycombKey`
- Environment variable: `REFINERY_SEND_KEY`

### `SendKeyMode`

Expand Down
4 changes: 3 additions & 1 deletion config/metadata/configMeta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -189,11 +189,13 @@ groups:
valuetype: nondefault
default: ""
example: "SetThisToAHoneycombKey"
envvar: REFINERY_SEND_KEY
commandline: send-key
reload: true
validations:
- type: format
arg: apikeyOrBlank
summary: is an optional Honeycomb API key that Refinery can use to send data to Honeycomb, depending on configuration.
summary: is an optional Honeycomb API key that Refinery can use to send data to Honeycomb, depending on configuration. Setting this value via a command line flag may expose credentials - it is recommended to use the environment variable or a configuration file.
description: >
If `SendKey` is set to a valid Honeycomb key, then Refinery can use
the listed key to send data.
Expand Down
6 changes: 4 additions & 2 deletions config_complete.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Honeycomb Refinery Configuration ##
######################################
#
# created on 2024-09-05 at 17:40:32 UTC from ../../config.yaml using a template generated on 2024-09-05 at 17:40:29 UTC
# created on 2024-09-13 at 18:50:42 UTC from ../../config.yaml using a template generated on 2024-09-13 at 18:50:40 UTC

# This file contains a configuration for the Honeycomb Refinery. It is in YAML
# format, organized into named groups, each of which contains a set of
Expand Down Expand Up @@ -162,7 +162,9 @@ AccessKeys:
# AcceptOnlyListedKeys: false

## SendKey is an optional Honeycomb API key that Refinery can use to send
## data to Honeycomb, depending on configuration.
## data to Honeycomb, depending on configuration. Setting this value via
## a command line flag may expose credentials - it is recommended to use
## the environment variable or a configuration file.
##
## If `SendKey` is set to a valid Honeycomb key, then Refinery can use
## the listed key to send data. The exact behavior depends on the value
Expand Down
3 changes: 2 additions & 1 deletion refinery_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,14 +154,15 @@ This setting is applied **before** the `SendKey` and `SendKeyMode` settings.

### `SendKey`

`SendKey` is an optional Honeycomb API key that Refinery can use to send data to Honeycomb, depending on configuration.
`SendKey` is an optional Honeycomb API key that Refinery can use to send data to Honeycomb, depending on configuration. Setting this value via a command line flag may expose credentials - it is recommended to use the environment variable or a configuration file.

If `SendKey` is set to a valid Honeycomb key, then Refinery can use the listed key to send data.
The exact behavior depends on the value of `SendKeyMode`.

- Eligible for live reload.
- Type: `string`
- Example: `SetThisToAHoneycombKey`
- Environment variable: `REFINERY_SEND_KEY`

### `SendKeyMode`

Expand Down
6 changes: 4 additions & 2 deletions tools/convert/templates/configV2.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Honeycomb Refinery Configuration ##
######################################
#
# created {{ now }} from {{ .Input }} using a template generated on 2024-09-05 at 17:40:29 UTC
# created {{ now }} from {{ .Input }} using a template generated on 2024-09-13 at 18:50:40 UTC

# This file contains a configuration for the Honeycomb Refinery. It is in YAML
# format, organized into named groups, each of which contains a set of
Expand Down Expand Up @@ -161,7 +161,9 @@ AccessKeys:
{{ conditional .Data "AcceptOnlyListedKeys" "nostar APIKeys" }}

## SendKey is an optional Honeycomb API key that Refinery can use to send
## data to Honeycomb, depending on configuration.
## data to Honeycomb, depending on configuration. Setting this value via
## a command line flag may expose credentials - it is recommended to use
## the environment variable or a configuration file.
##
## If `SendKey` is set to a valid Honeycomb key, then Refinery can use
## the listed key to send data. The exact behavior depends on the value
Expand Down

0 comments on commit 1c45efc

Please sign in to comment.