Skip to content
This repository was archived by the owner on Feb 6, 2026. It is now read-only.

feat: ingest structured logs using stdout in LoggingHandler - #812

Merged
minherz merged 12 commits into
minherz/structured_loggingfrom
minherz/800
Jan 1, 2022
Merged

feat: ingest structured logs using stdout in LoggingHandler#812
minherz merged 12 commits into
minherz/structured_loggingfrom
minherz/800

Conversation

@minherz

@minherzminherz commented Dec 30, 2021•
edited
Loading

Copy link
Copy Markdown
Contributor

Add configuration (edited:) redirectoToStdoutuseStructuredLogging to LoggingHandler class to support an option to print logs to STDOUT formatted as a one line Json and following the structured logging guidelines.
Implement Jsonification of the LogEntry object following the structured logging format.
Move metadata population to a standalone API to be used by LoggingHandler explicitly.

@minherz
feat: serialize LogEntry to oneline Json string
c12a97f
resolve warnings
change type for trace an spanId to be strings
create more realistic and visual test data:
- timestamp with more recent date
- json payload with various data types
@minherz
chore: add populateMetadata API to Logging
bfa5457
@minherz
chore: add useStructuredLogging configuration
a012d38
@minherz
chore: add useStructuredLogging flag to LoggingHandler
5eb9dce
refactor setAutoPopulateMetadata() to avoid setting flag to null
@minherz
chore: refactor write() by implementing populateMetadata()
c257320
implement populateMetadata() API.
change write() to use the new API.
refactor SourceLocation.fromCurrentContext() to use a list of exclusion
prefixes instead of depth level as parameter.
change relevant unit tests to support the refactored changes.
@minherz
chore: print structured logging
8e26194
modify publish() method to print structured logging if configured instead
of calling to Logging.write().
populate created LogEntry instance with metadata separately instead of
adding WriteOption.AUTO_POPULATE_METADATA.
refactor LoggingHandler to remove getLogging() method.
refactor unit tests to reflect the change in LoggingHandler.publish() implementation.
@minherz
chore: add unit testing for structured logging
2dcd7fb
refactor LoggingHandlerTest.
@minherzminherz self-assigned this Dec 30, 2021
@minherz
minherz requested review from a teamDecember 30, 2021 09:21
@product-auto-labelproduct-auto-labelBot added size: m Pull request size is medium. api: logging Issues related to the googleapis/java-logging API. labels Dec 30, 2021
@minherzminherz mentioned this pull request Dec 30, 2021
Merged
@minherz
minherz requested a review from losalexDecember 30, 2021 09:23
losalex
losalex reviewed Dec 30, 2021
View reviewed changes

@losalexlosalex left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for your effort - good job! I left some comments, PTAL and let me know if those makes sense

Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LogEntry.java
Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LogEntry.java
Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LogEntry.java
Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LogEntry.java
Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LogEntry.java
Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LogEntry.java Outdated
Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LoggingHandler.java Outdated
Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LoggingImpl.java
Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LoggingImpl.java Outdated
Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LoggingImpl.java Outdated
losalex
losalex approved these changes Jan 1, 2022
View reviewed changes

@losalexlosalex left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overall looks good - just fix whatever we agreed in comments. Also left some clarification regarding incomplete comment, hope it make sense

Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LogEntry.java
Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LogEntry.java Outdated
}

/**
* Adds a collection of Json fields that {@code value} parameter is serialized to to the current

@losalexlosalexJan 1, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes, I think name change like appendDictionary will be fine then

Comment threadgoogle-cloud-logging/src/main/java/com/google/cloud/logging/LogEntry.java Outdated
} else if (payload.getType() == Type.JSON) {
Payload.JsonPayload jsonPayload = (Payload.JsonPayload) payload;
formatter.appendJson(jsonPayload.getDataAsMap(), true);
} else if (payload.getType() == Type.PROTO) {

@losalexlosalexJan 1, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you!

@minherz
minherz merged commit 749b9d2 into minherz/structured_loggingJan 1, 2022
@minherz
minherz deleted the minherz/800 branch January 1, 2022 17:27
@minherzminherz mentioned this pull request Jan 1, 2022
Closed
4 tasks
@minherzminherz changed the title feat: support structured logging in LoggingHandler using configurationfeat: ingest structured logs using stdout in LoggingHandlerJan 2, 2022
minherz added a commit that referenced this pull request Jan 4, 2022
@minherz
feat: support structured logging in LoggingHandler using configuration (
0c717d3
#812)
Implements populateMetadata() API.
Changes Logging.write() API to populate the provided list of log entries using the new API.
Refactors SourceLocation.fromCurrentContext() to use a list of exclusion instead of the call stack depth level as parameter.
Adds configuration `populateToStdout` to `LoggingConfig`.
Use the new configuration within `LoggingHandler` to print to STDOUT instead of ingesting the log by calling Logging.write().
Refactor LoggingImpl, LoggingHandler and unit tests.
minherz added a commit that referenced this pull request Jan 5, 2022
@minherz
feat: support structured logging in LoggingHandler using configuration (
735275f
#812)
Implements populateMetadata() API.
Changes Logging.write() API to populate the provided list of log entries using the new API.
Refactors SourceLocation.fromCurrentContext() to use a list of exclusion instead of the call stack depth level as parameter.
Adds configuration `populateToStdout` to `LoggingConfig`.
Use the new configuration within `LoggingHandler` to print to STDOUT instead of ingesting the log by calling Logging.write().
Refactor LoggingImpl, LoggingHandler and unit tests.
minherz added a commit that referenced this pull request Jan 7, 2022
@minherz@gcf-owl-bot
feat: enable auto-population of missing metadata in logs and opting l…
bb25d5d
…ogs redirection to stdout in JUL handler (#808)
Aggregates the following work:
- #821
- #812
- #807
- #803
- #798Fixes#689, #691, #799 and #800
* 🦉 Updates from OwlBot
See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer
@losalexlosalexlosalex approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@minherzminherz

Labels

api: loggingIssues related to the googleapis/java-logging API.size: mPull request size is medium.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@minherz@losalex