hiero-ledger / hiero-ledger/hiero-consensus-node

Review all logging statements

Open
#2,819 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
406
Forks
226
Avg merge
3d 4h
Merged PRs (30d)
210

Description

### Problem

Log statements should be valid, at the right level, and not contain user supplied data.

### Solution

Review all logging statements to verify:

1. Correct log level is used
2. Useful and correct information is being logged
3. No user supplied data is being logged

Any exception to point 3 must be reviewed for safety and protection of user data. Being a distributed public ledger, the data being logged may be public knowledge, but if used as a private ledger it may no longer be appropriate to log that information. In any event, we need to make sure the user supplied code is scrubbed and safe from exploits in the logging system AND in any system that parses those logs. The less user supplied data we log, the better.

### Alternatives

_No response_

Contributor guide

Open the contributing guide

Research direction

Start by inventorying the repository's logging statements, since the issue names no specific files or tests. Review each statement for log level, usefulness, correctness, and user-supplied data; done means all statements are checked and any exception is reviewed for safety and log-parser exposure.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
distributed-systems, security
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.