streaming: Remove logging pair and key on failure #145

ptrenwith · 2024-09-12T12:50:33Z

Consolidate logging.

Summary by CodeRabbit

Style
- Simplified connection error log messages for a cleaner output by removing specific connection details.

andrewwormald · 2024-09-12T12:59:12Z

streaming/streaming.go

@@ -151,8 +151,7 @@ func (c *Conn) manageForever() {

 	for {
 		if err := c.connect(); err != nil {
-			log.Printf("luno/streaming: Connection error key=%s pair=%s: %v",
-				c.keyID, c.pair, err)
+			log.Printf("luno/streaming: Connection error: %v", err)


log/slog is available (maybe not for the version we support for luno-go so you can log parameters.

I think using slog will defeat the purpose of this change.

Is the purpose only be able to collect all logs through searching "luno/streaming: Connection error:" on something like Kibana or is it to consolidate metrics?

Was going to say we can keep pair, but don't know if it's that useful for this error? 🤔

The purpose is to collate the logs. The pair and key is not particularly useful.

echarrod · 2024-09-12T18:23:04Z

streaming/streaming.go

@@ -151,8 +151,7 @@ func (c *Conn) manageForever() {

 	for {
 		if err := c.connect(); err != nil {
-			log.Printf("luno/streaming: Connection error key=%s pair=%s: %v",
-				c.keyID, c.pair, err)
+			log.Printf("luno/streaming: Connection error: %v", err)


Was going to say we can keep pair, but don't know if it's that useful for this error? 🤔

andrewwormald · 2025-03-12T10:18:29Z

@ptrenwith is this still needed?

Copilot

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

streaming/streaming.go:154

Removing key and pair information might reduce diagnostic detail; please confirm that the consolidated log message still provides sufficient context for troubleshooting connection errors.

log.Printf("luno/streaming: Connection error: %v", err)

echarrod · 2025-06-18T13:07:50Z

@CodeRabbit review

coderabbitai · 2025-06-18T13:07:56Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2025-06-18T13:07:59Z

Walkthrough

The log message within the manageForever method of the Conn struct in streaming/streaming.go was modified. The updated log now provides a simplified output by only displaying a generic "Connection error" message along with the error details, removing the previously included keyID and pair information. No changes were made to any exported or public entities.

Poem

A hop and a skip through the streaming log,
Less cluttered now, like a clear morning fog.
No more keyID or pair in sight,
Just "Connection error"—simple and light.
🐇✨

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- 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 explain this code block.
- @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

streaming/streaming.go (1)

154-155: Consider emitting market pair at debug level to aid correlation

Dropping keyID removes potential credential leakage – good move.
However, completely omitting pair makes it trickier to correlate connection issues when the process is multiplexing several markets.
A middle-ground could be to log pair under a lower verbosity (e.g., log.Printf("luno/streaming DEBUG: %s connection error: %v", c.pair, err) behind a build tag or a -v flag).

No change strictly required, but worth considering.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3471800 and f60ac45.

📒 Files selected for processing (1)

streaming/streaming.go (1 hunks)

streaming: Remove logging pair and key on failure

6063997

andrewwormald reviewed Sep 12, 2024

View reviewed changes

echarrod approved these changes Sep 12, 2024

View reviewed changes

echarrod requested a review from Copilot April 11, 2025 13:40

Copilot AI reviewed Apr 11, 2025

View reviewed changes

Merge branch 'main' into patch-1

f60ac45

coderabbitai bot reviewed Jun 18, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

streaming: Remove logging pair and key on failure #145

streaming: Remove logging pair and key on failure #145

Uh oh!

ptrenwith commented Sep 12, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

andrewwormald Sep 12, 2024

Uh oh!

NeilLuno Sep 12, 2024

Uh oh!

andrewwormald Sep 12, 2024

Uh oh!

echarrod Sep 12, 2024

Uh oh!

ptrenwith Sep 13, 2024

Uh oh!

echarrod Sep 12, 2024

Uh oh!

andrewwormald commented Mar 12, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

echarrod commented Jun 18, 2025

Uh oh!

coderabbitai bot commented Jun 18, 2025

Uh oh!

coderabbitai bot commented Jun 18, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

streaming: Remove logging pair and key on failure #145

Are you sure you want to change the base?

streaming: Remove logging pair and key on failure #145

Uh oh!

Conversation

ptrenwith commented Sep 12, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

andrewwormald Sep 12, 2024

Choose a reason for hiding this comment

Uh oh!

NeilLuno Sep 12, 2024

Choose a reason for hiding this comment

Uh oh!

andrewwormald Sep 12, 2024

Choose a reason for hiding this comment

Uh oh!

echarrod Sep 12, 2024

Choose a reason for hiding this comment

Uh oh!

ptrenwith Sep 13, 2024

Choose a reason for hiding this comment

Uh oh!

echarrod Sep 12, 2024

Choose a reason for hiding this comment

Uh oh!

andrewwormald commented Mar 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

echarrod commented Jun 18, 2025

Uh oh!

coderabbitai bot commented Jun 18, 2025

Uh oh!

coderabbitai bot commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ptrenwith commented Sep 12, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 18, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)