Adding logger SDK to reference, with some edits. #714
Conversation
| Correction on internal staging link -- it ends with an underscore, and because that gets stripped, we need to spell it out: https://firebase.devsite.corp.google.com/docs/reference/functions/logger_.html |
| Why is there an underscore at the end? I saw that in the yaml but don't know the convention …On Tue, Jun 23, 2020, 8:23 AM egilmorez ***@***.***> wrote: Correction on internal staging link -- it ends with an underscore: https://firebase.devsite.corp.google.com/docs/reference/functions/logger_ — You are receiving this because your review was requested. Reply to this email directly, view it on GitHub <#714 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAAH7U32RI4D2FLXOUECGDRYDCHLANCNFSM4OFEM2RQ> . |
| /** | ||
| * Writes a `LogEntry` to `stdout`/`stderr` (depending on severity). | ||
| * @param entry The LogEntry including severity, message, and any additional structured metadata. | ||
| * @param entry The `LogEntry` including severity, message, and any additional structured metadata. |
There was a problem hiding this comment.
Will the LogEntry type show up in the reference? Can we link to it? Or maybe that happens automatically since it's an argument for the function?
There was a problem hiding this comment.
Yup! TypeDoc creates a link for that.
| /** | ||
| * Writes a `DEBUG` severity log. If the last argument provided is a plain object, | ||
| * it will be added to the `jsonPayload` in the Cloud Logging entry. | ||
| * it is added to the `jsonPayload` in the Cloud Logging entry. |
There was a problem hiding this comment.
Here's a link to an explanation of jsonPayload: https://cloud.google.com/logging/docs/structured-logging
Not sure if that's TMI though
If added, this applies to all comments that mention jsonPayload
There was a problem hiding this comment.
Hm, that's a good reference for the guide material, as well as for a top-level comment for logger -- which I should probably add to the main page here.
| Michael has a really good question about the underscores . . . there is probably some work we can do in the docgen script to clean up the file names, similar to what we've done with the Web SDK TypeDoc script. |
4 participants
Adding logger SDK to reference docs, with some edits.
Staged internally at: https://firebase.devsite.corp.google.com/docs/reference/functions/logger_
Thanks!