[docs] reporter docs don't explain when to use it over console.log etc

[swyxio]

Summary

[docs] reporter docs don't explain when to use it over console.log etc

Relevant information

when do i want panicOnBuild vs panic?

Edit: Also need to document upcoming activities after structured logs are published

[gatsbot[bot]]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.

If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!

As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contributefor more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

[swyxio]

nice docs issue to keep open

[gatsbot[bot]]

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.

Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.

As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks again for being part of the Gatsby community!

[gatsbot[bot]]

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.

Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.

As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks again for being part of the Gatsby community!

[dcastil]

Just want to mention it in case anyone is searching for an answer like me.

panic always logs the data, exits and fails the process. panicOnBuild logs the data and only exits and fails the process if the gatsby build command is running.

Source: https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-cli/src/reporter/index.js#L53-L65

[swyxio]

hmm. sounds like it should be callled panicDuringBuild? thanks for investigating!

[ghost]

Not knowing which one of panicOnBuild or panic is more appropriate to use in a certain context is what led me here. And it seems I'm not alone:

panic always logs the data, exits and fails the process. panicOnBuild logs the data and only exits and fails the process if the gatsby build command is running.

I saw panicOnBuild was used in some of the Gatsby posts written by Dustin Schau back in mid-2017. In Dustin's example panicOnBuild was used in the context of reporting an error when createPages failed.

In my limited experience with Gatsby I've seen projects skip use of reporter and it's methods entirely. Given the importance of gatsby-node I'm surprised I haven't been able to find a blog post or two about how using one over the other burned someone. Oh well, maybe it'll be mine in the future. 😅

[blainekasten]

I'll throw in a quick response here. I understand that it's not super clear here..

Here is the basics:

1. We patch console.log, console.info, and console.error to flow through our reporter. So you can use them and it'll work just like any reporter call.
2. The reporter has some more fancy possibilities, like phantom activities, progress bars and timers. You can use them however you want.

Our reporter was typically treated as an internal implementation, but we did expose it in things like gatsby-node to allow for users to do fancier things if they want. In my opinion, most apps won't need anything fancy from reporter and can just use console.* for any debug/messaging needs.

Fun to note - console.debug does not flow through reporter. So you can use that if reporter is accidentally swallowing output.

I'll ping @AishaBlake to see if she wants to get this into our docs