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.

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

maint: README updates -- round 1 #742

Merged
merged 5 commits into from
Jun 27, 2023
Merged

maint: README updates -- round 1 #742

merged 5 commits into from
Jun 27, 2023

Conversation

cartermp
Copy link
Member

First in a ...series?... of rounds of PRs to get the README to be more accurate w.r.t. Refinery 2.0, modern use cases, and what it gives you.

@cartermp cartermp requested a review from a team as a code owner June 23, 2023 23:31
@cartermp cartermp changed the title README updates -- round 1 maint: README updates -- round 1 Jun 23, 2023

* **Dynamic sampling** - By configuring a set of fields on a trace that make up a key, the sampler automatically increases or decreases the sampling rate based on how frequently each unique value of that key occurs. For example, a key made up of `http.status_code` will sample much less traffic for requests that return 200 than for requests that return `404`.
* **Rules-based sampling** - This enables you to define sampling rates for well-known conditions. For example, you can sample 100% of traces with an error and then fall back to dynamic sampling for all other traffic.
* **Throughput-based sampling** - This enables you to sample traces based on a fixed upper bound on the number of spans per second. The sampler will sample traces with a goal to keep the throughput below the specified limit.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should callout the new WindowedThroughput sampler here, it is the one that really helps with rate limiting.

README.md Outdated Show resolved Hide resolved
cartermp and others added 2 commits June 25, 2023 08:53
Co-authored-by: Kent Quirk <kentquirk@honeycomb.io>
@cartermp
Copy link
Member Author

Will follow up with more this week, including more descriptions of the samplers.

@cartermp cartermp merged commit 01c0b7a into main Jun 27, 2023
@cartermp cartermp deleted the cartermp/refinery-updates branch June 27, 2023 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants