Skip to content

Commit

Permalink
docs: Generated Refinery docs for docs site improvements (#752)
Browse files Browse the repository at this point in the history
**Please do not merge until @kentquirk is able to advise and re-generate
the Refinery docs. Thank you!**

## Which problem is this PR solving?

This PR fixes noticed issues and adds improvements to the generated
Refinery docs.

## Short description of the changes

Improvements include:

- [x] fixing "random" double spaces in `rules.yaml`
- [x] reformatting of the intros for the `rules` and `config` docs site
files
- [x] removing the double "`groupName` `groupName`" for multiple Group
Names in generated `config` file -
- refer to double `LegacyMetrics` example:
https://github.com/honeycombio/refinery/blob/main/refinery_config.md#legacy-metrics
- [x] removing the "Name: `SAMPLER`" headers from generated `rules` file
- refer to example in:
https://github.com/honeycombio/refinery/blob/main/refinery_rules.md#name-deterministicsampler

---------

Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Co-authored-by: Kent Quirk <kentquirk@honeycomb.io>
  • Loading branch information
mjingle and kentquirk authored Jun 28, 2023
1 parent 09ae78a commit 63d03fd
Show file tree
Hide file tree
Showing 9 changed files with 432 additions and 447 deletions.
22 changes: 11 additions & 11 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 2023-06-27 at 22:07:32 UTC.
It was automatically generated on 2023-06-28 at 21:40:58 UTC.

## The Config file

Expand Down Expand Up @@ -139,7 +139,7 @@ This setting is the destination to which Refinery sends all events that it decid

## Access Key Configuration

`AccessKeys` Contains access keys -- API keys that the proxy will treat specially, and other flags that control how the proxy handles API keys.
`AccessKeys` contains access keys -- API keys that the proxy will treat specially, and other flags that control how the proxy handles API keys.

### `ReceiveKeys`

Expand Down Expand Up @@ -446,7 +446,7 @@ Only used if `Enabled` is `true` in `PrometheusMetrics`.

## Legacy Metrics

`LegacyMetrics` `LegacyMetrics` contains configuration for Refinery's legacy metrics.
`LegacyMetrics` contains configuration for Refinery's legacy metrics.
Version 1.x of Refinery used this format for sending Metrics to Honeycomb.
The metrics generated that way are nonstandard and will be deprecated in a future release.
New installations should prefer `OTelMetrics`.
Expand Down Expand Up @@ -504,7 +504,7 @@ Between 1 and 60 seconds is typical.

## OpenTelemetry Metrics

`OTelMetrics` `OTelMetrics` contains configuration for Refinery's OpenTelemetry (OTel) metrics.
`OTelMetrics` contains configuration for Refinery's OpenTelemetry (OTel) metrics.
This is the preferred way to send metrics to Honeycomb.
New installations should prefer `OTelMetrics`.

Expand Down Expand Up @@ -635,7 +635,7 @@ The format is a list of strings of the form "host:port".

## Redis Peer Management

`RedisPeerManagement` `RedisPeerManagement` controls how the Refinery cluster communicates between peers when using Redis.
`RedisPeerManagement` controls how the Refinery cluster communicates between peers when using Redis.
Only applies when `PeerManagement.Type` is "redis".

### `Host`
Expand Down Expand Up @@ -722,7 +722,7 @@ It is rarely necessary to adjust this value.

## Collection Settings

`Collection` `Collection` contains the settings that are relevant to collecting spans together to make traces.
`Collection` contains the settings that are relevant to collecting spans together to make traces.
If none of the memory settings are used, then Refinery will not attempt to limit its memory usage.
This is not recommended for production use since a burst of traffic could cause Refinery to run out of memory and crash.

Expand Down Expand Up @@ -783,7 +783,7 @@ See `MaxMemory` for more details.

## Buffer Sizes

`BufferSizes` `BufferSizes` contains the settings that are relevant to the sizes of communications buffers.
`BufferSizes` contains the settings that are relevant to the sizes of communications buffers.

### `UpstreamBufferSize`

Expand Down Expand Up @@ -848,7 +848,7 @@ Both keys and values must be strings.

## ID Fields

`IDFields` `IDFields` controls the field names to use for the event ID fields.
`IDFields` controls the field names to use for the event ID fields.
These fields are used to identify events that are part of the same trace.

### `TraceNames`
Expand All @@ -875,7 +875,7 @@ A trace without a `parent_id` is assumed to be a root span.

## gRPC Server Parameters

`GRPCServerParameters` `GRPCServerParameters` controls the parameters of the gRPC server used to receive OpenTelemetry data in gRPC format.
`GRPCServerParameters` controls the parameters of the gRPC server used to receive OpenTelemetry data in gRPC format.

### `Enabled`

Expand Down Expand Up @@ -957,7 +957,7 @@ This is the amount of time after which if the server does not see any activity,

## Sample Cache

`SampleCache` `SampleCache` controls the sample cache used to retain information about trace status after the sampling decision has been made.
`SampleCache` controls the sample cache used to retain information about trace status after the sampling decision has been made.

### `KeptSize`

Expand Down Expand Up @@ -996,7 +996,7 @@ Default is 10 seconds.

## Stress Relief

`StressRelief` `StressRelief` controls the Stress Relief mechanism, which is used to prevent Refinery from being overwhelmed by a large number of traces.
`StressRelief` controls the Stress Relief mechanism, which is used to prevent Refinery from being overwhelmed by a large number of traces.
There is a metric called `stress_level` that is emitted as part of Refinery metrics.
It is a measure of Refinery's throughput rate relative to its processing rate, combined with the amount of room in its internal queues, and ranges from `0` to `100`.
`stress_level` is generally expected to be `0` except under heavy load.
Expand Down
20 changes: 10 additions & 10 deletions config/metadata/configMeta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ groups:
- name: AccessKeys
title: "Access Key Configuration"
description: >
Contains access keys -- API keys that the proxy will treat specially, and
contains access keys -- API keys that the proxy will treat specially, and
other flags that control how the proxy handles API keys.
fields:
- name: ReceiveKeys
Expand Down Expand Up @@ -499,7 +499,7 @@ groups:
- name: LegacyMetrics
title: "Legacy Metrics"
description: >
`LegacyMetrics` contains configuration for Refinery's legacy metrics.
contains configuration for Refinery's legacy metrics.
Version 1.x of Refinery used this format for sending Metrics to
Honeycomb. The metrics generated that way are nonstandard and will be
deprecated in a future release. New installations should prefer
Expand Down Expand Up @@ -573,7 +573,7 @@ groups:
- name: OTelMetrics
title: "OpenTelemetry Metrics"
description: >
`OTelMetrics` contains configuration for Refinery's OpenTelemetry (OTel)
contains configuration for Refinery's OpenTelemetry (OTel)
metrics. This is the preferred way to send metrics to Honeycomb. New
installations should prefer `OTelMetrics`.
fields:
Expand Down Expand Up @@ -742,7 +742,7 @@ groups:
- name: RedisPeerManagement
title: "Redis Peer Management"
description: >
`RedisPeerManagement` controls how the Refinery cluster communicates
controls how the Refinery cluster communicates
between peers when using Redis. Only applies when `PeerManagement.Type`
is "redis".
Expand Down Expand Up @@ -886,7 +886,7 @@ groups:
- name: Collection
title: "Collection Settings"
description: >
`Collection` contains the settings that are relevant to collecting spans
contains the settings that are relevant to collecting spans
together to make traces. If none of the memory settings are used, then
Refinery will not attempt to limit its memory usage. This is not
recommended for production use since a burst of traffic could cause
Expand Down Expand Up @@ -967,7 +967,7 @@ groups:
- name: BufferSizes
title: "Buffer Sizes"
description: >
`BufferSizes` contains the settings that are relevant to
contains the settings that are relevant to
the sizes of communications buffers.
fields:
- name: UpstreamBufferSize
Expand Down Expand Up @@ -1087,7 +1087,7 @@ groups:
- name: IDFields
title: "ID Fields"
description: >
`IDFields` controls the field names to use for the event ID fields. These
controls the field names to use for the event ID fields. These
fields are used to identify events that are part of the same trace.
fields:
- name: TraceNames
Expand Down Expand Up @@ -1122,7 +1122,7 @@ groups:
- name: GRPCServerParameters
title: "gRPC Server Parameters"
description: >
`GRPCServerParameters` controls the parameters of the gRPC server used to
controls the parameters of the gRPC server used to
receive OpenTelemetry data in gRPC format.
fields:
- name: Enabled
Expand Down Expand Up @@ -1233,7 +1233,7 @@ groups:
- name: SampleCache
title: "Sample Cache"
description: >
`SampleCache` controls the sample cache used to retain information about trace status after the sampling decision has been made.
controls the sample cache used to retain information about trace status after the sampling decision has been made.
fields:
- name: Type
# we had a bug in the v1 config where this was implemented as `SampleCache` but documented as `SampleCacheConfig`;
Expand Down Expand Up @@ -1307,7 +1307,7 @@ groups:
- name: StressRelief
title: "Stress Relief"
description: >
`StressRelief` controls the Stress Relief mechanism, which is used to
controls the Stress Relief mechanism, which is used to
prevent Refinery from being overwhelmed by a large number of traces.
There is a metric called `stress_level` that is emitted as part of
Expand Down
Loading

0 comments on commit 63d03fd

Please sign in to comment.