Skip to content
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.

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

fix: Correct the JSON time field name #1020

Merged
merged 2 commits into from
Aug 19, 2022

Conversation

bpcreech
Copy link
Contributor

Fixes #1019

@bpcreech bpcreech requested review from a team as code owners July 30, 2022 22:47
@conventional-commit-lint-gcf
Copy link

conventional-commit-lint-gcf bot commented Jul 30, 2022

🤖 I detect that the PR title and the commit message differ and there's only one commit. To use the PR title for the commit history, you can use Github's automerge feature with squashing, or use automerge label. Good luck human!

-- conventional-commit-lint bot
https://conventionalcommits.org/

@product-auto-label product-auto-label bot added size: xs Pull request size is extra small. api: logging Issues related to the googleapis/java-logging API. labels Jul 30, 2022
@losalex losalex self-assigned this Jul 31, 2022
@losalex losalex changed the title Correct the JSON time field name fix: Correct the JSON time field name Aug 10, 2022
@@ -700,7 +700,7 @@ public String toStructuredJsonString() {

formatter
.appendField("severity", severity)
.appendField("timestamp", timestamp)
.appendField("time", timestamp)
Copy link
Contributor

Choose a reason for hiding this comment

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

Such change could break existing clients which use timestamp in logs. I believe to be on a safe side we should add a configuration parameter controlling this behavior with default to be working with timestamp.

Copy link
Contributor Author

@bpcreech bpcreech Aug 10, 2022

Choose a reason for hiding this comment

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

Unfortunately I think anyone using this library is already broken. I don't think this code is likely to be working for anyone as-is. Unless they implemented their own parser for some reason.

Here is the spec for these fields. Note that this code has been putting RFC3339 time (what happens when you implicitly call toString on an Instant) into the timestamp field. That is wrong.

Here is the code in the Google fluentd parser that parses this format. This is the original and primary intended parser for this format. Note that it doesn't know what to do if the timestamp field has a string in it. Instead it's defaulting to current time, meaning that everyone using this library with the Google Fluentd Parser is getting less accurate timestamps, representing when the parser sees the log as opposed to when the call site emitted it.

The other primary use case for this format (that I know of anyway) is GCP Serverless. Specifically this format works on App Engine Standard gen 2 and Cloud Run Managed. Internally, that code lives at go/time-is-broken. You'll note that if the field called timestamp is a string, it's ignored.

If we leave this broken default, it means this library will be broken by default for anyone trying to use it with the Google Fluentd agent, or GCP Serverless. :(

Copy link
Contributor

Choose a reason for hiding this comment

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

Makes sense

Copy link
Contributor

@losalex losalex left a comment

Choose a reason for hiding this comment

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

LGTM

@losalex losalex added the owlbot:run Add this label to trigger the Owlbot post processor. label Aug 19, 2022
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Aug 19, 2022
@product-auto-label product-auto-label bot added size: s Pull request size is small. and removed size: xs Pull request size is extra small. labels Aug 19, 2022
@losalex losalex added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 19, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 19, 2022
@losalex losalex merged commit 8c9a218 into googleapis:main Aug 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: logging Issues related to the googleapis/java-logging API. size: s Pull request size is small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

JSON formatter uses wrong time field
3 participants