![\"rollbar-logo\"](\"https://user-images.githubusercontent.com/3300063/207964480-54eda665-d6fe-4527-ba51-b0ab3f41f10b.png\")
\n\n \n
\n Proactively discover, predict, and resolve errors in real-time with Rollbar’s error monitoring platform. Start tracking errors today!\n
\n\n\n[](https://github.com/rollbar/pyrollbar/actions)\n\n\nPython notifier for reporting exceptions, errors, and log messages to [Rollbar](https://rollbar.com).\n\n## Key benefits of using Pyrollbar are:\n- **Frameworks:** Pyrollbar supports popular Python frameworks such as Django, Flask, FastAPI, AWS Lambda and more!\n- **Automatic error grouping:** Rollbar aggregates Occurrences caused by the same error into Items that represent application issues. Learn more about reducing log noise.\n- **Advanced search:** Filter items by many different properties. Learn more about search.\n- **Customizable notifications:** Rollbar supports several messaging and incident management tools where your team can get notified about errors and important events by real-time alerts. Learn more about Rollbar notifications.\n\n## Python Versions Supported\n\n| PyRollbar Version | Python Version Compatibility | Support Level |\n|-------------------|-----------------------------------------------|---------------------|\n| 1.4.0 | 3.9, 3.10, 3.11, 3.12, 3.13, 3.14 | Full |\n| 0.16.3 | 2.7, 3.4, 3.5, 3.6, 3.7. 3.8, 3.9, 3.10, 3.11 | Security Fixes Only |\n\n#### Support Level Definitions\n\n**Full** - We will support new features of the library and test against all supported versions.\n\n**Security Fixes Only** - We will only provide critical security fixes for the library.\n\n## Frameworks Supported\n\nGenerally, PyRollbar can be used with any Python framework. However, we have official support for the following frameworks:\n\n| Framework | Support Duration | Tested Versions |\n|-----------|----------------------------|-----------------|\n| Celery | Release +1 year | None |\n| Django | Release or LTS end +1 year | 4.2, 5.2 |\n| FastAPI | Release +1 year | 0.115, 0.118 |\n| Flask | Release +1 year | 2.3, 3.1 |\n| Pyramid | Release +1 year | 1.10, 2.0 |\n\nOfficial support means that we ship and maintain integrations for these frameworks. It also means that we test against these frameworks as part of our CI pipeline.\n\nGenerally, we will support the last year of releases for a framework. If a framework has a defined support period (including LTS releases), we will support the release for the duration of that period plus one year.\n\n### Community Supported\n\nThere are also a number of community-supported integrations available. For more information, see the [Python SDK docs](https://docs.rollbar.com/docs/python-community-supported-sdks).\n\n## Setup Instructions\n\n1. [Sign up for a Rollbar account](https://rollbar.com/signup)\n2. Follow the [Quick Start](https://docs.rollbar.com/docs/python#section-quick-start) instructions in our [Python SDK docs](https://docs.rollbar.com/docs/python) to install pyrollbar and configure it for your platform.\n\n## Usage and Reference\n\nFor complete usage instructions and configuration reference, see our [Python SDK docs](https://docs.rollbar.com/docs/python).\n\n## Release History & Changelog\n\nSee our [Releases](https://github.com/rollbar/pyrollbar/releases) page for a list of all releases, including changes.\n\n## Help / Support\n\nIf you run into any issues, please email us at [support@rollbar.com](mailto:support@rollbar.com)\n\nFor bug reports, please [open an issue on GitHub](https://github.com/rollbar/pyrollbar/issues/new).\n\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (```git checkout -b my-new-feature```).\n3. Commit your changes (```git commit -am 'Added some feature'```)\n4. Push to the branch (```git push origin my-new-feature```)\n5. Create new Pull Request\n\nTests are in `rollbar/test`. To run the tests: `python setup.py test`\n" }, { "path": "THANKS.md", "content": "# Contributors\n\nHuge thanks to the following contributors (by github username). For the most up-to-date list, see https://github.com/rollbar/pyrollbar/graphs/contributors\n\n- [alex-laties](https://github.com/alex-laties)\n- [dmitry-mukhin](https://github.com/dmitry-mukhin)\n- [homm](https://github.com/homm)\n- [isra17](https://github.com/isra17)\n- [jamesonjlee](https://github.com/jamesonjlee)\n- [jbowes](https://github.com/jbowes)\n- [jbrumwell](https://github.com/jbrumwell)\n- [jedipi](https://github.com/jedipi)\n- [juggernaut](https://github.com/juggernaut)\n- [rhcarvalho](https://github.com/rhcarvalho)\n- [tschieggm](https://github.com/tschieggm)\n- [zvirusz](https://github.com/zvirusz)\n- [benkuhn](https://github.com/benkuhn)\n- [pmourlanne](https://github.com/pmourlanne)\n" }, { "path": "pyproject.toml", "content": "[build-system]\nrequires = [\"setuptools>=61.0\"]\nbuild-backend = \"setuptools.build_meta\"\n\n[project]\nname = \"rollbar\"\ndynamic = [\"version\"]\ndescription = \"Easy and powerful exception tracking with Rollbar. Send messages and exceptions with arbitrary context, get back aggregates, and debug production issues quickly.\"\nreadme = \"README.md\"\nlicense = {file = \"LICENSE\"}\nmaintainers = [{name = \"Rollbar, Inc.\", email = \"support@rollbar.com\"}]\nclassifiers = [\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: 3.14\",\n \"Programming Language :: Python :: 3 :: Only\",\n \"License :: OSI Approved :: MIT License\",\n \"Operating System :: OS Independent\",\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Web Environment\",\n \"Framework :: AsyncIO\",\n \"Framework :: Bottle\",\n \"Framework :: Django\",\n \"Framework :: Flask\",\n \"Framework :: Pylons\",\n \"Framework :: Pyramid\",\n \"Framework :: Twisted\",\n \"Intended Audience :: Developers\",\n \"Topic :: Internet :: WWW/HTTP\",\n \"Topic :: Software Development\",\n \"Topic :: Software Development :: Bug Tracking\",\n \"Topic :: Software Development :: Testing\",\n \"Topic :: Software Development :: Quality Assurance\",\n \"Topic :: System :: Logging\",\n \"Topic :: System :: Monitoring\",\n]\nrequires-python = \">=3.9\"\ndependencies = [\n \"requests>=0.12.1\",\n]\n\n[dependency-groups]\ntest = [\n \"blinker\",\n \"httpx\",\n \"pytest\",\n \"webob\",\n]\n\n[project.urls]\nHomepage = \"https://rollbar.com/\"\nDocumentation = \"https://docs.rollbar.com/docs/python\"\nChanges = \"https://github.com/rollbar/pyrollbar/blob/master/CHANGELOG.md\"\nSource = \"https://github.com/rollbar/pyrollbar/\"\n\n[project.scripts]\nrollbar = \"rollbar.cli:main\"\n\n[project.entry-points.\"paste.filter_app_factory\"]\npyramid = \"rollbar.contrib.pyramid:create_rollbar_middleware\"\n\n[tool.pytest]\ntestpaths = [\n \"rollbar/test\",\n]\n\n[tool.setuptools.dynamic]\nversion = {attr = \"rollbar.__version__\"}\n\n[tool.tox]\nrequires = [\"tox>=4.22\"]\n\n[tool.tox.env_run_base]\ndependency_groups = [\"test\"]\ndescription = \"run unit tests\"\ncommands = [[\"pytest\", \"{posargs}\"]]\n" }, { "path": "rollbar/__init__.py", "content": "from __future__ import absolute_import, annotations\nfrom __future__ import unicode_literals\n\nimport copy\nimport functools\nimport inspect\nimport json\nimport logging\nimport os\nimport socket\nimport sys\nimport threading\nimport time\nimport traceback\nimport types\nimport uuid\nimport wsgiref.util\nimport warnings\nimport queue\nfrom urllib.parse import parse_qs, urljoin\n\nimport requests\n\nfrom rollbar.lib import events, filters, dict_merge, transport, defaultJSONEncode\nfrom rollbar.lib.payload import Attribute\nfrom rollbar.lib.session import get_current_session, set_current_session, parse_session_request_baggage_headers\n\n__version__ = '1.4.0-beta'\n__log_name__ = 'rollbar'\nlog = logging.getLogger(__log_name__)\n\n\n# import request objects from various frameworks, if available\ntry:\n from webob import BaseRequest as WebobBaseRequest\nexcept ImportError:\n WebobBaseRequest = None\n\ntry:\n from django.core.exceptions import ImproperlyConfigured\nexcept ImportError:\n DjangoHttpRequest = None\n RestFrameworkRequest = None\n\nelse:\n try:\n from django.http import HttpRequest as DjangoHttpRequest\n except (ImportError, ImproperlyConfigured):\n DjangoHttpRequest = None\n\n try:\n from rest_framework.request import Request as RestFrameworkRequest\n except (ImportError, ImproperlyConfigured):\n RestFrameworkRequest = None\n\n del ImproperlyConfigured\n\ntry:\n from werkzeug.wrappers import Request as WerkzeugRequest\nexcept (ImportError, SyntaxError):\n WerkzeugRequest = None\n\ntry:\n from werkzeug.local import LocalProxy as WerkzeugLocalProxy\nexcept (ImportError, SyntaxError):\n WerkzeugLocalProxy = None\n\ntry:\n from tornado.httpserver import HTTPRequest as TornadoRequest\nexcept ImportError:\n TornadoRequest = None\n\ntry:\n from bottle import BaseRequest as BottleRequest\nexcept ImportError:\n BottleRequest = None\n\ntry:\n from sanic.request import Request as SanicRequest\nexcept ImportError:\n SanicRequest = None\n\ntry:\n from google.appengine.api.urlfetch import fetch as AppEngineFetch\nexcept (ImportError, KeyError):\n AppEngineFetch = None\n\ntry:\n from starlette.requests import Request as StarletteRequest\nexcept ImportError:\n StarletteRequest = None\n\ntry:\n from fastapi.requests import Request as FastAPIRequest\nexcept ImportError:\n FastAPIRequest = None\n\ntry:\n import httpx\nexcept ImportError:\n httpx = None\n\nAsyncHTTPClient = httpx\n\ndef passthrough_decorator(func):\n def wrap(*args, **kwargs):\n return func(*args, **kwargs)\n return wrap\n\ntry:\n from tornado.httpclient import AsyncHTTPClient as TornadoAsyncHTTPClient\nexcept ImportError:\n TornadoAsyncHTTPClient = None\n\ntry:\n import treq\n from twisted.python import log as twisted_log\n from twisted.web.iweb import IPolicyForHTTPS\n from twisted.web.client import BrowserLikePolicyForHTTPS, Agent\n from twisted.internet.ssl import CertificateOptions\n from twisted.internet import task, defer, ssl, reactor\n from zope.interface import implementer\n\n @implementer(IPolicyForHTTPS)\n class VerifyHTTPS(object):\n def __init__(self):\n # by default, handle requests like a browser would\n self.default_policy = BrowserLikePolicyForHTTPS()\n\n def creatorForNetloc(self, hostname, port):\n # check if the hostname is in the the whitelist, otherwise return the default policy\n if not SETTINGS['verify_https']:\n return ssl.CertificateOptions(verify=False)\n return self.default_policy.creatorForNetloc(hostname, port)\n\n def log_handler(event):\n \"\"\"\n Default uncaught error handler\n \"\"\"\n try:\n if not event.get('isError') or 'failure' not in event:\n return\n\n err = event['failure']\n\n # Don't report Rollbar internal errors to ourselves\n if issubclass(err.type, ApiException):\n log.error('Rollbar internal error: %s', err.value)\n else:\n report_exc_info((err.type, err.value, err.getTracebackObject()))\n except:\n log.exception('Error while reporting to Rollbar')\n\n # Add Rollbar as a log handler which will report uncaught errors\n twisted_log.addObserver(log_handler)\n\n\nexcept ImportError:\n treq = None\n\ntry:\n from falcon import Request as FalconRequest\nexcept ImportError:\n FalconRequest = None\n\n\ndef get_request():\n \"\"\"\n Get the current request object. Implementation varies on\n library support. Modified below when we know which framework\n is being used.\n \"\"\"\n\n # TODO(cory): add in a generic _get_locals_request() which\n # will iterate up through the call stack and look for a variable\n # that appears to be valid request object.\n for fn in (_get_fastapi_request,\n _get_starlette_request,\n _get_bottle_request,\n _get_flask_request,\n _get_pyramid_request,\n _get_pylons_request):\n try:\n req = fn()\n if req is not None:\n return req\n except:\n pass\n\n return None\n\n\ndef _get_bottle_request():\n if BottleRequest is None:\n return None\n from bottle import request\n return request\n\n\ndef _get_flask_request():\n if WerkzeugRequest is None:\n return None\n from flask import request\n return request\n\n\ndef _get_pyramid_request():\n if WebobBaseRequest is None:\n return None\n from pyramid.threadlocal import get_current_request\n return get_current_request()\n\n\ndef _get_pylons_request():\n if WebobBaseRequest is None:\n return None\n from pylons import request\n return request\n\n\ndef _get_starlette_request():\n # Do not modify the returned object\n\n if StarletteRequest is None:\n return None\n\n from rollbar.contrib.starlette import get_current_request\n return get_current_request()\n\n\ndef _get_fastapi_request():\n # Do not modify the returned object\n\n if FastAPIRequest is None:\n return None\n\n from rollbar.contrib.fastapi import get_current_request\n return get_current_request()\n\n\nBASE_DATA_HOOK = None\n\nagent_log = None\n\nVERSION = __version__\nDEFAULT_ENDPOINT = 'https://api.rollbar.com/api/1/'\nDEFAULT_TIMEOUT = 3\nANONYMIZE = 'anonymize'\n\nDEFAULT_LOCALS_SIZES = {\n 'maxlevel': 5,\n 'maxdict': 10,\n 'maxlist': 10,\n 'maxtuple': 10,\n 'maxset': 10,\n 'maxfrozenset': 10,\n 'maxdeque': 10,\n 'maxarray': 10,\n 'maxstring': 100,\n 'maxlong': 40,\n 'maxother': 100,\n}\n\n# configuration settings\n# configure by calling init() or overriding directly\nSETTINGS = {\n 'access_token': None,\n 'enabled': True,\n 'environment': 'production',\n 'exception_level_filters': [],\n 'root': None, # root path to your code\n 'host': None, # custom hostname of the current host\n 'branch': None, # git branch name\n 'code_version': None,\n # 'blocking', 'thread' (default), 'async', 'agent', 'tornado', 'gae', 'twisted', 'httpx' or 'thread_pool'\n # 'async' requires Python 3.4 or higher.\n # 'httpx' requires Python 3.7 or higher.\n # 'thread_pool' requires Python 3.2 or higher.\n 'handler': 'default',\n 'thread_pool_workers': None,\n 'endpoint': DEFAULT_ENDPOINT,\n 'timeout': DEFAULT_TIMEOUT,\n 'agent.log_file': 'log.rollbar',\n 'scrub_fields': [\n 'pw',\n 'passwd',\n 'password',\n 'secret',\n 'confirm_password',\n 'confirmPassword',\n 'password_confirmation',\n 'passwordConfirmation',\n 'access_token',\n 'accessToken',\n 'auth',\n 'authentication',\n 'authorization',\n ],\n 'url_fields': ['url', 'link', 'href'],\n 'notifier': {\n 'name': 'pyrollbar',\n 'version': VERSION\n },\n 'allow_logging_basic_config': True, # set to False to avoid a call to logging.basicConfig()\n 'locals': {\n 'enabled': True,\n 'safe_repr': True,\n 'scrub_varargs': True,\n 'sizes': DEFAULT_LOCALS_SIZES,\n 'safelisted_types': [],\n 'whitelisted_types': []\n },\n 'verify_https': True,\n 'shortener_keys': [],\n 'suppress_reinit_warning': False,\n 'capture_email': False,\n 'capture_username': False,\n 'capture_ip': True,\n 'log_all_rate_limited_items': True,\n 'log_payload_on_error': True,\n 'http_proxy': None,\n 'http_proxy_user': None,\n 'http_proxy_password': None,\n 'include_request_body': False,\n 'request_pool_connections': None,\n 'request_pool_maxsize': None,\n 'request_max_retries': None,\n 'batch_transforms': False,\n 'custom_transforms': [],\n}\n\n_CURRENT_LAMBDA_CONTEXT = None\n_LAST_RESPONSE_STATUS = None\n\n# Set in init()\n_transforms = []\n_serialize_transform = None\n_scrub_redact_transform = None\n\n_initialized = False\n\nfrom rollbar.lib.transforms.scrub_redact import REDACT_REF\n\nfrom rollbar.lib import transforms\nfrom rollbar.lib import type_info\nfrom rollbar.lib.transforms.scrub import ScrubTransform\nfrom rollbar.lib.transforms.scruburl import ScrubUrlTransform\nfrom rollbar.lib.transforms.scrub_redact import ScrubRedactTransform\nfrom rollbar.lib.transforms.serializable import SerializableTransform\nfrom rollbar.lib.transforms.shortener import ShortenerTransform\nfrom rollbar.lib.transforms.batched import BatchedTransform\n\n\n## public api\n\ndef init(access_token, environment='production', scrub_fields=None, url_fields=None, **kw):\n \"\"\"\n Saves configuration variables in this module's SETTINGS.\n\n access_token: project access token. Get this from the Rollbar UI:\n - click \"Settings\" in the top nav\n - click \"Projects\" in the left nav\n - copy-paste the appropriate token.\n environment: environment name. Can be any string; suggestions: 'production', 'development',\n 'staging', 'yourname'\n **kw: provided keyword arguments will override keys in SETTINGS.\n \"\"\"\n global SETTINGS, agent_log, _initialized, _transforms, _serialize_transform, _scrub_redact_transform, _threads\n\n if scrub_fields is not None:\n SETTINGS['scrub_fields'] = list(scrub_fields)\n if url_fields is not None:\n SETTINGS['url_fields'] = list(url_fields)\n\n # Merge the extra config settings into SETTINGS\n SETTINGS = dict_merge(SETTINGS, kw)\n if _initialized:\n # NOTE: Temp solution to not being able to re-init.\n # New versions of pyrollbar will support re-initialization\n # via the (not-yet-implemented) configure() method.\n if not SETTINGS.get('suppress_reinit_warning'):\n log.warning('Rollbar already initialized. Ignoring re-init.')\n return\n\n SETTINGS['access_token'] = access_token\n SETTINGS['environment'] = environment\n _configure_transport(**SETTINGS)\n\n if SETTINGS.get('allow_logging_basic_config'):\n logging.basicConfig()\n\n if SETTINGS.get('handler') == 'agent':\n agent_log = _create_agent_log()\n elif SETTINGS.get('handler') == 'thread_pool':\n from rollbar.lib.thread_pool import init_pool\n init_pool(SETTINGS.get('thread_pool_workers', None))\n\n if not SETTINGS['locals']['safelisted_types'] and SETTINGS['locals']['whitelisted_types']:\n warnings.warn('whitelisted_types deprecated use safelisted_types instead', DeprecationWarning)\n SETTINGS['locals']['safelisted_types'] = SETTINGS['locals']['whitelisted_types']\n\n # We will perform these transforms in order:\n # 1. Serialize the payload to be all python built-in objects\n # 2. Scrub the payloads based on the key suffixes in SETTINGS['scrub_fields']\n # 3. Scrub URLs in the payload for keys that end with 'url'\n # 4. Optional - If local variable gathering is enabled, transform the\n # trace frame values using the ShortReprTransform.\n _serialize_transform = SerializableTransform(safe_repr=SETTINGS['locals']['safe_repr'],\n safelist_types=SETTINGS['locals']['safelisted_types'])\n\n _scrub_redact_transform = ScrubRedactTransform(suffixes=[(field,) for field in SETTINGS['scrub_fields']], redact_char='*')\n\n # A list of key prefixes to apply our shortener transform to. The request\n # being included in the body key is old behavior and is being retained for\n # backwards compatibility.\n shortener_keys = [\n ('request', 'POST'),\n ('request', 'json'),\n ('body', 'request', 'POST'),\n ('body', 'request', 'json'),\n ]\n\n if SETTINGS['locals']['enabled']:\n for prefix in (('body', 'trace'), ('body', 'trace_chain', '*')):\n shortener_keys.append(prefix + ('frames', '*', 'code'))\n shortener_keys.append(prefix + ('frames', '*', 'args', '*'))\n shortener_keys.append(prefix + ('frames', '*', 'kwargs', '*'))\n shortener_keys.append(prefix + ('frames', '*', 'locals', '*'))\n\n shortener_keys.extend(SETTINGS['shortener_keys'])\n\n shortener = ShortenerTransform(safe_repr=SETTINGS['locals']['safe_repr'],\n keys=shortener_keys,\n **SETTINGS['locals']['sizes'])\n _transforms = [\n shortener, # priority: 10\n _scrub_redact_transform, # priority: 20\n _serialize_transform, # priority: 30\n ScrubUrlTransform(suffixes=[(field,) for field in SETTINGS['url_fields']],\n params_to_scrub=SETTINGS['scrub_fields']) # priority: 50\n ]\n\n # Add custom transforms\n if len(SETTINGS['custom_transforms']) > 0:\n _transforms.extend(SETTINGS['custom_transforms'])\n\n # Sort the transforms by priority\n _transforms = sorted(_transforms, key=lambda x: x.priority)\n\n _threads = queue.Queue()\n events.reset()\n filters.add_builtin_filters(SETTINGS)\n\n _initialized = True\n\n\ndef _configure_transport(**kw):\n configuration = _requests_configuration(**kw)\n transport.configure_pool(**configuration)\n\n\ndef _requests_configuration(**kw):\n keys = {\n 'request_pool_connections': 'pool_connections',\n 'request_pool_maxsize': 'pool_maxsize',\n 'request_max_retries': 'max_retries',\n }\n return {keys[k]: kw.get(k, None) for k in keys}\n\n\ndef lambda_function(f):\n \"\"\"\n Decorator for making error handling on AWS Lambda easier\n \"\"\"\n @functools.wraps(f)\n def wrapper(event, context):\n global _CURRENT_LAMBDA_CONTEXT\n _CURRENT_LAMBDA_CONTEXT = context\n try:\n result = f(event, context)\n return wait(lambda: result)\n except:\n cls, exc, trace = sys.exc_info()\n report_exc_info((cls, exc, trace.tb_next))\n wait()\n raise\n return wrapper\n\n\ndef report_exc_info(exc_info=None, request=None, extra_data=None, payload_data=None, level=None, **kw):\n \"\"\"\n Reports an exception to Rollbar, using exc_info (from calling sys.exc_info())\n\n exc_info: optional, should be the result of calling sys.exc_info(). If omitted, sys.exc_info() will be called here.\n request: optional, a WebOb, Werkzeug-based or Sanic request object.\n extra_data: optional, will be included in the 'custom' section of the payload\n payload_data: optional, dict that will override values in the final payload\n (e.g. 'level' or 'fingerprint')\n kw: provided for legacy purposes; unused.\n\n Example usage:\n\n rollbar.init(access_token='YOUR_PROJECT_ACCESS_TOKEN')\n try:\n do_something()\n except:\n rollbar.report_exc_info(sys.exc_info(), request, {'foo': 'bar'}, {'level': 'warning'})\n \"\"\"\n if exc_info is None:\n exc_info = sys.exc_info()\n\n try:\n return _report_exc_info(exc_info, request, extra_data, payload_data, level=level)\n except Exception as e:\n log.exception(\"Exception while reporting exc_info to Rollbar. %r\", e)\n\n\ndef report_message(message, level='error', request=None, extra_data=None, payload_data=None):\n \"\"\"\n Reports an arbitrary string message to Rollbar.\n\n message: the string body of the message\n level: level to report at. One of: 'critical', 'error', 'warning', 'info', 'debug'\n request: the request object for the context of the message\n extra_data: optional, will be included in the 'custom' section of the payload\n payload_data: param names to pass in the 'data' level of the payload; overrides defaults.\n \"\"\"\n try:\n return _report_message(message, level, request, extra_data, payload_data)\n except Exception as e:\n log.exception(\"Exception while reporting message to Rollbar. %r\", e)\n\n\ndef send_payload(payload, access_token):\n \"\"\"\n Sends a payload object, (the result of calling _build_payload() + _serialize_payload()).\n Uses the configured handler from SETTINGS['handler']\n\n Available handlers:\n - 'blocking': calls _send_payload() (which makes an HTTP request) immediately, blocks on it\n - 'thread': starts a single-use thread that will call _send_payload(). returns immediately.\n - 'async': calls _send_payload_async() (which makes an async HTTP request using default async handler)\n - 'agent': writes to a log file to be processed by rollbar-agent\n - 'tornado': calls _send_payload_tornado() (which makes an async HTTP request using tornado's AsyncHTTPClient)\n - 'gae': calls _send_payload_appengine() (which makes a blocking call to Google App Engine)\n - 'twisted': calls _send_payload_twisted() (which makes an async HTTP request using Twisted and Treq)\n - 'httpx': calls _send_payload_httpx() (which makes an async HTTP request using HTTPX)\n - 'thread_pool': uses a pool of worker threads to make HTTP requests off the main thread. Returns immediately.\n \"\"\"\n payload = events.on_payload(payload)\n if payload is False:\n return\n\n if sys.version_info >= (3, 6):\n from rollbar.lib._async import get_current_handler\n handler = get_current_handler()\n else:\n handler = SETTINGS.get('handler')\n\n if handler == 'twisted':\n payload['data']['framework'] = 'twisted'\n\n payload_str = _serialize_payload(payload)\n if handler == 'blocking':\n _send_payload(payload_str, access_token)\n elif handler == 'agent':\n agent_log.error(payload_str)\n elif handler == 'tornado':\n if TornadoAsyncHTTPClient is None:\n log.error('Unable to find tornado')\n return\n _send_payload_tornado(payload_str, access_token)\n elif handler == 'gae':\n if AppEngineFetch is None:\n log.error('Unable to find AppEngine URLFetch module')\n return\n _send_payload_appengine(payload_str, access_token)\n elif handler == 'twisted':\n if treq is None:\n log.error('Unable to find Treq')\n return\n _send_payload_twisted(payload_str, access_token)\n elif handler == 'httpx':\n if httpx is None:\n log.error('Unable to find HTTPX')\n return\n _send_payload_httpx(payload_str, access_token)\n elif handler == 'async':\n if AsyncHTTPClient is None:\n log.error('Unable to find async handler')\n return\n _send_payload_async(payload_str, access_token)\n elif handler == 'thread':\n _send_payload_thread(payload_str, access_token)\n elif handler == 'thread_pool':\n _send_payload_thread_pool(payload_str, access_token)\n else:\n # default to 'thread'\n _send_payload_thread(payload_str, access_token)\n\n\ndef search_items(title, return_fields=None, access_token=None, endpoint=None, **search_fields):\n \"\"\"\n Searches a project for items that match the input criteria.\n\n title: all or part of the item's title to search for.\n return_fields: the fields that should be returned for each item.\n e.g. ['id', 'project_id', 'status'] will return a dict containing\n only those fields for each item.\n access_token: a project access token. If this is not provided,\n the one provided to init() will be used instead.\n search_fields: additional fields to include in the search.\n currently supported: status, level, environment\n \"\"\"\n if not title:\n return []\n\n if return_fields is not None:\n return_fields = ','.join(return_fields)\n\n return _get_api('search/',\n title=title,\n fields=return_fields,\n access_token=access_token,\n endpoint=endpoint,\n **search_fields)\n\n\ndef wait(f=None):\n _threads.join()\n if f is not None:\n return f()\n\n\nclass ApiException(Exception):\n \"\"\"\n This exception will be raised if there was a problem decoding the\n response from an API call.\n \"\"\"\n pass\n\n\nclass ApiError(ApiException):\n \"\"\"\n This exception will be raised if the API response contains an 'err'\n field, denoting there was a problem fulfilling the api request.\n \"\"\"\n pass\n\n\nclass Result(object):\n \"\"\"\n This class encapsulates the response from an API call.\n Usage:\n\n result = search_items(title='foo', fields=['id'])\n print result.data\n \"\"\"\n\n def __init__(self, access_token, path, params, data):\n self.access_token = access_token\n self.path = path\n self.params = params\n self.data = data\n\n def __str__(self):\n return str(self.data)\n\n\nclass PagedResult(Result):\n \"\"\"\n This class wraps the response from an API call that responded with\n a page of results.\n Usage:\n\n result = search_items(title='foo', fields=['id'])\n print 'First page: %d, data: %s' % (result.page, result.data)\n result = result.next_page()\n print 'Second page: %d, data: %s' % (result.page, result.data)\n \"\"\"\n def __init__(self, access_token, path, page_num, params, data, endpoint=None):\n super(PagedResult, self).__init__(access_token, path, params, data)\n self.page = page_num\n self.endpoint = endpoint\n\n def next_page(self):\n params = copy.copy(self.params)\n params['page'] = self.page + 1\n return _get_api(self.path, endpoint=self.endpoint, **params)\n\n def prev_page(self):\n if self.page <= 1:\n return self\n params = copy.copy(self.params)\n params['page'] = self.page - 1\n return _get_api(self.path, endpoint=self.endpoint, **params)\n\n\n## internal functions\n\n\ndef _resolve_exception_class(idx, filter):\n cls, level = filter\n if isinstance(cls, str):\n # Lazily resolve class name\n parts = cls.split('.')\n module = '.'.join(parts[:-1])\n if module in sys.modules and hasattr(sys.modules[module], parts[-1]):\n cls = getattr(sys.modules[module], parts[-1])\n SETTINGS['exception_level_filters'][idx] = (cls, level)\n else:\n cls = None\n return cls, level\n\n\ndef _filtered_level(exception):\n for i, filter in enumerate(SETTINGS['exception_level_filters']):\n cls, level = _resolve_exception_class(i, filter)\n if cls and isinstance(exception, cls):\n return level\n\n return None\n\n\ndef _is_ignored(exception):\n return _filtered_level(exception) == 'ignored'\n\n\ndef _create_agent_log():\n \"\"\"\n Creates .rollbar log file for use with rollbar-agent\n \"\"\"\n log_file = SETTINGS['agent.log_file']\n if not log_file.endswith('.rollbar'):\n log.error(\"Provided agent log file does not end with .rollbar, which it must. \"\n \"Using default instead.\")\n log_file = DEFAULTS['agent.log_file']\n\n retval = logging.getLogger('rollbar_agent')\n handler = logging.FileHandler(log_file, 'a', 'utf-8')\n formatter = logging.Formatter('%(message)s')\n handler.setFormatter(formatter)\n retval.addHandler(handler)\n retval.setLevel(logging.WARNING)\n return retval\n\n\ndef _report_exc_info(exc_info, request, extra_data, payload_data, level=None):\n \"\"\"\n Called by report_exc_info() wrapper\n \"\"\"\n\n if not _check_config():\n return\n\n filtered_level = _filtered_level(exc_info[1])\n if level is None:\n level = filtered_level\n\n filtered_exc_info = events.on_exception_info(exc_info,\n request=request,\n extra_data=extra_data,\n payload_data=payload_data,\n level=level)\n\n if filtered_exc_info is False:\n return\n\n cls, exc, trace = filtered_exc_info\n\n data = _build_base_data(request)\n if level is not None:\n data['level'] = level\n\n # walk the trace chain to collect cause and context exceptions\n trace_chain = _walk_trace_chain(cls, exc, trace)\n\n extra_trace_data = None\n if len(trace_chain) > 1:\n data['body'] = {\n 'trace_chain': trace_chain\n }\n if payload_data and ('body' in payload_data) and ('trace' in payload_data['body']):\n extra_trace_data = payload_data['body']['trace']\n del payload_data['body']['trace']\n else:\n data['body'] = {\n 'trace': trace_chain[0]\n }\n\n if extra_data:\n extra_data = extra_data\n if not isinstance(extra_data, dict):\n extra_data = {'value': extra_data}\n if extra_trace_data:\n extra_data = dict_merge(extra_data, extra_trace_data, silence_errors=True)\n data['custom'] = extra_data\n if extra_trace_data and not extra_data:\n data['custom'] = extra_trace_data\n\n request = _get_actual_request(request)\n _add_request_data(data, request)\n _add_person_data(data, request)\n _add_lambda_context_data(data)\n _add_session_data(data)\n data['server'] = _build_server_data()\n\n if payload_data:\n data = dict_merge(data, payload_data, silence_errors=True)\n\n payload = _build_payload(data)\n send_payload(payload, payload.get('access_token'))\n\n return data['uuid']\n\n\ndef _walk_trace_chain(cls, exc, trace):\n trace_chain = [_trace_data(cls, exc, trace)]\n\n seen_exceptions = {exc}\n\n while True:\n exc = getattr(exc, '__cause__', None) or getattr(exc, '__context__', None)\n if not exc:\n break\n trace_chain.append(_trace_data(type(exc), exc, getattr(exc, '__traceback__', None)))\n if exc in seen_exceptions:\n break\n seen_exceptions.add(exc)\n\n return trace_chain\n\n\ndef _trace_data(cls, exc, trace):\n # exception info\n # most recent call last\n raw_frames = traceback.extract_tb(trace)\n frames = [{'filename': f[0], 'lineno': f[1], 'method': f[2], 'code': f[3]} for f in raw_frames]\n\n trace_data = {\n 'frames': frames,\n 'exception': {\n 'class': getattr(cls, '__name__', cls.__class__.__name__),\n 'message': str(exc),\n }\n }\n\n _add_locals_data(trace_data, (cls, exc, trace))\n\n return trace_data\n\n\ndef _report_message(message, level, request, extra_data, payload_data):\n \"\"\"\n Called by report_message() wrapper\n \"\"\"\n if not _check_config():\n return\n\n filtered_message = events.on_message(message,\n request=request,\n extra_data=extra_data,\n payload_data=payload_data,\n level=level)\n\n if filtered_message is False:\n return\n\n data = _build_base_data(request, level=level)\n\n # message\n data['body'] = {\n 'message': {\n 'body': filtered_message\n }\n }\n\n if extra_data:\n extra_data = extra_data\n data['body']['message'].update(extra_data)\n data['custom'] = extra_data\n\n request = _get_actual_request(request)\n _add_request_data(data, request)\n _add_person_data(data, request)\n _add_lambda_context_data(data)\n _add_session_data(data)\n data['server'] = _build_server_data()\n\n if payload_data:\n data = dict_merge(data, payload_data, silence_errors=True)\n\n payload = _build_payload(data)\n send_payload(payload, payload.get('access_token'))\n\n return data['uuid']\n\n\ndef _add_session_data(data: dict) -> None:\n \"\"\"\n Adds session data to the payload data if it can be found in the current session or request.\n \"\"\"\n session_data = get_current_session()\n if session_data:\n _add_session_attributes(data, session_data)\n return\n\n request = _session_data_from_request(data)\n if request is None:\n return\n session_data = parse_session_request_baggage_headers(request.get('headers', None))\n\n if session_data:\n _add_session_attributes(data, session_data)\n\n\ndef _add_session_attributes(data: dict, session_data: list[Attribute]) -> None:\n \"\"\"\n Adds session attributes to the payload data. This function is careful to not overwrite any existing data in the\n payload.\n \"\"\"\n if 'attributes' not in data:\n data['attributes'] = session_data\n return\n\n existing_keys = {a['key'] for a in data['attributes']}\n\n for attribute in session_data:\n if attribute['key'] not in existing_keys:\n data['attributes'].append(attribute)\n\n\ndef _session_data_from_request(data: dict) -> dict:\n \"\"\"\n Tries to find session data in the request object. Use the request object if provided, otherwise check the data as\n it may already contain the request object. This is true for some frameworks (e.g. Django).\n \"\"\"\n if data is not None and 'request' in data:\n return data.get('request', None)\n return _get_actual_request(_build_request_data(get_request()))\n\n\ndef _check_config():\n if not SETTINGS.get('enabled'):\n log.info(\"pyrollbar: Not reporting because rollbar is disabled.\")\n return False\n\n # skip access token check for the agent handler\n if SETTINGS.get('handler') == 'agent':\n return True\n\n # make sure we have an access_token\n if not SETTINGS.get('access_token'):\n log.warning(\"pyrollbar: No access_token provided. Please configure by calling rollbar.init() with your access token.\")\n return False\n\n return True\n\n\ndef _build_base_data(request, level='error'):\n data = {\n 'timestamp': int(time.time()),\n 'environment': SETTINGS['environment'],\n 'level': level,\n 'language': 'python %s' % '.'.join(str(x) for x in sys.version_info[:3]),\n 'notifier': SETTINGS['notifier'],\n 'uuid': str(uuid.uuid4()),\n }\n\n if SETTINGS.get('code_version'):\n data['code_version'] = SETTINGS['code_version']\n\n if BASE_DATA_HOOK:\n BASE_DATA_HOOK(request, data)\n\n return data\n\n\ndef _add_person_data(data, request):\n try:\n person_data = _build_person_data(request)\n except Exception as e:\n log.exception(\"Exception while building person data for Rollbar payload: %r\", e)\n else:\n if person_data:\n if not SETTINGS['capture_username'] and 'username' in person_data:\n person_data['username'] = None\n if not SETTINGS['capture_email'] and 'email' in person_data:\n person_data['email'] = None\n data['person'] = person_data\n\n\ndef _build_person_data(request):\n \"\"\"\n Returns a dictionary describing the logged-in user using data from `request`.\n\n Try request.rollbar_person first, then 'user', then 'user_id'\n \"\"\"\n if hasattr(request, 'rollbar_person'):\n rollbar_person_prop = request.rollbar_person\n person = rollbar_person_prop() if callable(rollbar_person_prop) else rollbar_person_prop\n if person and isinstance(person, dict):\n return person\n else:\n return None\n\n if StarletteRequest:\n from rollbar.contrib.starlette.requests import hasuser\n else:\n def hasuser(request): return True\n\n if hasuser(request) and hasattr(request, 'user'):\n user_prop = request.user\n user = user_prop() if callable(user_prop) else user_prop\n if not user:\n return None\n elif isinstance(user, dict):\n return user\n else:\n retval = {}\n if getattr(user, 'id', None):\n retval['id'] = str(user.id)\n elif getattr(user, 'user_id', None):\n retval['id'] = str(user.user_id)\n\n # id is required, so only include username/email if we have an id\n if retval.get('id'):\n username = getattr(user, 'username', None)\n email = getattr(user, 'email', None)\n retval.update({\n 'username': username,\n 'email': email\n })\n return retval\n\n if hasattr(request, 'user_id'):\n user_id_prop = request.user_id\n user_id = user_id_prop() if callable(user_id_prop) else user_id_prop\n if not user_id:\n return None\n return {'id': str(user_id)}\n\n\ndef _get_func_from_frame(frame):\n func_name = inspect.getframeinfo(frame).function\n caller = frame.f_back\n if caller:\n func = caller.f_locals.get(func_name,\n caller.f_globals.get(func_name))\n else:\n func = None\n\n return func\n\n\ndef _add_locals_data(trace_data, exc_info):\n if not SETTINGS['locals']['enabled']:\n return\n\n frames = trace_data['frames']\n\n cur_tb = exc_info[2]\n frame_num = 0\n num_frames = len(frames)\n while cur_tb:\n cur_frame = frames[frame_num]\n tb_frame = cur_tb.tb_frame\n cur_tb = cur_tb.tb_next\n\n if not isinstance(tb_frame, types.FrameType):\n # this can happen if the traceback or frame is wrapped in some way,\n # for example by `ExceptionInfo` in\n # https://github.com/celery/billiard/blob/master/billiard/einfo.py\n log.warning('Traceback frame not a types.FrameType. Ignoring.')\n frame_num += 1\n continue\n\n # Create placeholders for argspec/varargspec/keywordspec/locals\n argspec = None\n varargspec = None\n keywordspec = None\n _locals = {}\n\n try:\n arginfo = inspect.getargvalues(tb_frame)\n\n # Optionally fill in locals for this frame\n if arginfo.locals and _check_add_locals(cur_frame, frame_num, num_frames):\n # Get all of the named args\n argspec = arginfo.args\n\n if arginfo.varargs is not None:\n varargspec = arginfo.varargs\n if SETTINGS['locals']['scrub_varargs']:\n temp_varargs = list(arginfo.locals[varargspec])\n for i, arg in enumerate(temp_varargs):\n temp_varargs[i] = REDACT_REF\n\n arginfo.locals[varargspec] = tuple(temp_varargs)\n\n if arginfo.keywords is not None:\n keywordspec = arginfo.keywords\n\n _locals.update(arginfo.locals.items())\n\n except Exception:\n log.exception('Error while extracting arguments from frame. Ignoring.')\n\n # Finally, serialize each arg/kwarg/local separately so that we only report\n # CircularReferences for each variable, instead of for the entire payload\n # as would be the case if we serialized that payload in one-shot.\n if argspec:\n cur_frame['argspec'] = argspec\n if varargspec:\n cur_frame['varargspec'] = varargspec\n if keywordspec:\n cur_frame['keywordspec'] = keywordspec\n if _locals:\n try:\n cur_frame['locals'] = {k: _serialize_frame_data(v) for k, v in _locals.items()}\n except Exception:\n log.exception('Error while serializing frame data.')\n\n frame_num += 1\n\n\ndef _serialize_frame_data(data):\n return transforms.transform(\n data,\n [_scrub_redact_transform, _serialize_transform],\n batch_transforms=SETTINGS['batch_transforms']\n )\n\n\ndef _add_lambda_context_data(data):\n \"\"\"\n Attempts to add information from the lambda context if it exists\n \"\"\"\n global _CURRENT_LAMBDA_CONTEXT\n context = _CURRENT_LAMBDA_CONTEXT\n if context is None:\n return\n try:\n lambda_data = {\n 'lambda': {\n 'remaining_time_in_millis': context.get_remaining_time_in_millis(),\n 'function_name': context.function_name,\n 'function_version': context.function_version,\n 'arn': context.invoked_function_arn,\n 'request_id': context.aws_request_id,\n }\n }\n if 'custom' in data:\n data['custom'] = dict_merge(data['custom'], lambda_data, silence_errors=True)\n else:\n data['custom'] = lambda_data\n except Exception as e:\n log.exception(\"Exception while adding lambda context data: %r\", e)\n finally:\n _CURRENT_LAMBDA_CONTEXT = None\n\n\ndef _add_request_data(data, request):\n \"\"\"\n Attempts to build request data; if successful, sets the 'request' key on `data`.\n \"\"\"\n try:\n request_data = _build_request_data(request)\n except Exception as e:\n log.exception(\"Exception while building request_data for Rollbar payload: %r\", e)\n else:\n if request_data:\n _filter_ip(request_data, SETTINGS['capture_ip'])\n data['request'] = request_data\n\n\ndef _check_add_locals(frame, frame_num, total_frames):\n \"\"\"\n Returns True if we should record local variables for the given frame.\n \"\"\"\n # Include the last frames locals\n # Include any frame locals that came from a file in the project's root\n root = SETTINGS.get('root')\n if root:\n # coerce to string, in case root is a Path object\n root = str(root)\n else:\n root = ''\n return any(((frame_num == total_frames - 1),\n ('root' in SETTINGS and (frame.get('filename') or '').lower().startswith(root.lower()))))\n\n\ndef _get_actual_request(request):\n if WerkzeugLocalProxy and isinstance(request, WerkzeugLocalProxy):\n try:\n actual_request = request._get_current_object()\n except RuntimeError:\n return None\n return actual_request\n return request\n\n\ndef _build_request_data(request):\n \"\"\"\n Returns a dictionary containing data from the request.\n \"\"\"\n\n # webob (pyramid)\n if WebobBaseRequest and isinstance(request, WebobBaseRequest):\n return _build_webob_request_data(request)\n\n # django\n if DjangoHttpRequest and isinstance(request, DjangoHttpRequest):\n return _build_django_request_data(request)\n\n # django rest framework\n if RestFrameworkRequest and isinstance(request, RestFrameworkRequest):\n return _build_django_request_data(request)\n\n # werkzeug (flask)\n if WerkzeugRequest and isinstance(request, WerkzeugRequest):\n return _build_werkzeug_request_data(request)\n\n # tornado\n if TornadoRequest and isinstance(request, TornadoRequest):\n return _build_tornado_request_data(request)\n\n # bottle\n if BottleRequest and isinstance(request, BottleRequest):\n return _build_bottle_request_data(request)\n\n # Sanic\n if SanicRequest and isinstance(request, SanicRequest):\n return _build_sanic_request_data(request)\n\n # falcon\n if FalconRequest and isinstance(request, FalconRequest):\n return _build_falcon_request_data(request)\n\n # Plain wsgi (should be last)\n if isinstance(request, dict) and 'wsgi.version' in request:\n return _build_wsgi_request_data(request)\n\n # FastAPI (built on top of Starlette, so keep the order)\n if FastAPIRequest and isinstance(request, FastAPIRequest):\n return _build_fastapi_request_data(request)\n\n # Starlette (should be the last one for Starlette based frameworks)\n if StarletteRequest and isinstance(request, StarletteRequest):\n return _build_starlette_request_data(request)\n\n return None\n\n\ndef _build_webob_request_data(request):\n request_data = {\n 'url': request.url,\n 'GET': dict(request.GET),\n 'user_ip': _extract_user_ip(request),\n 'headers': dict(request.headers),\n 'method': request.method,\n }\n\n try:\n if request.json:\n request_data['json'] = request.json\n except:\n pass\n\n # pyramid matchdict\n if getattr(request, 'matchdict', None):\n request_data['params'] = request.matchdict\n\n # workaround for webob bug when the request body contains binary data but has a text\n # content-type\n try:\n request_data['POST'] = dict(request.POST)\n except UnicodeDecodeError:\n request_data['body'] = request.body\n\n return request_data\n\n\ndef _extract_wsgi_headers(items):\n headers = {}\n for k, v in items:\n if k.startswith('HTTP_'):\n header_name = '-'.join(k[len('HTTP_'):].replace('_', ' ').title().split(' '))\n headers[header_name] = v\n return headers\n\n\ndef _build_django_request_data(request):\n url = request.build_absolute_uri()\n\n request_data = {\n 'url': url,\n 'method': request.method,\n 'GET': dict(request.GET),\n 'POST': dict(request.POST),\n 'user_ip': _wsgi_extract_user_ip(request.META),\n }\n\n if SETTINGS['include_request_body']:\n try:\n request_data['body'] = request.body\n except:\n pass\n\n request_data['headers'] = _extract_wsgi_headers(request.META.items())\n\n return request_data\n\n\ndef _build_werkzeug_request_data(request):\n request_data = {\n 'url': request.url,\n 'GET': dict(request.args),\n 'POST': dict(request.form),\n 'user_ip': _extract_user_ip(request),\n 'headers': dict(request.headers),\n 'method': request.method,\n 'files_keys': list(request.files.keys()),\n }\n\n if SETTINGS['include_request_body']:\n try:\n if request.json:\n request_data['body'] = request.json\n except Exception:\n pass\n\n return request_data\n\n\ndef _build_tornado_request_data(request):\n request_data = {\n 'url': request.full_url(),\n 'user_ip': request.remote_ip,\n 'headers': dict(request.headers),\n 'method': request.method,\n 'files_keys': request.files.keys(),\n 'start_time': getattr(request, '_start_time', None),\n }\n request_data[request.method] = request.arguments\n\n return request_data\n\n\ndef _build_bottle_request_data(request):\n request_data = {\n 'url': request.url,\n 'user_ip': request.remote_addr,\n 'headers': dict(request.headers),\n 'method': request.method,\n 'GET': dict(request.query)\n }\n\n\n if SETTINGS['include_request_body']:\n if request.json:\n try:\n request_data['body'] = request.body.getvalue()\n except:\n pass\n else:\n request_data['POST'] = dict(request.forms)\n\n return request_data\n\n\ndef _build_sanic_request_data(request):\n request_data = {\n 'url': request.url,\n 'user_ip': request.remote_addr,\n 'headers': request.headers,\n 'method': request.method,\n 'GET': dict(request.args)\n }\n\n if SETTINGS['include_request_body']:\n if request.json:\n try:\n request_data['body'] = request.json\n except:\n pass\n else:\n request_data['POST'] = request.form\n\n return request_data\n\n\ndef _build_falcon_request_data(request):\n request_data = {\n 'url': request.url,\n 'user_ip': _wsgi_extract_user_ip(request.env),\n 'headers': dict(request.headers),\n 'method': request.method,\n 'GET': dict(request.params),\n 'context': dict(request.context),\n }\n\n return request_data\n\n\ndef _build_wsgi_request_data(request):\n request_data = {\n 'url': wsgiref.util.request_uri(request),\n 'user_ip': _wsgi_extract_user_ip(request),\n 'method': request.get('REQUEST_METHOD'),\n }\n if 'QUERY_STRING' in request:\n request_data['GET'] = parse_qs(request['QUERY_STRING'], keep_blank_values=True)\n # Collapse single item arrays\n request_data['GET'] = {k: (v[0] if len(v) == 1 else v) for k, v in request_data['GET'].items()}\n\n request_data['headers'] = _extract_wsgi_headers(request.items())\n\n if SETTINGS['include_request_body']:\n try:\n length = int(request.get('CONTENT_LENGTH', 0))\n except ValueError:\n length = 0\n input = request.get('wsgi.input')\n if length and input and hasattr(input, 'seek') and hasattr(input, 'tell'):\n pos = input.tell()\n input.seek(0, 0)\n request_data['body'] = input.read(length)\n input.seek(pos, 0)\n\n return request_data\n\ndef _build_starlette_request_data(request):\n from starlette.datastructures import UploadFile\n\n request_data = {\n 'url': str(request.url),\n 'GET': dict(request.query_params),\n 'headers': dict(request.headers),\n 'method': request.method,\n 'user_ip': _starlette_extract_user_ip(request),\n 'params': dict(request.path_params),\n }\n\n if hasattr(request, '_form') and request._form is not None:\n request_data['POST'] = {\n k: v.filename if isinstance(v, UploadFile) else v\n for k, v in request._form.items()\n }\n request_data['files_keys'] = [\n field.filename\n for field in request._form.values()\n if isinstance(field, UploadFile)\n ]\n\n if hasattr(request, '_body'):\n body = request._body.decode()\n else:\n body = None\n\n if body and SETTINGS['include_request_body']:\n request_data['body'] = body\n\n if hasattr(request, '_json'):\n request_data['json'] = request._json\n elif body:\n try:\n request_data['json'] = json.loads(body)\n except json.JSONDecodeError:\n pass\n\n # Filter out empty values\n request_data = {k: v for k, v in request_data.items() if v}\n\n return request_data\n\ndef _build_fastapi_request_data(request):\n return _build_starlette_request_data(request)\n\n\ndef _filter_ip(request_data, capture_ip):\n if 'user_ip' not in request_data or capture_ip == True:\n return\n\n current_ip = request_data['user_ip']\n if not current_ip:\n return\n\n new_ip = current_ip\n if not capture_ip:\n new_ip = None\n elif capture_ip == ANONYMIZE:\n try:\n if '.' in current_ip:\n new_ip = '.'.join(current_ip.split('.')[0:3]) + '.0'\n elif ':' in current_ip:\n parts = current_ip.split(':')\n if len(parts) > 2:\n terminal = '0000:0000:0000:0000:0000'\n new_ip = ':'.join(parts[0:3] + [terminal])\n else:\n new_ip = None\n except:\n new_ip = None\n\n request_data['user_ip'] = new_ip\n\n\ndef _build_server_data():\n \"\"\"\n Returns a dictionary containing information about the server environment.\n \"\"\"\n # server environment\n host = SETTINGS.get('host') or socket.gethostname()\n server_data = {\n 'host': host,\n 'pid': os.getpid()\n }\n\n # argv does not always exist in embedded python environments\n argv = getattr(sys, 'argv', None)\n if argv:\n server_data['argv'] = argv\n\n for key in ['branch', 'root']:\n if SETTINGS.get(key):\n server_data[key] = SETTINGS[key]\n\n return server_data\n\n\ndef _transform(obj, key=None):\n return transforms.transform(\n obj,\n _transforms,\n key=key,\n batch_transforms=SETTINGS['batch_transforms']\n )\n\n\ndef _build_payload(data):\n \"\"\"\n Returns the full payload as a string.\n \"\"\"\n\n for k, v in data.items():\n data[k] = _transform(v, key=(k,))\n\n payload = {\n 'access_token': SETTINGS['access_token'],\n 'data': data\n }\n\n return payload\n\n\ndef _serialize_payload(payload):\n return json.dumps(payload, default=defaultJSONEncode)\n\n\ndef _send_payload(payload_str, access_token):\n try:\n _post_api('item/', payload_str, access_token=access_token)\n except Exception as e:\n log.exception('Exception while posting item %r', e)\n try:\n _threads.get_nowait()\n _threads.task_done()\n except queue.Empty:\n pass\n\n\ndef _send_payload_thread(payload_str, access_token):\n thread = threading.Thread(target=_send_payload, args=(payload_str, access_token))\n _threads.put(thread)\n thread.start()\n\n\ndef _send_payload_pool(payload_str, access_token):\n try:\n _post_api('item/', payload_str, access_token=access_token)\n except Exception as e:\n log.exception('Exception while posting item %r', e)\n\n\ndef _send_payload_thread_pool(payload_str, access_token):\n from rollbar.lib.thread_pool import submit\n submit(_send_payload_pool, payload_str, access_token)\n\n\ndef _send_payload_appengine(payload_str, access_token):\n try:\n _post_api_appengine('item/', payload_str, access_token=access_token)\n except Exception as e:\n log.exception('Exception while posting item %r', e)\n\n\ndef _post_api_appengine(path, payload_str, access_token=None):\n headers = {'Content-Type': 'application/json'}\n\n if access_token is not None:\n headers['X-Rollbar-Access-Token'] = access_token\n\n url = urljoin(SETTINGS['endpoint'], path)\n resp = AppEngineFetch(url,\n method=\"POST\",\n payload=payload_str,\n headers=headers,\n allow_truncated=False,\n deadline=SETTINGS.get('timeout', DEFAULT_TIMEOUT),\n validate_certificate=SETTINGS.get('verify_https', True))\n\n return _parse_response(path, SETTINGS['access_token'], payload_str, resp)\n\n\ndef _post_api(path, payload_str, access_token=None):\n headers = {'Content-Type': 'application/json'}\n\n if access_token is not None:\n headers['X-Rollbar-Access-Token'] = access_token\n\n url = urljoin(SETTINGS['endpoint'], path)\n resp = transport.post(url,\n data=payload_str,\n headers=headers,\n timeout=SETTINGS.get('timeout', DEFAULT_TIMEOUT),\n verify=SETTINGS.get('verify_https', True),\n proxy=SETTINGS.get('http_proxy'),\n proxy_user=SETTINGS.get('http_proxy_user'),\n proxy_password=SETTINGS.get('http_proxy_password'))\n\n return _parse_response(path, SETTINGS['access_token'], payload_str, resp)\n\n\ndef _get_api(path, access_token=None, endpoint=None, **params):\n access_token = access_token or SETTINGS['access_token']\n url = urljoin(endpoint or SETTINGS['endpoint'], path)\n params['access_token'] = access_token\n resp = transport.get(url,\n params=params,\n verify=SETTINGS.get('verify_https', True),\n proxy=SETTINGS.get('http_proxy'),\n proxy_user=SETTINGS.get('http_proxy_user'),\n proxy_password=SETTINGS.get('http_proxy_password'))\n return _parse_response(path, access_token, params, resp, endpoint=endpoint)\n\n\ndef _send_payload_tornado(payload_str, access_token):\n try:\n _post_api_tornado('item/', payload_str, access_token=access_token)\n except Exception as e:\n log.exception('Exception while posting item %r', e)\n\n\ndef _post_api_tornado(path, payload_str, access_token=None):\n headers = {'Content-Type': 'application/json'}\n\n if access_token is not None:\n headers['X-Rollbar-Access-Token'] = access_token\n else:\n access_token = SETTINGS['access_token']\n\n url = urljoin(SETTINGS['endpoint'], path)\n\n def post_tornado_cb(resp):\n r = requests.Response()\n r._content = resp.body\n r.status_code = resp.code\n r.headers.update(resp.headers)\n try:\n _parse_response(path, access_token, payload_str, r)\n except Exception as e:\n log.exception('Exception while posting item %r', e)\n\n TornadoAsyncHTTPClient().fetch(url,\n callback=post_tornado_cb,\n raise_error=False,\n body=payload_str,\n method='POST',\n connect_timeout=SETTINGS.get('timeout', DEFAULT_TIMEOUT),\n request_timeout=SETTINGS.get('timeout', DEFAULT_TIMEOUT))\n\n\ndef _send_payload_twisted(payload_str, access_token):\n try:\n _post_api_twisted('item/', payload_str, access_token=access_token)\n except Exception as e:\n log.exception('Exception while posting item %r', e)\n\ndef _post_api_twisted(path, payload_str, access_token=None):\n def post_data_cb(data, resp):\n resp._content = data\n _parse_response(path, SETTINGS['access_token'], payload_str, resp)\n\n def post_cb(resp):\n r = requests.Response()\n r.status_code = resp.code\n r.headers.update(resp.headers.getAllRawHeaders())\n return treq.content(resp).addCallback(post_data_cb, r)\n\n headers = {'Content-Type': ['application/json; charset=utf-8']}\n if access_token is not None:\n headers['X-Rollbar-Access-Token'] = [access_token]\n\n url = urljoin(SETTINGS['endpoint'], path)\n try:\n encoded_payload = payload_str.encode('utf8')\n except (UnicodeDecodeError, UnicodeEncodeError):\n encoded_payload = payload_str\n\n treq_client = treq.client.HTTPClient(Agent(reactor, contextFactory=VerifyHTTPS()))\n d = treq_client.post(url, encoded_payload, headers=headers,\n timeout=SETTINGS.get('timeout', DEFAULT_TIMEOUT))\n d.addCallback(post_cb)\n\ndef _send_payload_httpx(payload_str, access_token):\n from rollbar.lib._async import call_later, _post_api_httpx\n try:\n call_later(_post_api_httpx('item/', payload_str,\n access_token=access_token))\n except Exception as e:\n log.exception('Exception while posting item %r', e)\n\n\n\ndef _send_payload_async(payload_str, access_token):\n try:\n _send_payload_httpx(payload_str, access_token=access_token)\n except Exception as e:\n log.exception('Exception while posting item %r', e)\n\n\ndef _send_failsafe(message, uuid, host):\n body_message = ('Failsafe from pyrollbar: {0}. Original payload may be found '\n 'in your server logs by searching for the UUID.').format(message)\n\n data = {\n 'level': 'error',\n 'environment': SETTINGS['environment'],\n 'body': {\n 'message': {\n 'body': body_message\n }\n },\n 'notifier': SETTINGS['notifier'],\n 'custom': {\n 'orig_uuid': uuid,\n 'orig_host': host\n },\n 'failsafe': True,\n 'internal': True,\n }\n\n payload = _build_payload(data)\n\n try:\n send_payload(payload, SETTINGS['access_token'])\n except Exception:\n log.exception('Rollbar: Error sending failsafe.')\n\n\ndef _parse_response(path, access_token, params, resp, endpoint=None):\n if isinstance(resp, requests.Response):\n try:\n data = resp.text\n except Exception:\n data = resp.content\n log.error('resp.text is undefined, resp.content is %r', resp.content)\n else:\n data = resp.content\n\n global _LAST_RESPONSE_STATUS\n last_response_was_429 = _LAST_RESPONSE_STATUS == 429\n _LAST_RESPONSE_STATUS = resp.status_code\n\n if resp.status_code == 429:\n if SETTINGS['log_all_rate_limited_items'] or not last_response_was_429:\n log.warning(\"Rollbar: over rate limit, data was dropped.\")\n if SETTINGS['log_payload_on_error']:\n log.warning(\"Payload was: %r\", params)\n return\n elif resp.status_code == 502:\n log.exception('Rollbar api returned a 502')\n return\n elif resp.status_code == 413:\n uuid = None\n host = None\n\n try:\n payload = json.loads(params)\n uuid = payload['data']['uuid']\n host = payload['data']['server']['host']\n log.error(\"Rollbar: request entity too large for UUID %r\\n.\", uuid)\n if SETTINGS['log_payload_on_error']:\n log.error(\"Payload:\\n%r\", payload)\n except (TypeError, ValueError):\n log.exception('Unable to decode JSON for failsafe.')\n except KeyError:\n log.exception('Unable to find payload parameters for failsafe.')\n\n _send_failsafe('payload too large', uuid, host)\n # TODO: Should we return here?\n elif resp.status_code != 200:\n log.warning(\"Got unexpected status code from Rollbar api: %s\\nResponse:\\n%s\",\n resp.status_code, data)\n # TODO: Should we also return here?\n\n try:\n json_data = json.loads(data)\n except (TypeError, ValueError):\n log.exception('Could not decode Rollbar api response:\\n%s', data)\n raise ApiException('Request to %s returned invalid JSON response', path)\n else:\n if json_data.get('err'):\n raise ApiError(json_data.get('message') or 'Unknown error')\n\n result = json_data.get('result', {})\n\n if 'page' in result:\n return PagedResult(access_token, path, result['page'], params, result, endpoint=endpoint)\n else:\n return Result(access_token, path, params, result)\n\n\ndef _extract_user_ip_from_headers(request):\n forwarded_for = request.headers.get('X-Forwarded-For')\n if forwarded_for:\n return forwarded_for\n real_ip = request.headers.get('X-Real-Ip')\n if real_ip:\n return real_ip\n return None\n\n\ndef _extract_user_ip(request):\n return _extract_user_ip_from_headers(request) or request.remote_addr\n\n\ndef _wsgi_extract_user_ip(environ):\n forwarded_for = environ.get('HTTP_X_FORWARDED_FOR')\n if forwarded_for:\n return forwarded_for\n real_ip = environ.get('HTTP_X_REAL_IP')\n if real_ip:\n return real_ip\n return environ['REMOTE_ADDR']\n\n\ndef _starlette_extract_user_ip(request):\n if not hasattr(request, 'client'):\n return _extract_user_ip_from_headers(request)\n if not hasattr(request.client, 'host'):\n return _extract_user_ip_from_headers(request)\n return request.client.host or _extract_user_ip_from_headers(request)\n" }, { "path": "rollbar/cli.py", "content": "import optparse\nimport sys\n\nimport rollbar\n\nVERSION = '0.1'\n\nverbose = False\n\ndef _gen_report_message(level):\n def _wrapped(lines):\n line_data = '\\n'.join(lines)\n if verbose:\n print('Rollbar [%s]: %s' % (level, line_data))\n rollbar.report_message(line_data, level=level, extra_data={'cli_version': VERSION})\n return _wrapped\n\n\nCMDS = {\n 'debug': _gen_report_message('debug'),\n 'info': _gen_report_message('info'),\n 'warning': _gen_report_message('warning'),\n 'error': _gen_report_message('error'),\n 'critical': _gen_report_message('critical'),\n}\n\ndef main():\n global verbose\n parser = optparse.OptionParser(version='%prog version ' + VERSION)\n parser.add_option('-t', '--access_token',\n dest='access_token',\n help=\"You project's access token from rollbar.com.\",\n metavar='ACCESS_TOKEN')\n parser.add_option('-e', '--environment',\n dest='environment',\n help=\"The environment to report errors and messages to. \\\n Can be any string; suggestions: 'production', 'development', 'staging'\",\n metavar='ENVIRONMENT')\n parser.add_option('-u', '--url',\n dest='endpoint_url',\n help=\"The Rollbar API endpoint url to send data to.\",\n metavar='ENDPOINT_URL',\n default=rollbar.DEFAULT_ENDPOINT)\n parser.add_option('-m', '--handler',\n dest='handler',\n help=\"The method in which to report errors.\",\n metavar='HANDLER',\n choices=[\"thread\", \"blocking\", \"agent\"],\n default=\"blocking\")\n parser.add_option('-v', '--verbose',\n dest='verbose',\n help=\"Print verbose output.\",\n action='store_true',\n default=False)\n\n options, args = parser.parse_args()\n\n access_token = options.access_token\n env = options.environment\n endpoint = options.endpoint_url\n handler = options.handler\n verbose = options.verbose\n\n if not access_token:\n parser.error('missing access_token')\n if not env:\n parser.error('missing environment')\n\n rollbar.init(access_token, environment=env, endpoint=endpoint, handler=handler)\n\n def _do_cmd(cmd_name, line):\n cmd = CMDS.get(cmd_name.lower())\n if cmd:\n cmd([line])\n return True\n\n return False\n\n if len(args) > 1:\n sent = _do_cmd(args[0], ' '.join(args[1:]))\n sys.exit(0 if sent else 1)\n\n cur_cmd_name = None\n try:\n cur_line = sys.stdin.readline()\n while cur_line:\n cur_line = cur_line.strip()\n parts = cur_line.split(' ')\n\n if parts:\n cur_cmd_name = parts[0]\n parts = parts[1:]\n _do_cmd(cur_cmd_name, ' '.join(parts))\n\n cur_line = sys.stdin.readline()\n except (KeyboardInterrupt, SystemExit) as e:\n pass\n" }, { "path": "rollbar/contrib/__init__.py", "content": "" }, { "path": "rollbar/contrib/asgi/__init__.py", "content": "__all__ = ['ReporterMiddleware']\n\nfrom .middleware import ReporterMiddleware\n" }, { "path": "rollbar/contrib/asgi/integration.py", "content": "import inspect\nimport functools\n\nimport rollbar\n\n\nclass IntegrationBase:\n \"\"\"\n Superclass for class integrations.\n \"\"\"\n\n def __init__(self):\n if hasattr(self, '_integrate'):\n self._integrate()\n\n\nclass integrate:\n \"\"\"\n Integrates functions and classes (derived from IntegrationBase) in the SDK.\n \"\"\"\n\n def __init__(self, *, framework_name='unknown'):\n self._framework_name = framework_name\n\n def __call__(self, obj):\n if inspect.isclass(obj):\n obj._integrate = self._register_hook\n return obj\n else:\n return self._insert_hook(obj)\n\n def _register_hook(self):\n def _hook(request, data):\n data['framework'] = self._framework_name\n\n rollbar.BASE_DATA_HOOK = _hook\n\n def _insert_hook(self, func):\n @functools.wraps(func)\n def wrapper(*args, **kwargs):\n self._register_hook()\n return func(*args, **kwargs)\n\n return wrapper\n" }, { "path": "rollbar/contrib/asgi/middleware.py", "content": "import logging\nimport sys\nfrom typing import Iterable\n\nimport rollbar\nfrom .integration import IntegrationBase, integrate\nfrom .types import ASGIApp, Receive, Scope, Send\nfrom rollbar.lib._async import RollbarAsyncError, try_report\nfrom rollbar.lib.session import set_current_session, reset_current_session\n\nlog = logging.getLogger(__name__)\n\n\n@integrate(framework_name='asgi')\nclass ReporterMiddleware(IntegrationBase):\n def __init__(self, app: ASGIApp) -> None:\n super().__init__()\n\n self.app = app\n\n async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:\n if scope['type'] == 'http':\n set_current_session(self._format_headers(scope['headers']))\n try:\n await self.app(scope, receive, send)\n except Exception:\n if scope['type'] == 'http':\n exc_info = sys.exc_info()\n\n try:\n await try_report(exc_info)\n except RollbarAsyncError:\n log.warning(\n 'Failed to report asynchronously. Trying to report synchronously.'\n )\n rollbar.report_exc_info(exc_info)\n raise\n finally:\n if scope['type'] == 'http':\n reset_current_session()\n\n @staticmethod\n def _format_headers(headers: Iterable[tuple[bytes, bytes]]) -> dict[str, str]:\n \"\"\"\n Convert list of header tuples to a dictionary with string keys and values.\n\n Headers are expected to be in the format: [(b'header-name', b'header-value'), ...]\n \"\"\"\n return {key.decode('latin-1'): value.decode('latin-1') for key, value in headers}" }, { "path": "rollbar/contrib/asgi/types.py", "content": "# Copyright © 2018, [Encode OSS Ltd](https://www.encode.io/).\n# All rights reserved.\n#\n# Redistribution and use in source and binary forms, with or without\n# modification, are permitted provided that the following conditions are met:\n#\n# * Redistributions of source code must retain the above copyright notice, this\n# list of conditions and the following disclaimer.\n#\n# * Redistributions in binary form must reproduce the above copyright notice,\n# this list of conditions and the following disclaimer in the documentation\n# and/or other materials provided with the distribution.\n#\n# * Neither the name of the copyright holder nor the names of its\n# contributors may be used to endorse or promote products derived from\n# this software without specific prior written permission.\n#\n# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\nimport typing\n\nScope = typing.MutableMapping[str, typing.Any]\nMessage = typing.MutableMapping[str, typing.Any]\n\nReceive = typing.Callable[[], typing.Awaitable[Message]]\nSend = typing.Callable[[Message], typing.Awaitable[None]]\n\nASGIApp = typing.Callable[[Scope, Receive, Send], typing.Awaitable[None]]\n" }, { "path": "rollbar/contrib/bottle/__init__.py", "content": "import bottle, rollbar, sys\n\nclass RollbarBottleReporter(object):\n '''\n A Bottle plugin that reports errors to Rollbar\n All args and kwargs are passed to `rollbar.init`\n '''\n name = 'rollbar-bottle-reporter'\n api = 2\n\n def __init__(self, *args, **kwargs):\n if 'exception_level_filters' in kwargs:\n kwargs['exception_level_filters'].append((bottle.BaseResponse, 'ignored'))\n else:\n kwargs['exception_level_filters'] = [(bottle.BaseResponse, 'ignored')]\n\n rollbar.init(*args, **kwargs)\n\n def hook(request, data):\n data['framework'] = 'bottle'\n\n if request:\n route = request['bottle.route']\n data['context'] = route.name or route.rule\n\n rollbar.BASE_DATA_HOOK = hook\n\n def __call__(self, callback):\n def wrapper(*args, **kwargs):\n try:\n return callback(*args, **kwargs)\n except Exception as e:\n rollbar.report_exc_info(sys.exc_info(), request=bottle.request)\n raise\n\n return wrapper\n\n\n" }, { "path": "rollbar/contrib/django/__init__.py", "content": "" }, { "path": "rollbar/contrib/django/context_processors.py", "content": "\"\"\"\ndjango-rollbar context processor\n\nTo install, add the following in your settings.py:\n1. add 'rollbar.contrib.django.context_processors.rollbar_settings' to TEMPLATE_CONTEXT_PROCESSORS\n2. add a section like this:\nROLLBAR = {\n 'client_access_token': 'tokengoeshere',\n}\n3. you can now access your rollbar settings as rollbar_settings from within your django templates\n\nSee README.rst for full installation and configuration instructions.\n\"\"\"\n\nfrom django.conf import settings\n\n\ndef rollbar_settings(request):\n \"\"\"Grabs the rollbar settings to make them available to templates.\"\"\"\n if not hasattr(settings, 'ROLLBAR'):\n return {}\n return {'rollbar_settings': settings.ROLLBAR}\n" }, { "path": "rollbar/contrib/django/middleware.py", "content": "r\"\"\"\ndjango-rollbar middleware\n\nThere are two options for installing the Rollbar middleware. Both options\nrequire modifying your settings.py file.\n\nThe first option is to use\n'rollbar.contrib.django.middleware.RollbarNotifierMiddleware' which will\nreport all exceptions to Rollbar including 404s. This middlware should be\nplaced as the last item in your middleware list which is:\n * MIDDLEWARE_CLASSES in Django 1.9 and earlier\n * MIDDLEWARE in Django 1.10 and up\n\nThe other option is two use the two separate middlewares:\n * 'rollbar.contrib.django.middleware.RollbarNotifierMiddlewareExcluding404'\n * 'rollbar.contrib.django.middleware.RollbarNotifierMiddlewareOnly404'\nThe Excluding404 middleware should be placed as the last item in your middleware\nlist, and the Only404 middleware should be placed as the first item in your\nmiddleware list. This allows 404s to be processed by your other middlewares\nbefore sendind an item to Rollbar. Therefore if you handle the 404 differently\nin a way that returns a response early you won't end up with a Rollbar item.\n\nRegardless of which method you use, you also should add a section to settings.py\nlike this:\n\nROLLBAR = {\n 'access_token': 'tokengoeshere',\n}\n\nThis can be used for passing configuration options to Rollbar. Additionally,\nyou can use the key 'ignorable_404_urls' to set an iterable of regular expression\npatterns to use to determine whether a 404 exception should be ignored based\non the full url path for the request. For example,\n\nimport re\nROLLBAR = {\n 'access_token': 'YOUR_TOKEN',\n 'ignorable_404_urls': (\n re.compile(r'/index\\.php'),\n re.compile('/foobar'),\n ),\n}\n\nTo get more control of middleware and enrich it with custom data\nyou can subclass any of the middleware classes described above\nand optionally override the methods:\n def get_extra_data(self, request, exc):\n ''' May be defined. Must return a dict or None. Use it to put some custom extra data on rollbar event. '''\n return\n\n def get_payload_data(self, request, exc):\n ''' May be defined. Must return a dict or None. Use it to put some custom payload data on rollbar event. '''\n return\nYou would then insert your custom subclass into your middleware\nconfiguration in the same place as the base class as described above.\nFor example:\n\n1. create a 'middleware.py' file on your project (name is up to you)\n2. import the rollbar default middleware: 'from rollbar.contrib.django.middleware import RollbarNotifierMiddleware'\n3. create your own middleware like this:\nclass CustomRollbarNotifierMiddleware(RollbarNotifierMiddleware):\n def get_extra_data(self, request, exc):\n ''' May be defined. Must return a dict or None. Use it to put some custom extra data on rollbar event. '''\n return\n\n def get_payload_data(self, request, exc):\n ''' May be defined. Must return a dict or None. Use it to put some custom payload data on rollbar event. '''\n return\n\n4. add 'path.to.your.CustomRollbarNotifierMiddleware' in your settings.py to\n a. MIDDLEWARE_CLASSES in Django 1.9 and earlier\n b. MIDDLEWARE in Django 1.10 and up\n5. add a section like this in your settings.py:\nROLLBAR = {\n 'access_token': 'tokengoeshere',\n}\n\nSee README.rst for full installation and configuration instructions.\n\"\"\"\n\nimport logging\nimport sys\n\nimport rollbar\n\nfrom django.core.exceptions import MiddlewareNotUsed\nfrom django.conf import settings\nfrom django.http import Http404\n\nfrom rollbar import set_current_session\nfrom rollbar.lib.session import reset_current_session\n\ntry:\n from django.urls import resolve\nexcept ImportError:\n from django.core.urlresolvers import resolve\n\ntry:\n from django.utils.deprecation import MiddlewareMixin\nexcept ImportError:\n from rollbar.contrib.django.utils import MiddlewareMixin\n\nlog = logging.getLogger(__name__)\n\n\nDEFAULTS = {\n 'web_base': 'https://rollbar.com',\n 'enabled': True,\n 'patch_debugview': True,\n 'exception_level_filters': [\n (Http404, 'warning')\n ]\n}\n\n\ndef _patch_debugview(rollbar_web_base):\n try:\n from django.views import debug\n except ImportError:\n return\n\n if rollbar_web_base.endswith('/'):\n rollbar_web_base = rollbar_web_base[:-1]\n\n # modify the TECHNICAL_500_TEMPLATE\n new_data = \"\"\"\n{% if view_in_rollbar_url %}\n