just adding more logs for failing events storage

[Baalmart]

Description

just adding more logs for failing events storage

Changes Made

• just adding more logs for failing events storage
• Renaming the jsonify util to stringify

Testing

• Tested locally
• Tested against staging environment
• Relevant tests passed: [List test names]

Affected Services

• Which services were modified:
  • Device Registry

Endpoints Ready for Testing

• New endpoints ready for testing:
  • Store Events

API Documentation Updated?

• Yes, API documentation was updated
• No, API documentation does not need updating

Additional Notes

just adding more logs for failing events storage

Summary by CodeRabbit

• Bug Fixes

  • Improved error logging and message formatting across various modules by standardizing JSON serialization with the new stringify utility.

• New Features

  • Enhanced logging practices for better clarity and consistency in error handling and data processing.

• Chores

  • Updated import statements to reflect the change from jsonify to stringify in multiple files.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in this pull request primarily involve replacing the jsonify utility function with the stringify function across multiple files in the device registry module. This modification affects how error messages and data are logged, particularly in functions related to Kafka operations and error handling. While the overall structure and logic of the affected functions remain unchanged, the way data is formatted for logging has been updated to utilize the new utility.

Changes

File Path	Change Summary
src/device-registry/bin/index.js	Replaced jsonify with stringify in error handling and logging statements.
src/device-registry/bin/jobs/kafka-consumer.js	Replaced jsonify with stringify in logging statements for messages and error details.
src/device-registry/bin/jobs/new-store-readings-job.js	Replaced jsonify with stringify in multiple logging statements related to error handling.
src/device-registry/bin/jobs/store-readings-job.js	Replaced jsonify with stringify in error logging within the asyncRetry function.
src/device-registry/bin/jobs/store-signals-job.js	Replaced jsonify with stringify in error logging within the asyncRetry function.
src/device-registry/bin/server.js	Replaced jsonify with stringify in error logging for various HTTP error statuses.
src/device-registry/utils/create-event.js	Replaced jsonify with stringify in error handling and logging across multiple functions.
src/device-registry/utils/create-grid.js	Replaced jsonify with stringify in Kafka message construction for sending data.

Possibly related PRs

• just adding more error handling for the store readings job #3470: Modifies store-readings-job.js, directly related to changes in the main PR involving jsonify and stringify.
• reconfiguring the store readings operation #3473: Introduces a new job in new-store-readings-job.js, with logging changes similar to those in the main PR.
• adding gaseous sensors to device registry #3503: Enhances error logging in kafka-consumer.js, relevant to logging changes in the main PR.
• Hotfix slack notifs - ensures that the Slack logs remain concise and focused #3527: Modifies new-store-readings-job.js, relevant as it also deals with logging enhancements.
• just adding more logging for field activity emailing functions #3560: Enhances logging in kafka-consumer.js, relevant to logging changes in the main PR.
• just add new icons for kafka logs #3562: Focuses on logging enhancements in kafka-consumer.js, making it relevant to the main PR's logging changes.
• adjusting the error log statement #3584: Adjusts the error log statement in preferences-log-job.js, focusing on improving logging clarity, similar to the main PR's objectives.

Suggested reviewers

• NicholasTurner23
• BenjaminSsempala

🌟 In code we trust, with logs so bright,
Replacing jsonify, we set things right.
With stringify now, our errors align,
In Kafka's embrace, our messages shine!
So here's to the changes, both subtle and grand,
A cleaner log world, all perfectly planned! 🌟

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • 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 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 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 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.

[codecov]

Codecov Report

Attention: Patch coverage is 17.14286% with 29 lines in your changes missing coverage. Please review.

Project coverage is 29.61%. Comparing base (cd41905) to head (5219e28).
Report is 2 commits behind head on staging.

Files with missing lines	Patch %	Lines
src/device-registry/utils/create-event.js	5.00%	19 Missing ⚠️
src/device-registry/bin/server.js	16.66%	5 Missing ⚠️
...device-registry/bin/jobs/new-store-readings-job.js	25.00%	3 Missing ⚠️
src/device-registry/bin/jobs/kafka-consumer.js	33.33%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           staging    #3593      +/-   ##
===========================================
- Coverage    29.61%   29.61%   -0.01%     
===========================================
  Files          184      184              
  Lines        25022    25023       +1     
  Branches      3327     3327              
===========================================
  Hits          7411     7411              
- Misses       17484    17485       +1     
  Partials       127      127              

Files with missing lines	Coverage Δ
src/device-registry/bin/jobs/store-signals-job.js	25.49% <100.00%> (ø)
src/device-registry/utils/create-grid.js	12.86% <100.00%> (ø)
src/device-registry/utils/stringify.js	40.90% <ø> (ø)
src/device-registry/bin/jobs/kafka-consumer.js	27.11% <33.33%> (ø)
...device-registry/bin/jobs/new-store-readings-job.js	17.64% <25.00%> (ø)
src/device-registry/bin/server.js	50.46% <16.66%> (ø)
src/device-registry/utils/create-event.js	14.96% <5.00%> (-0.02%)	⬇️

[github-actions]

Device registry changes in this PR available for preview here