search

deepgram / deepgram-dotnet-sdk

.NET SDK for Deepgram's automated speech recognition APIs.
https://developers.deepgram.com
MIT License
33 stars 30 forks source link

Allow client to pass in their own serilog logger instance #287

Closed nganju98 closed 6 months ago

nganju98 commented 6 months ago

Hi, right now you're creating a log.txt file in my working directory which is not something I need there. Furthermore my actual logger writes to remote logging services etc. I've already got a carefully configured Serilog logger and I'd like your library to use the one I've already made.

The way you've made your library, it's quite easy to add this. Please accept my 3-line pull request. Thanks!

coderabbitai[bot] commented 6 months ago

Walkthrough

The update enhances the logging functionality by introducing a new Initialize method in the Log.cs file. This method allows setting the logger instance with an ILogger parameter, crucial for configuring the logger at the application's start to align logging behaviors with user specifications or system requirements.

Changes

File Path Change Summary
Deepgram/.../Log.cs Added public static void Initialize(ILogger logger)
Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 778c53fd3e72d5452eda38b808b79048768a6d71 and 67d05a7c9efb5198b3e8e35280fb35e214e23bc9.
Files selected for processing (1) * Deepgram/Logger/Log.cs (1 hunks)
Files skipped from review as they are similar to previous changes (1) * Deepgram/Logger/Log.cs
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
nganju98 commented 6 months ago

Thanks for the quick response!

Looks good, can you merge it so I can use yours instead of the fork I'm on? Thanks!

nganju98 commented 6 months ago

Ok pushed another version with PR feedback. Please merge, thanks!

davidvonthenen commented 6 months ago

Thanks for the contribution @nganju98

acidbubbles commented 5 months ago

This is nice, but not practical because it uses a static initializer. A lot of apps work with dependency injection, which is not statically injected (and easier to test when not using statics). I can't do another PR right now but I thought the feedback could be useful to the maintainers. In short, any kind of static accessor, even if practical, makes testing and IoC harder.

I would also recommend that you do not depend directly on Serilog, and instead depend on Microsoft.Extensions.Logging.Abstractions, which was made to allow libraries to receive any logging mechanism. I use Serilog, but I still rely on those abstractions.

davidvonthenen commented 5 months ago

This is nice, but not practical because it uses a static initializer. A lot of apps work with dependency injection, which is not statically injected (and easier to test when not using statics). I can't do another PR right now but I thought the feedback could be useful to the maintainers. In short, any kind of static accessor, even if practical, makes testing and IoC harder.

I would also recommend that you do not depend directly on Serilog, and instead depend on Microsoft.Extensions.Logging.Abstractions, which was made to allow libraries to receive any logging mechanism. I use Serilog, but I still rely on those abstractions.

Thanks for the feedback. When the logging was implemented, it was done so just to have some logging available. Previously, if something were to happen in the field, there was no real way to find out what was going on for a production system. This helps with that but as you pointed out, this is far from perfect. This PR also doesn't solve the root of this ask, as you mention. When we get more time, we will take a look at abstracting the logging and also provide a default logger in the event the user doesn't have an opinion.