Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/zerver/logging_handlers.py

17 lines
579 B
Python
Raw Normal View History

docs: Update links from codebase to point to ReadTheDocs.
2017-11-16 19:51:44 +01:00
# System documented in https://zulip.readthedocs.io/en/latest/subsystems/logging.html
errors: Compute deployment metadata on the right deployment. When I added this "Deployed code" feature to the error reporting, I apparently hadn't worked out enough of how this code works to realize that `notify_server_error` may be in a different process, at a different time and potentially even on a different machine from the actual error being reported. Given that architecture, all the data about the error must be computed in `AdminNotifyHandler`, before sending the report through the queue, or else it risks being wrong. The job of `notify_server_error` and friends is only to format the data and send it off. So, move the implementation of this feature in order to do that. (@showell added some "nocoverage" directives here for code that is hard to test (exceptions being thrown, deployment files not existing) and that was originally part of a file that didn't require 100% coverage)
2017-12-01 01:54:24 +01:00
import os
import subprocess
error_notify: Remove custom email error reporting handler. Restore the default django.utils.log.AdminEmailHandler when ERROR_REPORTING is enabled. Those with more sophisticated needs can turn it off and use Sentry or a Sentry-compatible system. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-06-10 01:01:05 +02:00
from typing import Optional
python: Sort imports with isort. Fixes #2665. Regenerated by tabbott with `lint --fix` after a rebase and change in parameters. Note from tabbott: In a few cases, this converts technical debt in the form of unsorted imports into different technical debt in the form of our largest files having very long, ugly import sequences at the start. I expect this change will increase pressure for us to split those files, which isn't a bad thing. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-11 00:54:34 +02:00
errors: Compute deployment metadata on the right deployment. When I added this "Deployed code" feature to the error reporting, I apparently hadn't worked out enough of how this code works to realize that `notify_server_error` may be in a different process, at a different time and potentially even on a different machine from the actual error being reported. Given that architecture, all the data about the error must be computed in `AdminNotifyHandler`, before sending the report through the queue, or else it risks being wrong. The job of `notify_server_error` and friends is only to format the data and send it off. So, move the implementation of this feature in order to do that. (@showell added some "nocoverage" directives here for code that is hard to test (exceptions being thrown, deployment files not existing) and that was originally part of a file that didn't require 100% coverage)
2017-12-01 01:54:24 +01:00
def try_git_describe() -> Optional[str]:
test_logging_handlers: Mock out `git describe` because can be slow. This cuts out about 11 calls to `git describe`. In a nice fast LXC container following our instructions for development on a Linux host, this might save "only" about 1.5s; in a dev environment on a Windows host, the savings have been clocked at 49s, presumably due to an extremely slow filesystem in the VM. The tests weren't doing much with this codepath as they were, and there isn't a lot of value to be gained by testing it anyway; it's totally non-critical and rarely changes. [Commit message rewritten by greg.]
2018-03-11 17:29:38 +01:00
try: # nocoverage
errors: Compute deployment metadata on the right deployment. When I added this "Deployed code" feature to the error reporting, I apparently hadn't worked out enough of how this code works to realize that `notify_server_error` may be in a different process, at a different time and potentially even on a different machine from the actual error being reported. Given that architecture, all the data about the error must be computed in `AdminNotifyHandler`, before sending the report through the queue, or else it risks being wrong. The job of `notify_server_error` and friends is only to format the data and send it off. So, move the implementation of this feature in order to do that. (@showell added some "nocoverage" directives here for code that is hard to test (exceptions being thrown, deployment files not existing) and that was originally part of a file that didn't require 100% coverage)
2017-12-01 01:54:24 +01:00
return subprocess.check_output(
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
["git", "describe", "--tags", "--match=[0-9]*", "--always", "--dirty", "--long"],
errors: Compute deployment metadata on the right deployment. When I added this "Deployed code" feature to the error reporting, I apparently hadn't worked out enough of how this code works to realize that `notify_server_error` may be in a different process, at a different time and potentially even on a different machine from the actual error being reported. Given that architecture, all the data about the error must be computed in `AdminNotifyHandler`, before sending the report through the queue, or else it risks being wrong. The job of `notify_server_error` and friends is only to format the data and send it off. So, move the implementation of this feature in order to do that. (@showell added some "nocoverage" directives here for code that is hard to test (exceptions being thrown, deployment files not existing) and that was originally part of a file that didn't require 100% coverage)
2017-12-01 01:54:24 +01:00
stderr=subprocess.PIPE,
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
cwd=os.path.join(os.path.dirname(__file__), ".."),
python: Replace universal_newlines with text. This is supported in Python ≥ 3.7. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-01-22 07:52:54 +01:00
text=True,
python: Use universal_newlines to get str from subprocess. We can replace ‘universal_newlines’ with ‘text’ when we bump our minimum Python version to 3.7. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-10-30 01:36:18 +01:00
).strip()
python: Catch specific exceptions from subprocess. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-10-09 03:32:00 +02:00
except (FileNotFoundError, subprocess.CalledProcessError): # nocoverage
errors: Compute deployment metadata on the right deployment. When I added this "Deployed code" feature to the error reporting, I apparently hadn't worked out enough of how this code works to realize that `notify_server_error` may be in a different process, at a different time and potentially even on a different machine from the actual error being reported. Given that architecture, all the data about the error must be computed in `AdminNotifyHandler`, before sending the report through the queue, or else it risks being wrong. The job of `notify_server_error` and friends is only to format the data and send it off. So, move the implementation of this feature in order to do that. (@showell added some "nocoverage" directives here for code that is hard to test (exceptions being thrown, deployment files not existing) and that was originally part of a file that didn't require 100% coverage)
2017-12-01 01:54:24 +01:00
return None