Implements Logging Strategy

dvonthenen commented 6 months ago

Addresses the following issues: https://github.com/deepgram/deepgram-dotnet-sdk/issues/219

This implements the logging strategy to be used in this SDK. By default we will log informational messages so we can troubleshoot basic issues. Otherwise, you can enable more levels of debug to troubleshoot.

A side quest...

KeepAlives for LiveClient was implemented in this PR.
httpId which just allows creating multiple clients.
Since I had to go through every line of code to add trace statements, I used this opportunity to clean up a lot of the code. This is by no means complete and there is still an outstanding issue open to track this https://github.com/deepgram/deepgram-dotnet-sdk/issues/210

All examples updated to show how to use the logging functionality.

Summary by CodeRabbit

New Features
- Enhanced logging across various components for improved debugging and information purposes.
- Added httpId parameter to constructors for better tracking of HTTP requests.
- Introduced logging functionality with different log levels.
- Added licensing information and updated copyright notices.
Refactor
- Removed unnecessary logging and TODO comments.
- Refactored methods for better error handling and cancellation logic.
- Adjusted StreamCallbackResult logic in microphone operations.
Chores
- Updated namespace declarations and access modifiers.
- Added and updated package references for logging capabilities.
Documentation
- Added summary comments for classes and methods.
- Updated examples with licensing information and initialized logging options.

coderabbitai[bot] commented 6 months ago

Walkthrough

The update primarily focuses on enhancing logging capabilities across various components of the Deepgram .NET SDK. It introduces a more structured logging approach by integrating Serilog for better debugging and information tracking. Additionally, the update includes copyright updates, removal of unnecessary logging and TODO comments, and improvements in error handling and operation logic. A notable change is the addition of an httpId parameter in several constructors to aid in logging and tracking HTTP requests.

Changes

Files	Change Summary
`Deepgram.Microphone/Constants.cs`, `.../Library.cs`, `.../Microphone.cs`	License and copyright updates; removed unnecessary logging and TODO comments; improved operation logic.
`Deepgram/Abstractions/AbstractRestClient.cs`, `.../LocalFileWithMetadata.cs`, `.../NoopSchema.cs`, `.../Utilities.cs`	Enhanced logging with `httpId` parameter; updated copyright; added comments.
`Deepgram/AnalyzeClient.cs`, `.../Clients/Analyze/v1/Client.cs`, `.../Live/v1/Client.cs`, `.../Manage/v1/Client.cs`, `.../OnPrem/v1/Client.cs`, `.../PreRecorded/v1/Client.cs`, `.../Speak/v1/Client.cs`	Added `httpId` parameter; improved logging and error handling.
`Deepgram/Deepgram.csproj`	Added `Serilog` packages for logging.
`Deepgram/Factory/HttpClientFactory.cs`, `.../ManageClient.cs`, `.../OnPremClient.cs`, `.../PreRecordedClient.cs`, `.../SpeakClient.cs`	Logging enhancements and `httpId` parameter adjustments.
`Deepgram/Logger/Constants.cs`, `.../Log.cs`, `.../Library.cs`	Introduced and refactored logging functionality.
`examples/...` (all example programs)	Licensing info addition; Deepgram library initialization and teardown with logging options; updated namespace imports.
`Deepgram/Utilities/QueryParameterUtil.cs`, `.../UserAgentUtil.cs`	Added utility methods; minor documentation adjustments.
`Deepgram/GlobalSuppressions.cs`, `.../GlobalUsings.cs`	Removed unnecessary suppressions and global using directives.

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/coderabbit-overrides.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.

dvonthenen commented 6 months ago

@coderabbitai review

deepgram / deepgram-dotnet-sdk