Conversation
Summary of ChangesHello @enisdenjo, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the documentation for the Hive Logger by adding a dedicated section on redacting sensitive information. The new content provides clear explanations and practical code examples for configuring the logger to prevent sensitive data, such as passwords and authentication tokens, from being exposed in logs, thereby improving security and data privacy practices. Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the new redact option in the Hive Logger, which allows for redacting sensitive information from logs. The documentation is clear and provides good examples. I have one suggestion to improve the clarity of the 'Key Removal' example to avoid potential confusion for users regarding the final log output.
| password: 'super-secret', | ||
| headers: { authorization: 'Bearer token', host: 'example.com' } | ||
| }) | ||
| // attrs: { password: undefined, headers: { authorization: undefined, host: 'example.com' } } |
There was a problem hiding this comment.
The example output here can be a bit confusing. While it correctly shows the in-memory state of the attrs object with undefined values, this is not what a user would see in their logs. The callout explains that undefined values are omitted, but for clarity and consistency with other logging examples in this file, the example output should reflect the final serialized state.
This makes it immediately clear what the result of using remove: true is.
// attrs in the final log: { headers: { host: 'example.com' } }
💻 Website PreviewThe latest changes are available as preview in: https://pr-7674.hive-landing-page.pages.dev |
|
🐋 This PR was built and pushed to the following Docker images: Targets: Platforms: Image Tag: |
graphql-hive/gateway#1942