GoogleCloudPlatform / GoogleCloudPlatform/functions-framework-python

Improve developer experience for uncaught exceptions on GCP

Aperta
#296 1 commento 1 reazione 1 assegnatario Rivendicata da @janell-chen Vedi su GitHub
enhancement P2
Lingua principale
Python
Stelle
968
Fork
128
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

When a function executes and exits with an uncaught exceptions, the exception is logged as a regular plaintext Python traceback to stderr. The content is then captured into Cloud Logging as plaintext too, which makes it difficult to parse and analyze.

Consider the following dummy function:

```python
import functions_framework

@functions_framework.http
def test_crash(request):
raise ValueError("something doesn't work")
```

When calling this function, it (of course) crashes, and renders as follow:

![image](https://github.com/GoogleCloudPlatform/functions-framework-python/assets/65311/d995b32d-2773-437d-be74-2e2eff071a78)

This has several disadvantages:

* The error is spread over multiple line: it's not possible to point to a single log entry which contains the traceback, you always need to see here ~20 lines to get the full picture.
* The traceback only makes sense if Cloud Logging is sorted _from oldest to newest_ (I typically shows newest entries first, and the traceback is reversed :facepalm: )
* The error doesn't really show up in Error Reporting: only some of the exception, part of Flask, is caught into Error Reporting and it's really not useful:
![image](https://github.com/GoogleCloudPlatform/functions-framework-python/assets/65311/bfcf4070-e279-49c9-b26a-e204134cdd70)

Ideally, out of the box when running on GCP:

* The framework should log the error into a single `CRITICAL` log entry
* The error should be formatted to be reported automatically with the right content into Error Reporting

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.