runsignal 0.2.0__tar.gz

runsignal-0.2.0/.gitignore

@@ -0,0 +1,495 @@
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+##
+## Get latest from `dotnet new gitignore`
+
+# dotenv files
+.env
+
+# User-specific files
+*.rsuser
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Mono auto generated files
+mono_crash.*
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Ww][Ii][Nn]32/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Bb]in/
+[Oo]bj/
+[Ll]og/
+[Ll]ogs/
+
+# Visual Studio 2015/2017 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# Visual Studio 2017 auto generated files
+Generated\ Files/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUnit
+*.VisualState.xml
+TestResult.xml
+nunit-*.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# Benchmark Results
+BenchmarkDotNet.Artifacts/
+
+# .NET
+project.lock.json
+project.fragment.lock.json
+artifacts/
+
+# Tye
+.tye/
+
+# ASP.NET Scaffolding
+ScaffoldingReadMe.txt
+
+# StyleCop
+StyleCopReport.xml
+
+# Files built by Visual Studio
+*_i.c
+*_p.c
+*_h.h
+*.ilk
+*.meta
+*.obj
+*.iobj
+*.pch
+*.pdb
+*.ipdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*_wpftmp.csproj
+*.log
+*.tlog
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+*.VC.VC.opendb
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# Visual Studio Trace Files
+*.e2e
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# AxoCover is a Code Coverage Tool
+.axoCover/*
+!.axoCover/settings.json
+
+# Coverlet is a free, cross platform Code Coverage Tool
+coverage*.json
+coverage*.xml
+coverage*.info
+
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# Note: Comment the next line if you want to checkin your web deploy settings,
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
+# NuGet Packages
+*.nupkg
+# NuGet Symbol Packages
+*.snupkg
+# The packages folder can be ignored because of Package Restore
+**/[Pp]ackages/*
+# except build/, which is used as an MSBuild target.
+!**/[Pp]ackages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/[Pp]ackages/repositories.config
+# NuGet v3's project.json files produces more ignorable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directories and files
+AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+*.appx
+*.appxbundle
+*.appxupload
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!?*.[Cc]ache/
+
+# Others
+ClientBin/
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.jfm
+*.pfx
+*.publishsettings
+orleans.codegen.cs
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+#*.snk
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+#bower_components/
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+ServiceFabricBackup/
+*.rptproj.bak
+
+# SQL Server files
+*.mdf
+*.ldf
+*.ndf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+*.rptproj.rsuser
+*- [Bb]ackup.rdl
+*- [Bb]ackup ([0-9]).rdl
+*- [Bb]ackup ([0-9][0-9]).rdl
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+node_modules/
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+*.vbw
+
+# Visual Studio 6 auto-generated project file (contains which files were open etc.)
+*.vbp
+
+# Visual Studio 6 workspace and project file (working project files containing files to include in project)
+*.dsw
+*.dsp
+
+# Visual Studio 6 technical files
+*.ncb
+*.aps
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# Paket dependency manager
+.paket/paket.exe
+paket-files/
+
+# FAKE - F# Make
+.fake/
+
+# CodeRush personal settings
+.cr/personal
+
+# Python Tools for Visual Studio (PTVS)
+__pycache__/
+*.pyc
+
+# Cake - Uncomment if you are using it
+# tools/**
+# !tools/packages.config
+
+# Tabs Studio
+*.tss
+
+# Telerik's JustMock configuration file
+*.jmconfig
+
+# BizTalk build output
+*.btp.cs
+*.btm.cs
+*.odx.cs
+*.xsd.cs
+
+# OpenCover UI analysis results
+OpenCover/
+
+# Azure Stream Analytics local run output
+ASALocalRun/
+
+# MSBuild Binary and Structured Log
+*.binlog
+
+# NVidia Nsight GPU debugger configuration file
+*.nvuser
+
+# MFractors (Xamarin productivity tool) working folder
+.mfractor/
+
+# Local History for Visual Studio
+.localhistory/
+
+# Visual Studio History (VSHistory) files
+.vshistory/
+
+# BeatPulse healthcheck temp database
+healthchecksdb
+
+# Backup folder for Package Reference Convert tool in Visual Studio 2017
+MigrationBackup/
+
+# Ionide (cross platform F# VS Code tools) working folder
+.ionide/
+
+# Fody - auto-generated XML schema
+FodyWeavers.xsd
+
+# VS Code files for those working on multiple tools
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+# Windows Installer files from build outputs
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# JetBrains Rider
+*.sln.iml
+.idea/
+
+##
+## Visual studio for Mac
+##
+
+
+# globs
+Makefile.in
+*.userprefs
+*.usertasks
+config.make
+config.status
+aclocal.m4
+install-sh
+autom4te.cache/
+*.tar.gz
+tarballs/
+test-results/
+
+# Mac bundle stuff
+*.dmg
+*.app
+
+# content below from: https://github.com/github/gitignore/blob/main/Global/macOS.gitignore
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# content below from: https://github.com/github/gitignore/blob/main/Global/Windows.gitignore
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# Vim temporary swap files
+*.swp
+BenchmarkDotNet.Artifacts/
+
+# Go
+*.test
+*.out
+
+# Python SDK
+.venv/
+*.egg-info/
+src/RunSignal.Python/dist/
+.pytest_cache/

runsignal-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gokhan Ertogan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

runsignal-0.2.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.5
+Name: runsignal
+Version: 0.2.0
+Summary: Cron job and background job monitoring for Python with OpenTelemetry: alert when a Celery task, APScheduler job or cron script is missed, fails, overruns, stalls or processes nothing, in New Relic, Prometheus and Grafana.
+Project-URL: Homepage, https://github.com/gokhanertogan/RunSignal
+Project-URL: Documentation, https://github.com/gokhanertogan/RunSignal/tree/main/src/RunSignal.Python#readme
+Project-URL: Repository, https://github.com/gokhanertogan/RunSignal
+Project-URL: Issues, https://github.com/gokhanertogan/RunSignal/issues
+Project-URL: Changelog, https://github.com/gokhanertogan/RunSignal/blob/main/CHANGELOG.md
+Author: Gokhan Ertogan
+License-Expression: MIT
+License-File: LICENSE
+Keywords: alerting,apscheduler,background-jobs,celery,celery-beat,cron,cron-monitoring,dead-mans-switch,grafana,healthcheck,heartbeat,job-monitoring,monitoring,newrelic,observability,opentelemetry,otel,prometheus,scheduled-jobs,worker
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Celery
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: System :: Logging
+Classifier: Topic :: System :: Monitoring
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: opentelemetry-api>=1.27
+Provides-Extra: apscheduler
+Requires-Dist: apscheduler<4,>=3.10; extra == 'apscheduler'
+Provides-Extra: celery
+Requires-Dist: celery>=5.3; extra == 'celery'
+Description-Content-Type: text/markdown
+
+# RunSignal for Python
+
+[![PyPI](https://img.shields.io/pypi/v/runsignal)](https://pypi.org/project/runsignal/)
+[![Python versions](https://img.shields.io/pypi/pyversions/runsignal)](https://pypi.org/project/runsignal/)
+[![license](https://img.shields.io/pypi/l/runsignal)](https://github.com/gokhanertogan/RunSignal/blob/main/LICENSE)
+
+**Cron job and background job monitoring for Python, on OpenTelemetry.** Get an alert when a Celery task or
+Celery beat schedule, an APScheduler job or a cron script is missed, fails, runs too long or processes nothing,
+and when a consumer or worker loop stops making progress: the failures no HTTP status code describes. No hosted
+service and no ping URLs: the alerts live in the backend you already use.
+
+RunSignal records runs, items and heartbeats as OpenTelemetry metrics, with the same names as every other
+RunSignal SDK, so the `runsignal` CLI provisions the same alerts for Python services as for .NET, Go, Java,
+Node.js and Rust ones: New Relic alerts and dashboards, or Prometheus rules and a Grafana dashboard. The
+[main README](https://github.com/gokhanertogan/RunSignal#readme) covers the concepts, the alerts and the
+backends.
+
+## Installation
+
+```bash
+pip install runsignal                # core, depends only on opentelemetry-api
+pip install "runsignal[celery]"      # with Celery 5.3+
+pip install "runsignal[apscheduler]" # with APScheduler 3.10+
+```
+
+Requires Python 3.9 or later. Install and configure the OpenTelemetry SDK and an exporter as usual
+(`opentelemetry-sdk`, `opentelemetry-exporter-otlp`).
+
+## Quick start
+
+```python
+from runsignal import default_registry
+
+invoices = default_registry.workload(
+    "nightly-invoice",
+    schedule="0 2 * * *",
+    max_duration="30m",      # or seconds, or a timedelta
+    min_processed=100,
+    severity="critical",
+)
+
+with invoices.run():
+    for order in unbilled_orders():
+        create_invoice(order)
+        invoices.processed()
+```
+
+Or as a decorator, for sync and async functions:
+
+```python
+from runsignal import monitor
+
+@monitor("nightly-invoice", schedule="0 2 * * *", max_duration="30m")
+def generate_invoices():
+    for order in unbilled_orders():
+        create_invoice(order)
+        generate_invoices.workload.processed()
+```
+
+`default_registry` records on the global OpenTelemetry providers, which forward to the SDK once it is configured,
+so it works even when it is created by an import first. For explicit providers, use
+`WorkloadRegistry(meter_provider=..., tracer_provider=...)`.
+
+## Recording work
+
+| Call | Records |
+|---|---|
+| `with w.run():` / `async with w.run():` | One run. It succeeds when the block completes, is cancelled on `asyncio.CancelledError`, `KeyboardInterrupt` or `SystemExit`, and fails on any other exception, which propagates. The run's span is current inside the block. |
+| `@w.monitor` / `@monitor(name, **expectations)` | One run per call, for sync and async functions. |
+| `run = w.start()` then `run.succeed()` / `fail(exc)` / `fail_code(code, description)` / `cancel()` | A run ended by hand. Later calls are ignored. |
+| `w.processed(n)` / `w.item_failed(n)` | Items handled. |
+| `w.beat()` | A heartbeat from a long-running loop. |
+
+`error.type` is the exception's `error_type` attribute if it has one (such as `"statement_missing"`), otherwise
+its fully qualified class name (`ValueError`, `requests.exceptions.ConnectionError`).
+
+## Celery
+
+```python
+from celery import Celery
+from celery.schedules import crontab
+from runsignal.celery import instrument, workload_of
+
+app = Celery("billing")
+app.conf.beat_schedule = {
+    "nightly-invoice": {"task": "billing.tasks.generate_invoices", "schedule": crontab(hour=2, minute=0)},
+}
+instrument(app, workloads={"billing.tasks.generate_invoices": {"max_duration": "30m", "severity": "critical"}})
+
+@app.task(bind=True)
+def generate_invoices(self):
+    for order in unbilled_orders():
+        create_invoice(order)
+        workload_of(self).processed()
+```
+
+- **What is recorded:** every task execution, with no code in your tasks: success, failure with the exception's type (each retry counts as a failed run), cancellation when a task is revoked, and duration. Celery's own `celery.*` tasks are skipped.
+- **Naming:** tasks are named after their task name (`billing.tasks.generate_invoices`).
+- **Celery beat:** `instrument(app)` registers every task in `beat_schedule` with its `crontab` as the schedule, so a periodic task that never runs gets a `missed` alert. Interval schedules get no schedule.
+- **Manifest:** the worker writes it when it is ready if `RUNSIGNAL_MANIFEST_PATH` is set. In CI, import the app and call `default_registry.write_manifest_from_env("billing")` instead; no broker is needed.
+- **Prefork workers:** configure the OpenTelemetry SDK in `worker_process_init`, as for any OpenTelemetry instrumentation of Celery.
+
+## APScheduler
+
+```python
+from apscheduler.schedulers.background import BackgroundScheduler
+from runsignal.apscheduler import instrument
+
+scheduler = BackgroundScheduler()
+scheduler.add_job(generate_invoices, "cron", hour=2, minute=0, id="nightly-invoice")
+instrument(scheduler, workloads={"nightly-invoice": {"max_duration": "30m", "severity": "critical"}})
+scheduler.start()
+```
+
+- **What is recorded:** every run of every job, including jobs added after `instrument`, for all schedulers (`BackgroundScheduler`, `BlockingScheduler`, `AsyncIOScheduler`, ...).
+- **Naming:** jobs are named after the `id` you gave them, or their `name` when APScheduler generated the id.
+- **Schedules:** cron triggers become the workload's schedule, with APScheduler's Monday = 0 converted to cron's numbering. Triggers that use `year`, `week` or days such as `1st mon` get no schedule, with a warning.
+- **Persistent job stores** (SQLAlchemy, Redis, MongoDB) cannot store a wrapped function: decorate the job function with `@default_registry.monitor("nightly-invoice")` instead. `instrument` still registers the schedule.
+
+## Cron scripts and loops
+
+A script run by cron, a Kubernetes CronJob or systemd timer is one run per invocation:
+
+```python
+with default_registry.workload("nightly-invoice", schedule="0 2 * * *").run():
+    main()
+```
+
+The `missed` alert needs a long-running process to report `since_success`, so for short-lived scripts declare
+the workload in the service that exports continuously, or rely on the `failed`, `overrun` and `low output`
+alerts. Long-running loops send heartbeats:
+
+```python
+sync = default_registry.workload("stock-sync", expect_every="5m")
+while True:
+    sync_stock()
+    sync.beat()
+```
+
+## Manifest
+
+```python
+default_registry.write_manifest_from_env("billing-service")  # writes to RUNSIGNAL_MANIFEST_PATH when it is set
+```
+
+Then provision the alerts from CI with the [`runsignal` CLI](https://github.com/gokhanertogan/RunSignal#cli).
+
+## Exporting
+
+**New Relic** needs delta temporality. With cumulative, a stopped workload never looks stopped:
+
+```bash
+export OTEL_EXPORTER_OTLP_ENDPOINT=https://otlp.eu01.nr-data.net:4317   # US: https://otlp.nr-data.net:4317
+export OTEL_EXPORTER_OTLP_HEADERS=api-key=<your license key>
+export OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE=delta
+```
+
+**Prometheus 3** receives OTLP at `/api/v1/otlp/v1/metrics` with the default (cumulative) temporality. Generate
+its rules with `runsignal export prometheus` and a dashboard with `runsignal export grafana`.
+
+## Development
+
+```bash
+python -m venv .venv && .venv/bin/pip install -e ".[celery,apscheduler]" opentelemetry-sdk pytest
+.venv/bin/pytest
+```
+
+The tests include the cross-language conformance vectors in `spec/conformance`.
+
+## Links
+
+[Specification](https://github.com/gokhanertogan/RunSignal/blob/main/spec/README.md) ·
+[Changelog](https://github.com/gokhanertogan/RunSignal/blob/main/CHANGELOG.md) ·
+[Other languages](https://github.com/gokhanertogan/RunSignal#quick-start)