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: update config docs for compatability of using DryRun and EnableTraceLocality together #1418

Merged
merged 4 commits into from
Nov 8, 2024
Merged

docs: update config docs for compatability of using DryRun and EnableTraceLocality together #1418

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7d1d1c
docs: update config docs for compatability of using DryRun and Enable…
MikeGoldsmith Nov 8, 2024
a61e087
Merge branch 'main' into mike/dryrun-docs
MikeGoldsmith Nov 8, 2024
94f5ab4
Merge branch 'main' into mike/dryrun-docs
VinozzZ Nov 8, 2024
6d8bad5
fix couple config reload compatibility
VinozzZ Nov 8, 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
12 changes: 9 additions & 3 deletions config/metadata/configMeta.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,10 @@ groups:
`meta.refinery.dryrun.sample_rate` will be set to the sample rate
that would have been used.

NOTE: This settng is not compatible with `EnableTraceLocality` set to
false because drop trace decisions shared among peers does not contain
all relevant information to send traces to Honeycomb.

- name: Logger
title: "Refinery Logger"
description: contains configuration for logging.
Expand Down Expand Up @@ -1341,11 +1345,13 @@ groups:
valuetype: nondefault
firstversion: v2.9
default: false
reload: true
reload: false
summary: controls whether all spans that belongs to the same trace are sent to a single Refinery for processing.
description: >
If `true`, Refinery's will route all spans that belongs to the same trace to a single peer.

NOTE: This setting is not compatible with `DryRun` when set to false. See `DryRun` for more information.

- name: HealthCheckTimeout
type: duration
valuetype: nondefault
Expand All @@ -1371,7 +1377,7 @@ groups:
valuetype: nondefault
firstversion: v2.9
default: 1s
reload: false
reload: true
summary: Interval for sending drop decisions in batches.
description: >
Sets the time interval for sending accumulated drop decisions in batches. This ensures that drop decisions are processed at regular intervals, improving efficiency by reducing the frequency of network transmissions. If the maximum batch size (MaxDropDecisionBatchSize) is reached before this interval elapses, the batch will be sent immediately.
Expand All @@ -1391,7 +1397,7 @@ groups:
valuetype: nondefault
firstversion: v2.9
default: 100ms
reload: false
reload: true
summary: Interval for sending kept decisions in batches.
description: >
Sets the time interval for sending accumulated kept decisions in batches. This ensures that kept decisions are processed at regular intervals, improving efficiency by reducing the frequency of network transmissions. If the maximum batch size (MaxKeptDecisionBatchSize) is reached before this interval elapses, the batch will be sent immediately.
Expand Down