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

feature-experimental: add exp setup-sentry command #7790

Merged
merged 11 commits into from
May 11, 2023

Conversation

realStandal
Copy link
Collaborator

This PR adds a setup sentry command to the CLI, installing and setting up Sentry - an error and performance monitoring platform - on both the web and API sides of an application. See @dac09's and @pi0neerpat's guide on Setting up Sentry with Redwood (envelop version) as well as @rockymeza's on Setting up Sentry with RedwoodJS for additional resources on Sentry and Redwood.

I've used redwood-sentry-demo as a playground of sorts for the integration. The command has been used to setup Sentry and pages have been added which trigger errors and Prisma queries for tracing.

In specific, the PR includes the following changes:

  • Adds the yarn rw setup sentry command:
  • Adds documentation for the setup command, including steps a user may take to further integrate Sentry.

@realStandal realStandal requested review from jtoar and dac09 March 10, 2023 22:36
@jtoar
Copy link
Contributor

jtoar commented Mar 15, 2023

Thanks @realStandal, will try to get to reviewing this this week!

@jtoar jtoar added release:feature This PR introduces a new feature fixture-ok Override the test project fixture check labels Mar 15, 2023
Copy link
Contributor

@jtoar jtoar left a comment

Choose a reason for hiding this comment

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

Hey @realStandal, great stuff, left a few comments, but mostly looks good to go. Let me know if you have any questions!

packages/cli/src/commands/setup/sentry/sentry.js Outdated Show resolved Hide resolved
packages/cli/src/commands/setup/sentry/sentry.js Outdated Show resolved Hide resolved
docs/docs/cli-commands.md Outdated Show resolved Hide resolved
docs/docs/cli-commands.md Outdated Show resolved Hide resolved
@realStandal
Copy link
Collaborator Author

@jtoar Resolved those, all great suggestions as always - thanks! Apologies for the delay and if there is any trouble on your end because of it.

@thedavidprice thedavidprice self-requested a review May 4, 2023 20:51
@thedavidprice thedavidprice removed the request for review from dac09 May 10, 2023 17:51
@thedavidprice thedavidprice self-assigned this May 10, 2023
Copy link
Contributor

@thedavidprice thedavidprice left a comment

Choose a reason for hiding this comment

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

@realStandal excellent work on this! I'm getting it merged now and will highlight it in the next release.

Changes to the PR

We have some incoming CLI features that will make it possible for 3rd partner service setup commands like this to exist as a stand-alone package, which is ideal on multiple fronts.

We're not there yet, but in the meantime, we now have a new process and command for experimental features. This effectively makes it possible to still ship features but not have to worry about following semver until things are finalized — i.e. you can make breaking template and config changes, including changing the setup command structure, as needed while experimental. (If we had a "feature preview" process, that would be more accurate in this case. fwiw) The other goal of experimental features is to get community feedback, which we do via a forum post.

I've changed the command to:

  • yarn rw experimental setup-sentry

And I've moved the docs to a Forum post with you as the author here:

@thedavidprice thedavidprice changed the title Add setup sentry command feature-experimental: add exp setup-sentry command May 11, 2023
@thedavidprice thedavidprice merged commit f8d1795 into redwoodjs:main May 11, 2023
@redwoodjs-bot redwoodjs-bot bot added this to the next-release milestone May 11, 2023
jtoar pushed a commit that referenced this pull request May 11, 2023
* created Sentry setup command and templates

* documented the setup sentry command

* added opinionated defaults to Sentry Envelop plugin

* relocated setup sentry handler to separate file

* added note about SentryLayout useEffect dependency array

* move cmd to `exp setup-sentry`

---------

Co-authored-by: David Price <thedavid@thedavidprice.com>
dac09 added a commit to dac09/redwood that referenced this pull request May 12, 2023
…te-default

* 'main' of github.com:redwoodjs/redwood: (23 commits)
  fix: remove react 17/18 warning (redwoodjs#8300)
  chore(release): tolerate lerna publish faliure
  Recover lost connection (redwoodjs#8284)
  chore(deps): update dependency @faker-js/faker to v8 (redwoodjs#8296)
  chore(release): better git commits during release
  feat: experimental - Studio Overview and Performance Widgets (redwoodjs#8292)
  fix(forms): disable webpack-dev-server overlay (redwoodjs#8298)
  Fix studio lint warning (redwoodjs#8297)
  Fastify server: Default to localhost (redwoodjs#8019)
  Fix GraphQL proxy in dev environments without IPv6 (redwoodjs#8233)
  fix(deps): update dependency @graphiql/plugin-explorer to v0.1.18 (redwoodjs#8290)
  chore(deps): update dependency supertokens-auth-react to v0.32.3 (redwoodjs#8289)
  Add `setup sentry` command (redwoodjs#7790)
  chore: readme update core team and all contributors (redwoodjs#8288)
  fix(deps): update nivo monorepo to ^0.83.0 (redwoodjs#8286)
  fix(deps): update dependency babel-plugin-polyfill-corejs3 to v0.8.1 (redwoodjs#8281)
  chore(deps): update dependency @replayio/playwright to v0.3.30 (redwoodjs#8282)
  fix(deps): update dependency webpack to v5.82.1 (redwoodjs#8283)
  Add epilogue to builders (redwoodjs#8285)
  feat(studio): v2 studio (redwoodjs#8173)
  ...
@jtoar jtoar modified the milestones: next-release, v5.2.0 May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fixture-ok Override the test project fixture check release:feature This PR introduces a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants