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: Regenerate docs from recent changes #750

Merged
merged 1 commit into from
Jun 28, 2023
Merged

docs: Regenerate docs from recent changes #750

Show file tree
Hide file tree
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
12 changes: 6 additions & 6 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 2023-06-24 at 14:59:24 UTC.
It was automatically generated on 2023-06-27 at 22:07:32 UTC.

## The Config file

Expand Down Expand Up @@ -111,7 +111,7 @@ Incoming traffic is expected to be HTTP, so if SSL is a requirement, put somethi
- Type: `hostport`
- Default: `0.0.0.0:8080`
- Environment variable: `REFINERY_HTTP_LISTEN_ADDRESS`
- Command line switch: `--http-listen-addr`
- Command line switch: `--http-listen-address`

### `PeerListenAddr`

Expand All @@ -123,7 +123,7 @@ Incoming traffic is expected to be HTTP, so if using SSL use something like ngin
- Type: `hostport`
- Default: `0.0.0.0:8081`
- Environment variable: `REFINERY_PEER_LISTEN_ADDRESS`
- Command line switch: `--peer-listen-addr`
- Command line switch: `--peer-listen-address`

### `HoneycombAPI`

Expand Down Expand Up @@ -155,10 +155,10 @@ This list only applies to span traffic - other Honeycomb API actions will be pro

AcceptOnlyListedKeys is a boolean flag that causes events arriving with API keys not in the `ReceiveKeys` list to be rejected.

If `true`, then only traffic using the keys listed in `APIKeys` is accepted.
If `true`, then only traffic using the keys listed in `ReceiveKeys` is accepted.
Events arriving with API keys not in the `ReceiveKeys` list will be rejected with an HTTP `401` error.
If `false`, then all traffic is accepted and `ReceiveKeys` is ignored.
Must be specified if `APIKeys` is specified.
Must be specified if `ReceiveKeys` is specified.

- Eligible for live reload.
- Type: `bool`
Expand Down Expand Up @@ -895,7 +895,7 @@ Incoming traffic is expected to be unencrypted, so if using SSL, then put someth
- Not eligible for live reload.
- Type: `hostport`
- Environment variable: `REFINERY_GRPC_LISTEN_ADDRESS`
- Command line switch: `--grpc-listen-addr`
- Command line switch: `--grpc-listen-address`

### `MaxConnectionIdle`

Expand Down
10 changes: 5 additions & 5 deletions refinery_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Incoming traffic is expected to be HTTP, so if SSL is a requirement, put somethi
- Type: `hostport`
- Default: `0.0.0.0:8080`
- Environment variable: `REFINERY_HTTP_LISTEN_ADDRESS`
- Command line switch: `--http-listen-addr`
- Command line switch: `--http-listen-address`

### `PeerListenAddr`

Expand All @@ -98,7 +98,7 @@ Incoming traffic is expected to be HTTP, so if using SSL use something like ngin
- Type: `hostport`
- Default: `0.0.0.0:8081`
- Environment variable: `REFINERY_PEER_LISTEN_ADDRESS`
- Command line switch: `--peer-listen-addr`
- Command line switch: `--peer-listen-address`

### `HoneycombAPI`

Expand Down Expand Up @@ -130,10 +130,10 @@ This list only applies to span traffic - other Honeycomb API actions will be pro

`AcceptOnlyListedKeys` is a boolean flag that causes events arriving with API keys not in the `ReceiveKeys` list to be rejected.

If `true`, then only traffic using the keys listed in `APIKeys` is accepted.
If `true`, then only traffic using the keys listed in `ReceiveKeys` is accepted.
Events arriving with API keys not in the `ReceiveKeys` list will be rejected with an HTTP `401` error.
If `false`, then all traffic is accepted and `ReceiveKeys` is ignored.
Must be specified if `APIKeys` is specified.
Must be specified if `ReceiveKeys` is specified.

- Eligible for live reload.
- Type: `bool`
Expand Down Expand Up @@ -879,7 +879,7 @@ Incoming traffic is expected to be unencrypted, so if using SSL, then put someth
- Not eligible for live reload.
- Type: `hostport`
- Environment variable: `REFINERY_GRPC_LISTEN_ADDRESS`
- Command line switch: `--grpc-listen-addr`
- Command line switch: `--grpc-listen-address`

### `MaxConnectionIdle`

Expand Down
6 changes: 3 additions & 3 deletions tools/convert/templates/configV2.tmpl
View file
Open in desktop
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 2023-06-22 at 23:17:29 UTC
# created {{ now }} from {{ .Input }} using a template generated on 2023-06-27 at 22:07:30 UTC

# This file contains the configuration for the Honeycomb Refinery.
# More stuff will go here later.
Expand Down Expand Up @@ -129,11 +129,11 @@ AccessKeys:
## AcceptOnlyListedKeys is a boolean flag that causes events arriving
## with API keys not in the `ReceiveKeys` list to be rejected.
##
## If `true`, then only traffic using the keys listed in `APIKeys` is
## If `true`, then only traffic using the keys listed in `ReceiveKeys` is
## accepted. Events arriving with API keys not in the `ReceiveKeys` list
## will be rejected with an HTTP `401` error.
## If `false`, then all traffic is accepted and `ReceiveKeys` is ignored.
## Must be specified if `APIKeys` is specified.
## Must be specified if `ReceiveKeys` is specified.
##
## Eligible for live reload.
{{ conditional .Data "AcceptOnlyListedKeys" "nostar APIKeys" }}
Expand Down