-
-
Notifications
You must be signed in to change notification settings - Fork 105
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
feat(api): Add Sentry Integeration #133
feat(api): Add Sentry Integeration #133
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 80734da. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 3 targetsSent with 💌 from NxCloud. |
@HarshPatel5940 Awesome bro! Give me some time to go through the changes and test them. |
Definitely! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
About the logs, can you try to make them similar with what our existing login looks like? Just that it will start with [SENTRY]
* it will not be enabled for `test` and `e2e`enviorment
PR Description updated to latest commit (fc11cf9) |
PR Review(Review updated until commit 4809f31)
Code feedback:
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the review usage page for a comprehensive guide on using this tool. |
PR Code Suggestions
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the improve usage page for a more comprehensive guide on using this tool. |
I think it is bound to happen since all the modules are loaded in the AppModule, and it is in turn loaded in init. What I wanted as to make sure that I can log the waterfalls, and the application errors. So I think this is good. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All looks good, just make these last two changes:
- Integrate this suggestion:
Use a more descriptive name for the main span to clearly indicate its purpose or the
specific operation it represents.
apps/api/src/main.ts [59-60]
-op: 'mainSpan',
-name: 'My Main Span'
+op: 'applicationBootstrap',
+name: 'Application Bootstrap Process'
- Add
SENTRY_ORG
andSENTRY_DSN
in.env.example
umm sure, let me try. |
Persistent review updated to latest commit 4f4f4ec |
/improve |
PR Code Suggestions
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the improve usage page for a more comprehensive guide on using this tool. |
@HarshPatel5940 i believe the tests have some caching issues. It usually passes if we re-run it, but we need to somehow fix that flakey test suit. It always happens in |
Will do the changes as soon as time permits.
Hmmm, i see. |
No rush bro! You can raise a PR for that whenever you feel so! |
* add `sentry_env` instead of `node_env`
/review |
Persistent review updated to latest commit 4809f31 |
@rajdip-b sorry for the silly mistake at the end. I will be more careful from future to avoid those. |
Happens all the time on such major PRs! No issue on that. I'm making some final changes and make a push. |
Oh ok. noted. |
Quality Gate passedIssues Measures |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Guess that does it!
## [1.2.0](v1.1.0...v1.2.0) (2024-02-18) ### 🚀 Features * **api:** Add Sentry Integeration ([#133](#133)) ([5ae2c92](5ae2c92)) ### 🔧 Miscellaneous Chores * **api:** update dockerfile and ci ([ae2d944](ae2d944)) * **api:** update sentry log messages ([976026c](976026c)) * **ci:** update stage-api workflow ([addaa61](addaa61)) * **husky:** Remove `e2e:api` command from husky ([#144](#144)) ([8a2fa58](8a2fa58)) * update sentry source map script ([bdc9dc6](bdc9dc6))
🎉 This PR is included in version 1.2.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
User description
Description
This pull request adds the necessary code and configuration to integrate Sentry into the project. It includes the initialization of Sentry, the addition of Sentry handlers, and the setup of the necessary environment variables. Additionally, it includes the necessary scripts to build and upload source maps to Sentry for better error tracking and debugging.
Fixes #109
Dependencies
Mentions
@rajdip-b
Screenshots of relevant screens
Developer's checklist
Documentation Update
Type
enhancement, configuration changes, dependencies
Description
.env.example
for easy setup.package.json
to include Sentry dependencies and a script for source maps upload.tsconfig.base.json
to enhance Sentry's issue grouping by adjusting source maps configuration.Changes walkthrough
main.ts
Integrate Sentry for Enhanced Error Tracking and Performance
Monitoring
apps/api/src/main.ts
enabling.
function.
better tracing.
.env.example
Add Sentry Configuration Environment Variables
.env.example
profiles sample rate.
tsconfig.base.json
Configure TypeScript for Sentry Source Maps
tsconfig.base.json
sourceRoot
to improve Sentry issuegrouping.
package.json
Update Dependencies and Scripts for Sentry Integration
package.json
@sentry/cli
,@sentry/node
, and@sentry/profiling-node
todependencies.
sentry:sourcemaps
for uploading source maps toSentry.
✨ Usage guide:
Overview:
The
describe
tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.When commenting, to edit configurations related to the describe tool (
pr_description
section), use the following template:With a configuration file, use the following template:
Enabling\disabling automation
meaning the
describe
tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.the tool will replace every marker of the form
pr_agent:marker_name
in the PR description with the relevant content, wheremarker_name
is one of the following:type
: the PR type.summary
: the PR summary.walkthrough
: the PR walkthrough.Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
Custom labels
The default labels of the
describe
tool are quite generic: [Bug fix
,Tests
,Enhancement
,Documentation
,Other
].If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
Examples for custom labels:
Main topic:performance
- pr_agent:The main topic of this PR is performanceNew endpoint
- pr_agent:A new endpoint was added in this PRSQL query
- pr_agent:A new SQL query was added in this PRDockerfile changes
- pr_agent:The PR contains changes in the DockerfileThe list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
Inline File Walkthrough 💎
For enhanced user experience, the
describe
tool can add file summaries directly to the "Files changed" tab in the PR page.This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs).
To enable inline file summary, set
pr_description.inline_file_summary
in the configuration file, possible values are:'table'
: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.true
: A collapsable file comment with changes title and a changes summary for each file in the PR.false
(default): File changes walkthrough will be added only to the "Conversation" tab.Utilizing extra instructions
The
describe
tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.
Examples for extra instructions:
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
More PR-Agent commands
See the describe usage page for a comprehensive guide on using this tool.