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

Jump to bottom

docs: document default intervals for samplers #992

Closed
kentquirk opened this issue Feb 13, 2024 · 0 comments · Fixed by #995
Closed

docs: document default intervals for samplers #992

kentquirk opened this issue Feb 13, 2024 · 0 comments · Fixed by #995
Assignees
@MikeGoldsmith
Labels
type: bug Something isn't working

Comments

@kentquirk
Copy link
Contributor

Steps to reproduce

Customer says:

I'm wondering what the default Refinery "window" is. I know that the EMA Dynamic Sampler has an AdjustmentInterval value that can be set. The docs have an example of "30s" or "1m" but it does not state what the default is.

Additional context

Defaults are in the dynsampler-go repository but should be documented in refinery docs.
@kentquirk kentquirk added the type: bug Something isn't working label Feb 13, 2024
@MikeGoldsmith MikeGoldsmith mentioned this issue Feb 14, 2024
Merged
@MikeGoldsmith MikeGoldsmith self-assigned this Feb 14, 2024
MikeGoldsmith added a commit that referenced this issue Feb 14, 2024
@MikeGoldsmith
docs: Add sampler default intervals to docs (#995)
80fc7da 
## Which problem is this PR solving?
Updates refinery rules metadata to include the default intervals for
each of the sampler types. `rulesmeta.md` was updated manually and the
other files were re-generated using the conver tool.

- Closes #992 

## Short description of the changes
- Update each sampler to include the default interval
-
[DynamicSampler](https://github.com/honeycombio/dynsampler-go/blob/main/avgsamplerate.go#L30)
&
[TotalThroughputSampler](https://github.com/honeycombio/dynsampler-go/blob/main/totalthroughput.go#L31)
-> 30s
-
[EMADynamicSampler](https://github.com/honeycombio/dynsampler-go/blob/main/emasamplerate.go#L41)
&
[EMAThroughputSampler](https://github.com/honeycombio/dynsampler-go/blob/main/emathroughput.go#L38)
-> 15s
-
[WindowedThroughputSampler](https://github.com/honeycombio/dynsampler-go/blob/main/windowedthroughput.go#L34)
-> 1s
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MikeGoldsmith MikeGoldsmith

Labels
type: bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Add sampler default intervals to docs honeycombio/refinery
2 participants
@kentquirk @MikeGoldsmith