Read log entries from jsonPayload and protoPayload. #3539
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
taeold
changed the title
taeold
changed the title
joehan
approved these changes
Jul 7, 2021
devpeerapong
pushed a commit
to devpeerapong/firebase-tools
that referenced
this pull request
Dec 14, 2021
Today, function logs with structured data (e.g. those generated using firebase-functions SDK's logger api) do not show up in `firebase functions:log` command:
```js
// index.js
exports.hello = functions.https.onRequest((request, response) => {
info("Hello logs!", {structuredData: true});
info("hello world!");
response.send("Hello from Firebase!");
});
```
```bash
$ firebase functions:log
2021-06-30T12:47:42.955491814Z D hello: Function execution started
2021-06-30T12:47:43.050Z I hello: # LOOK HERE: where's the message?
2021-06-30T12:47:43.050Z I hello: hello world!
2021-06-30T12:47:43.061418239Z D hello: Function execution took 107 ms, finished with status code: 200
```
This happens because structured log entries are stored in [`jsonPayload` field](https://cloud.google.com/logging/docs/structured-logging), not `textPayload` field.
In addition to correctly parsing `jsonPayload` field, we will also correctly parse log entries with `protoPayload` fields (in most cases, these log entries come from audit logs).
*After*
```bash
2021-06-30T12:47:42.955491814Z D hello: Function execution started
2021-06-30T12:47:43.050Z I hello: {"message":"Hello logs!","structuredData":true}
2021-06-30T12:47:43.050Z I hello: hello world!
2021-06-30T12:47:43.061418239Z D hello: Function execution took 107 ms, finished with status code: 200
```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Today, function logs with structured data (e.g. those generated using firebase-functions SDK's logger api) do not show up in
firebase functions:logcommand:This happens because structured log entries are stored in
jsonPayloadfield, nottextPayloadfield.In addition to correctly parsing
jsonPayloadfield, we will also correctly parse log entries withprotoPayloadfields (in most cases, these log entries come from audit logs).After
2021-06-30T12:47:42.955491814Z D hello: Function execution started 2021-06-30T12:47:43.050Z I hello: {"message":"Hello logs!","structuredData":true} 2021-06-30T12:47:43.050Z I hello: hello world! 2021-06-30T12:47:43.061418239Z D hello: Function execution took 107 ms, finished with status code: 200