Title: Cronjob monitoring isn't very ergonomic if you're not using an automatic integration · Issue #2770 · getsentry/sentry-python · GitHub
Open Graph Title: Cronjob monitoring isn't very ergonomic if you're not using an automatic integration · Issue #2770 · getsentry/sentry-python
X Title: Cronjob monitoring isn't very ergonomic if you're not using an automatic integration · Issue #2770 · getsentry/sentry-python
Description: Problem Statement The sentry.monitor() context manager is incredibly basic and doesn't set up transactions, tags or allow you to configure cronjobs via upsert Solution Brainstorm My current solution is this baseclass which works, but it'...
Open Graph Description: Problem Statement The sentry.monitor() context manager is incredibly basic and doesn't set up transactions, tags or allow you to configure cronjobs via upsert Solution Brainstorm My current solutio...
X Description: Problem Statement The sentry.monitor() context manager is incredibly basic and doesn't set up transactions, tags or allow you to configure cronjobs via upsert Solution Brainstorm My current sol...
Opengraph URL: https://github.com/getsentry/sentry-python/issues/2770
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Cronjob monitoring isn't very ergonomic if you're not using an automatic integration","articleBody":"### Problem Statement\n\nThe `sentry.monitor()` context manager is incredibly basic and doesn't set up transactions, tags or allow you to configure cronjobs via upsert\n\n### Solution Brainstorm\n\nMy current solution is this baseclass which works, but it's not great and I'm fairly wary about pulling unexported functions from inner modules.\r\n\r\n```python\r\nfrom __future__ import annotations\r\n\r\nimport os\r\nfrom typing import Optional\r\n\r\nimport sentry_sdk\r\nfrom django.core.management import BaseCommand\r\nfrom sentry_sdk.crons.api import capture_checkin\r\nfrom sentry_sdk.crons.consts import MonitorStatus\r\nfrom sentry_sdk.utils import now as timing_now\r\n\r\n\r\nclass BaseCronJob(BaseCommand):\r\n def run_cronjob(self):\r\n raise NotImplementedError(\"You must override the `run_cronjob` method!\")\r\n\r\n name: Optional[str] = None\r\n\r\n def __init__(self, *args, **kwargs) -> None:\r\n name_override = os.environ.get(\"CRONJOB_NAME\")\r\n if name_override is not None:\r\n self.name = name_override\r\n super().__init__(*args, **kwargs)\r\n\r\n def create_parser(self, prog_name: str, subcommand: str, **kwargs):\r\n # Cheeky hack for figuring out the cronjob name from the command name\r\n if self.name is None:\r\n self.name = subcommand.replace(\"_\", \"-\")\r\n return super().create_parser(prog_name, subcommand, **kwargs)\r\n\r\n def handle(self, *args, **options):\r\n cronjob_schedule = os.getenv(\"CRONJOB_SCHEDULE\")\r\n cronjob_startup = os.getenv(\"CRONJOB_STARTUP_DEADLINE\")\r\n monitor_config = None\r\n if cronjob_schedule is not None:\r\n monitor_config = {\r\n \"schedule\": {\r\n \"value\": cronjob_schedule,\r\n \"type\": \"crontab\",\r\n },\r\n \"timezone\": \"Etc/UTC\",\r\n }\r\n if cronjob_startup is not None:\r\n monitor_config[\"checkin_margin\"] = cronjob_startup\r\n\r\n with sentry_sdk.start_transaction(op=\"task\", name=self.name):\r\n sentry_sdk.set_tag(\"cronjob\", \"true\")\r\n sentry_sdk.set_context(\"monitor\", {\"slug\": self.name})\r\n\r\n self.stdout.write(f\"Starting cronjob {self.name}\", self.style.NOTICE)\r\n\r\n start_timestamp = timing_now()\r\n check_in_id = capture_checkin(\r\n monitor_slug=self.name,\r\n status=MonitorStatus.IN_PROGRESS,\r\n monitor_config=monitor_config,\r\n )\r\n\r\n try:\r\n self.run_cronjob()\r\n except Exception:\r\n duration_s = timing_now() - start_timestamp\r\n if check_in_id:\r\n capture_checkin(\r\n monitor_slug=self.name,\r\n check_in_id=check_in_id,\r\n status=MonitorStatus.ERROR,\r\n duration=duration_s,\r\n )\r\n self.stdout.write(\r\n f\"Cronjob {self.name} failed after {duration_s:.2}s\",\r\n self.style.ERROR,\r\n )\r\n raise\r\n else:\r\n duration_s = timing_now() - start_timestamp\r\n if check_in_id:\r\n capture_checkin(\r\n monitor_slug=self.name,\r\n check_in_id=check_in_id,\r\n status=MonitorStatus.OK,\r\n duration=duration_s,\r\n )\r\n self.stdout.write(\r\n f\"Cronjob {self.name} succeeded after {duration_s:.2}s\",\r\n self.style.SUCCESS,\r\n )\r\n```","author":{"url":"https://github.com/Lexicality","@type":"Person","name":"Lexicality"},"datePublished":"2024-02-27T13:29:14Z","url":"https://github.com/getsentry/sentry-python/issues/2770"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:56ca396c-f88d-0307-875c-42236de2b79d |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | C2B2:0DB8:40DDCB:5A08B7:6B008DF7 |
| html-safe-nonce | 2e1fe15f8553d66f89d2238c2159afdcaaf5179fe9b5cb2e85c101252ee4fa36 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDMkIyOjBEQjg6NDBERENCOjVBMDhCNzo2QjAwOERGNyIsInZpc2l0b3JfaWQiOiI2MDkxNDQ4MTYyMzIzNTY2MDcxIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | e0dd22a5519aebe474f94dc6bcdb2002d18c05974ba23ee88df4ace9fd4b15cc |
| hovercard-subject-tag | issue:2156601590 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/getsentry/sentry-python/2770/issue_layout |
| twitter:image | https://opengraph.githubassets.com/4e9fb6e735830fe5bf54628ced602ad529ec68613404ea8a0dba3d796344ba97/getsentry/sentry-python/issues/2770 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/4e9fb6e735830fe5bf54628ced602ad529ec68613404ea8a0dba3d796344ba97/getsentry/sentry-python/issues/2770 |
| og:image:alt | Problem Statement The sentry.monitor() context manager is incredibly basic and doesn't set up transactions, tags or allow you to configure cronjobs via upsert Solution Brainstorm My current solutio... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | Lexicality |
| hostname | github.com |
| expected-hostname | github.com |
| None | c710a5cb5c47be60abfe6e8410436d409906979dbed614ef09f29c60f5535b08 |
| turbo-cache-control | no-preview |
| go-import | github.com/getsentry/sentry-python git https://github.com/getsentry/sentry-python.git |
| octolytics-dimension-user_id | 1396951 |
| octolytics-dimension-user_login | getsentry |
| octolytics-dimension-repository_id | 137814779 |
| octolytics-dimension-repository_nwo | getsentry/sentry-python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 137814779 |
| octolytics-dimension-repository_network_root_nwo | getsentry/sentry-python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | be616a2a6ec1c609d6e002896dff5352d5c5f28b |
| ui-target | canary-2 |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width