Skip to content

Update headings in README for sensitive data sections #1383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TharmiganK merged 1 commit into from
Oct 9, 2025
Merged

Update headings in README for sensitive data sections #1383

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ballerina/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ The log module supports contextual logging, allowing you to create loggers with

For more details and advanced usage, see the module specification and API documentation.

## Sensitive Data Masking
### Sensitive Data Masking

The log module provides capabilities to mask sensitive data in log messages to maintain data privacy and security when dealing with personally identifiable information (PII) or other sensitive data.

Expand All @@ -134,7 +134,7 @@ The log module provides capabilities to mask sensitive data in log messages to m
> log:Logger secureLogger = log:fromConfig(secureConfig);
> ```

### Sensitive Data Annotation
#### Sensitive Data Annotation

Use the `@log:Sensitive` annotation to mark fields in records as sensitive. When such fields are logged, their values will be excluded or masked:

Expand All @@ -160,7 +160,7 @@ Output (with masking enabled):
time=2025-08-20T09:15:30.123+05:30 level=INFO module="" message="user details" user={"id":"U001","name":"John Doe"}
```

### Masking Strategies
#### Masking Strategies

Configure masking strategies using the `strategy` field:

Expand Down Expand Up @@ -192,7 +192,7 @@ type User record {
};
```

### Masked String Function
#### Masked String Function

Use `log:toMaskedString()` to get the masked version of a value for custom logging implementations:

Expand Down