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

Make log messages more self-explanatory #1321

Closed
kentquirk opened this issue Sep 11, 2024 · 0 comments · Fixed by #1322
Closed

Make log messages more self-explanatory #1321

kentquirk opened this issue Sep 11, 2024 · 0 comments · Fixed by #1322
Assignees
@MikeGoldsmith
Labels
type: enhancement New feature or request
Milestone
v2.9

Comments

@kentquirk
Copy link
Contributor

Quote from internal slack with a request to improve wording and documentation of some things:

A couple of requests where users see things and get concerned or don't get concerned when they should.

  • Channel buffer full, not adding span => Dropping it on the floor and it's never going anywhere
  • Evicting large trace ... => Evicting means sending to honeycomb

Not adding and evicting could mean anything in these contexts. Are there retries. Do evicted spans go in the trash or get decided or go to honeycomb?

Basic option, add these log lines to a list of log lines that mean stuff in Docs

Superior option, clarify the log with "Data loss" when there is data loss or "Delivering early" when there's no data loss. These are 2 examples but many other logs mean very harmless or very bad things and aren't necessarily clear to operators who need to run it but didn't write it.
@kentquirk kentquirk added the type: enhancement New feature or request label Sep 11, 2024
@kentquirk kentquirk added this to the v2.9 milestone Sep 11, 2024
@MikeGoldsmith MikeGoldsmith self-assigned this Sep 12, 2024
@MikeGoldsmith MikeGoldsmith mentioned this issue Sep 12, 2024
Merged
MikeGoldsmith added a commit that referenced this issue Sep 16, 2024
@MikeGoldsmith @kentquirk
feat: Improve log messages to be more informative (#1322)
ef1cd35 
## Which problem is this PR solving?

Improve some log messages to be more accurate about what's actually
happening.

- closes #1321

## Short description of the changes
- Improve log messages
- Prefer using WithField / WithString to include parameters instead of
inline formatting
- Update memory overrun messages from error -> warn - they do not
constitute data lost so error feels heavy handed

---------

Co-authored-by: Kent Quirk <kentquirk@honeycomb.io>
TylerHelmuth pushed a commit that referenced this issue Oct 16, 2024
@MikeGoldsmith @kentquirk @TylerHelmuth
feat: Improve log messages to be more informative (#1322)
f6589e1 
## Which problem is this PR solving?

Improve some log messages to be more accurate about what's actually
happening.

- closes #1321

## Short description of the changes
- Improve log messages
- Prefer using WithField / WithString to include parameters instead of
inline formatting
- Update memory overrun messages from error -> warn - they do not
constitute data lost so error feels heavy handed

---------

Co-authored-by: Kent Quirk <kentquirk@honeycomb.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MikeGoldsmith MikeGoldsmith

Labels
type: enhancement New feature or request
Projects
None yet
Milestone
v2.9
Development

Successfully merging a pull request may close this issue.

feat: Improve log messages to be more informative honeycombio/refinery
2 participants
@kentquirk @MikeGoldsmith