Skip to content

docs: Redacting sensitive data from Hive Logger's output#7674

Open
enisdenjo wants to merge 1 commit intomainfrom
logredact
Open

docs: Redacting sensitive data from Hive Logger's output#7674
enisdenjo wants to merge 1 commit intomainfrom
logredact

Conversation

@enisdenjo
Copy link
Member

@enisdenjo enisdenjo marked this pull request as draft February 10, 2026 15:59
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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

  • Documentation for Sensitive Data Redaction: A new comprehensive section has been added to the Hive Logger documentation, detailing the redact option for handling sensitive information.
  • Redaction Configuration Examples: The documentation now includes practical examples demonstrating how to configure redaction using path arrays, custom censor strings, censor functions, and complete key removal.
Changelog
  • packages/web/docs/src/content/logger.mdx
    • Added a new top-level section titled "Redacting Sensitive Information" to the logger documentation.
    • Included detailed examples for configuring redaction with array of paths, custom censor strings, censor functions, and key removal.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions
Copy link
Contributor

🚀 Snapshot Release (alpha)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package Version Info
hive 9.4.1-alpha-20260210160000-8f0018665e33510876210cd6961ac81a094d38ed npm ↗︎ unpkg ↗︎

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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' } }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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' } }

@github-actions
Copy link
Contributor

💻 Website Preview

The latest changes are available as preview in: https://pr-7674.hive-landing-page.pages.dev

@github-actions
Copy link
Contributor

github-actions bot commented Feb 10, 2026

🐋 This PR was built and pushed to the following Docker images:

Targets: build

Platforms: linux/amd64

Image Tag: 8f0018665e33510876210cd6961ac81a094d38ed

@enisdenjo enisdenjo added the waiting-on:gateway-release Do not merge: wait for the gateway release label Feb 25, 2026
@enisdenjo enisdenjo marked this pull request as ready for review February 25, 2026 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

waiting-on:gateway-release Do not merge: wait for the gateway release

Development

Successfully merging this pull request may close these issues.

1 participant