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

Add additional logging #71

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add additional logging #71

wants to merge 4 commits into from

Conversation

mmanela
Copy link
Contributor

@mmanela mmanela commented Jan 15, 2025

Add additional logging to help diagnose potential customer issues

@mmanela mmanela requested a review from a team January 15, 2025 20:00
Comment on lines +157 to +160
Logger.LogWarning(
"Skipping document {DocumentFilePath} because it has language {DocumentLanguage} and scip-dotnet currently only supports C# and Visual Basic.",
document.FilePath, language);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we get automatic warning suppression somehow? If not, please record this kind of warning in a "limited array" type (where you can push a fixed number of elements, and further attempts to push just bump a counter) instead of emitting it on the fly.

Here's an example of the kind of API you can define: https://sourcegraph.sourcegraph.com/github.com/sourcegraph/scip_v2_demo/-/blob/fill_db/scipext/context.go?L20:27-20:33#tab=references

I'm afraid that if a project has mixed C#-F#, then trying to index code should not trigger thousands of repetitive warnings which the user has to filter out. Instead, we should have just one warning with a handful of examples (e.g. say 3-5) as well as a count of how many files were skipped.

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.

2 participants