Structured logging

[sidharthachatterjee]

To Do

• Always fail on panic
• Write test suite
• Add normalised date string (timestamp) for log actions
• figure out reliable way to determine if gatsby version that is installed support ipc communication
• Smarter Debounce status changes (for now hard coded 1s debounce)
• Figure out a way to catch all unhandled thrown exceptions and report them
  • Set status to failure
• Wait on pending jobs for set status
  • Enable ability to hide activities so that some activities while being
    tracked for setting status will not be visible to the user
• Webpack bundle failing is showing up as success
• Mark some activities as hidden
• Pass through error code in premature end handler in signal exit
• Move types of activities to constants
• Add stack for structured error log
• Restore in-browser error overlay for query extraction errors (@pieh)
• Restore query running split (first static queries, then webpack build, then page queries) in gatsby build (@pieh)
• Handle webpack warnings (right now we only handle displaying/emitting webpack errors)
• Figure out why https://circleci.com/gh/gatsbyjs/gatsby/209016?utm_campaign=vcs-integration-link&utm_medium=referral&utm_source=github-build-link happened
• Ensure all GraphQL extraction errors are emitted as structured errors (@pieh)
• Remove VERSION ipc message - this is not used by anyone
• Fix hot reloading test
• Get rid of redundant constants
• Figure out console over rides and make sure the correct level of the action is reported (error, warn etc) chore: Move console overrides to reporter.log #14834 (@sidharthachatterjee)
• Check if telemetry analytics is all good (@pieh)
• Streamline and combine LOG, SUCCESS and INFO levels (@sidharthachatterjee)
• Add more integration tests that verify shape of all messages in protocol
• Document reporter [docs] reporter docs don't explain when to use it over console.log etc #15898
• Make API constant for progress and activity timer Make API constant for progress and activity timer #17421
• Ink uses store and needs to have special handling for hidden stuff Ink uses store and needs to have special handling for hidden structured logs  #17422
• Figure out how to ensure concurrent builds don't interfere with each other when running integration tests (we run them serially for now)
• Add a Gatsby CLI option to select a logger (JSON or regular) Expose JSON logger for Gatsby CLI  #17836
• Do we handle spawned processes?
• Some tools that currently depend on Gatsby log output may break since we no longer print DONE Compiled successfully in 4333ms
• Map errors in internal plugins to activities and set status correctly #18383

[KyleAMathews]

Some activities are too fine grained and need to be combined

Perhaps just do that directly by creating new activities to combine the old ones? Not sure how a helper function would help?

[sidharthachatterjee]

Perhaps just do that directly by creating new activities to combine the old ones? Not sure how a helper function would help?

Not sure yet but a helper function might be less destructive (we want to still keep the more granular activities for telemetry and open tracing)

We now have support to mark activities as hidden (still there for telemetry and open tracing but not displayed in CLI or Preview)

[sidharthachatterjee]

Published in gatsby@2.16.0 and gatsby-cli@2.8.0