This repository was archived by the owner on Sep 30, 2024. It is now read-only.
highlight: share log attributes with trace and handle canceled#61880
Merged
Conversation
While investigating a large number of errors in highlighting I noticed the vast majority where canceled. This commit adds special handling for it and in the process does a few other things to the observability here: - Log duration in these errors. This is useful signal to understand if a slow request is being canceled, or we have bad debouncing in a client. - Re-use the tracers logger. This has many more fields and avoids duplication. - Downgrade cancel error to warning. - Include error problem in logs. - Factor out the snippet log field creation. Note I didn't include snippet in the cancel log since it's unlikely to be related to the code being highlighted. Easy to add in if we find that is incorrect. Test Plan: CI will exercise this code path. Otherwise I will follow-up on dotcom.
Member
Author
|
@camdencheek any idea why you only emit errors to honeycomb? I am guessing error logging/metrics/traces would be useful here? https://github.com/sourcegraph/sourcegraph/blob/be908b2135b35d3afc5e36434a08a98212657187/internal/highlight/highlight.go#L54 |
mmanela
approved these changes
Apr 15, 2024
sourcegraph-release-bot
pushed a commit
that referenced
this pull request
Apr 15, 2024
While investigating a large number of errors in highlighting I noticed the vast majority where canceled. This commit adds special handling for it and in the process does a few other things to the observability here: - Log duration in these errors. This is useful signal to understand if a slow request is being canceled, or we have bad debouncing in a client. - Re-use the tracers logger. This has many more fields and avoids duplication. - Downgrade cancel error to warning. - Include error problem in logs. - Factor out the snippet log field creation. Note I didn't include snippet in the cancel log since it's unlikely to be related to the code being highlighted. Easy to add in if we find that is incorrect. Test Plan: CI will exercise this code path. Otherwise I will follow-up on dotcom. (cherry picked from commit b89b99c)
keegancsmith
added a commit
that referenced
this pull request
Apr 15, 2024
…ndle canceled (#61889) highlight: share log attributes with trace and handle canceled (#61880) While investigating a large number of errors in highlighting I noticed the vast majority where canceled. This commit adds special handling for it and in the process does a few other things to the observability here: - Log duration in these errors. This is useful signal to understand if a slow request is being canceled, or we have bad debouncing in a client. - Re-use the tracers logger. This has many more fields and avoids duplication. - Downgrade cancel error to warning. - Include error problem in logs. - Factor out the snippet log field creation. Note I didn't include snippet in the cancel log since it's unlikely to be related to the code being highlighted. Easy to add in if we find that is incorrect. Test Plan: CI will exercise this code path. Otherwise I will follow-up on dotcom. (cherry picked from commit b89b99c) Co-authored-by: Keegan Carruthers-Smith <keegan.csmith@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
While investigating a large number of errors in highlighting I noticed the vast majority where canceled. This commit adds special handling for it and in the process does a few other things to the observability here:
Note I didn't include snippet in the cancel log since it's unlikely to be related to the code being highlighted. Easy to add in if we find that is incorrect.
Test Plan: CI will exercise this code path. Otherwise I will follow-up on dotcom.