feat(flask): add error tracking integration by hpouillot · Pull Request #1038 · PostHog/posthog-python

hpouillot · 2026-10-08T09:42:57Z

💡 Motivation and Context

Flask catches application exceptions before Python's global exception hooks can observe them, so users currently need to write explicit error handlers. This adds an idiomatic Flask extension that creates an isolated PostHog context for each request and captures unhandled exceptions through Flask's native signal without changing propagation or response behavior.

The integration keeps Flask optional, supports both direct and application-factory initialization, accepts a custom client, request filter, and extra properties, and records only bounded request metadata. Query strings, bodies, cookies, authorization, and arbitrary headers are not captured.

The integration uses the standardized internal exception metadata channel now available on main. The canonical exception-event-metadata spec was reviewed: the Flask signal is represented as source flask.got_request_exception, mechanism type middleware, handled false, and level error.

💚 How did you test it?

uv run --extra test pytest -q --timeout=30 posthog/test/integrations/test_flask_integration.py — 8 passed (post-rebase)
uv run ruff format --check posthog/integrations/flask.py posthog/test/integrations/test_flask_integration.py
uv run ruff check .
uv run mypy --no-site-packages --config-file mypy.ini posthog/integrations/flask.py posthog/test/integrations/test_flask_integration.py | uv run mypy-baseline filter
uv run python -W error -c "import posthog; import posthog.integrations.flask"
uv run make public_api_check

📝 Checklist

I reviewed the submitted code.
I added tests to verify the changes.
I updated the docs if needed.
No breaking change or entry added to the changelog.

If releasing new changes

Ran sampo add to generate a changeset file

🤖 Agent context

Autonomy: Human-driven (agent-assisted)

Implemented with the Pi coding agent in Cockpit session 3e09dc13-06ad-42b6-b06a-3d0b39778a60. The integration uses Flask's got_request_exception signal instead of replacing application error handlers, and disables context-manager exception capture so each unhandled exception is reported once. Canonical source, mechanism type, handled state, and level are asserted directly in tests. Flask is included only in the test extra and imported lazily at runtime.

github-actions · 2026-10-08T09:45:56Z

posthog-python Compliance Report

Date: 2026-10-08T14:25:13.577450+00:00
Duration: 259384ms

✅ All Tests Passed!

121/121 tests passed

Capture_V1 Tests

✅ 95/95 tests passed

View Details

Test	Status	Duration
Endpoint And Method.Targets V1 Endpoint	✅	515ms
Endpoint And Method.Does Not Use Legacy Endpoints	✅	508ms
Required Headers.Has Authorization Bearer Header	✅	509ms
Required Headers.Has Content Type Json	✅	510ms
Required Headers.Has Posthog Sdk Info Format	✅	508ms
Required Headers.Has Posthog Attempt Header	✅	509ms
Required Headers.Has Posthog Request Id	✅	508ms
Required Headers.Has Posthog Request Timestamp	✅	508ms
Required Headers.Has User Agent	✅	509ms
Body Format.Body Has Created At And Batch	✅	508ms
Body Format.No Api Key In Body	✅	509ms
Body Format.No Sent At In Body	✅	509ms
Event Format.Event Has Required Root Fields	✅	508ms
Event Format.Event Uuid Is Valid	✅	508ms
Event Format.Event Timestamp Is Rfc3339	✅	508ms
Event Format.Non Utc Event Timestamp Is Converted To Utc	✅	514ms
Event Format.Distinct Id Is String	✅	508ms
Event Format.Distinct Id At Root Not Properties	✅	509ms
Event Format.Custom Properties Preserved	✅	508ms
Event Format.Set Properties Preserved	✅	508ms
Event Format.Set Once Properties Preserved	✅	509ms
Event Format.Groups Properties Preserved	✅	508ms
Event Format.Sdk Generates Uuid If Not Provided	✅	508ms
Event Format.Event Has Required Root Fields Batch	✅	511ms
Event Format.Event Uuid Is Valid Batch	✅	512ms
Event Format.Event Timestamp Is Rfc3339 Batch	✅	510ms
Event Format.Distinct Id Is String Batch	✅	510ms
Event Format.Distinct Id At Root Not Properties Batch	✅	512ms
Event Format.Custom Properties Preserved Batch	✅	511ms
Event Format.Set Properties Preserved Batch	✅	510ms
Event Format.Set Once Properties Preserved Batch	✅	511ms
Event Format.Groups Properties Preserved Batch	✅	511ms
Event Format.Sdk Generates Uuid If Not Provided Batch	✅	510ms
Batch Behavior.Multiple Events In Single Batch	✅	514ms
Batch Behavior.Batch Envelope Smoke	✅	512ms
Batch Behavior.Flush With No Events Sends Nothing	✅	506ms
Batch Behavior.Flush At Triggers Batch	✅	1008ms
Batch Behavior.Created At Reflects Batch Creation Time	✅	509ms
Deduplication.Generates Unique Uuids	✅	514ms
Deduplication.Different Events Same Content Different Uuids	✅	510ms
Deduplication.Preserves Uuid On Retry	✅	6512ms
Deduplication.Preserves Timestamp On Retry	✅	6514ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry	✅	6517ms
Deduplication.No Duplicate Events In Batch	✅	514ms
Header Behavior On Retry.Attempt Header Starts At One	✅	509ms
Header Behavior On Retry.Attempt Header Increments On Retry	✅	13525ms
Header Behavior On Retry.Request Id Preserved On Retry	✅	6513ms
Header Behavior On Retry.Different Requests Have Different Request Ids	✅	3016ms
Header Behavior On Retry.Request Timestamp Changes On Retry	✅	6518ms
Response Format Validation.Success Response Has Uuid Keyed Results	✅	508ms
Response Format Validation.Success Response Has Ok For Each Event	✅	512ms
Response Format Validation.Success No Retry After When All Ok	✅	510ms
Response Format Validation.Success Retry After Present When Retry Events	✅	1513ms
Response Format Validation.Success No Retry After When Drop Only	✅	510ms
Response Format Validation.Response Echoes Request Id	✅	509ms
Retry Behavior.Retries On 408	✅	6517ms
Retry Behavior.Retries On 500	✅	6514ms
Retry Behavior.Retries On 503	✅	8516ms
Retry Behavior.Retries On 504	✅	6514ms
Retry Behavior.Retryable Errors Have Retry After	✅	3514ms
Retry Behavior.Respects Retry After On Retryable Error	✅	11521ms
Retry Behavior.Does Not Retry On 400	✅	2511ms
Retry Behavior.Does Not Retry On 401	✅	2511ms
Retry Behavior.Does Not Retry On 402	✅	2511ms
Retry Behavior.Does Not Retry On 413	✅	2512ms
Retry Behavior.Does Not Retry On 415	✅	2512ms
Retry Behavior.Non Retryable Errors Have No Retry After	✅	2511ms
Retry Behavior.Implements Backoff	✅	22522ms
Retry Behavior.Max Retries Respected	✅	22532ms
Partial Batch Handling.Handles 200 Full Success	✅	2510ms
Partial Batch Handling.Handles 200 With All Ok	✅	3516ms
Partial Batch Handling.Does Not Retry Dropped Events	✅	3511ms
Partial Batch Handling.Does Not Retry Limited Events	✅	3513ms
Partial Batch Handling.Prunes Ok Events On Partial Retry	✅	6515ms
Partial Batch Handling.Prunes Dropped Events On Partial Retry	✅	6515ms
Partial Batch Handling.Retries Only Retry Events From Partial	✅	6516ms
Partial Batch Handling.Partial Retry Preserves Uuids	✅	6518ms
Partial Batch Handling.Partial Retry Attempt Header Increments	✅	6514ms
Partial Batch Handling.Partial Retry Request Id Preserved	✅	6519ms
Partial Batch Handling.Respects Retry After On Partial	✅	8515ms
Partial Batch Handling.Unknown Result Treated As Terminal	✅	3515ms
Partial Batch Handling.Mixed Ok Drop Limited No Retry	✅	3514ms
Compression.Sends Gzip Content Encoding	✅	509ms
Compression.No Content Encoding When Disabled	✅	508ms
Compression.Compressed Body Is Decompressible	✅	508ms
Error Handling.Does Not Retry On Unknown 4Xx	✅	2510ms
Event Options.Cookieless Mode Override	✅	509ms
Event Options.Disable Skew Correction Override	✅	508ms
Event Options.Process Person Profile Override	✅	509ms
Event Options.Product Tour Id Override	✅	508ms
Event Options.Unset Options Omitted	✅	508ms
Event Options.Options Override In Batch	✅	511ms
Geoip And Historical Migration.Geoip Disable Injected Into Properties	✅	508ms
Geoip And Historical Migration.Historical Migration Set In Body	✅	509ms
Geoip And Historical Migration.Historical Migration Absent By Default	✅	508ms

Capture_Ai Tests

✅ 5/5 tests passed

View Details

Test	Status	Duration
Routing.Capture Ai Posts To Ai Endpoint	✅	508ms
Routing.Capture Does Not Reroute Ai Named Events	✅	509ms
Identity.Capture Ai Event Has Uuid	✅	509ms
Identity.Capture Ai Keeps Supplied Uuid	✅	507ms
Timestamp Format.Non Utc Event Timestamp Is Converted To Utc	✅	509ms

Feature_Flags Tests

✅ 17/17 tests passed

View Details

Test	Status	Duration
Request Payload.Request With Person Properties Device Id	✅	9ms
Request Payload.Flags Request Uses V2 Query Param	✅	7ms
Request Payload.Flags Request Hits Flags Path Not Decide	✅	7ms
Request Payload.Flags Request Omits Authorization Header	✅	7ms
Request Payload.Token In Flags Body Matches Init	✅	7ms
Request Payload.Groups Round Trip	✅	8ms
Request Payload.Groups Default To Empty Object	✅	7ms
Request Payload.Disable Geoip False Propagates As Geoip Disable False	✅	7ms
Request Payload.Disable Geoip Omitted Defaults To False	✅	7ms
Request Payload.Flag Keys To Evaluate Contains Only Requested Key	✅	7ms
Request Lifecycle.No Flags Request On Init Alone	✅	3ms
Request Lifecycle.No Flags Request On Normal Capture	✅	508ms
Request Lifecycle.Two Flag Calls Produce Two Remote Requests	✅	11ms
Request Lifecycle.Mock Response Value Is Returned To Caller	✅	7ms
Retry Behavior.Retries Flags On 502	✅	311ms
Retry Behavior.Retries Flags On 504	✅	312ms
Side Effect Events.Get Feature Flag Captures Feature Flag Called Event	✅	509ms

Feature_Flags_Local_Evaluation Tests

✅ 4/4 tests passed

View Details

Test	Status	Duration
Versioned Boolean Matching.Matching Version Missing	✅	55ms
Versioned Boolean Matching.Matching Version 1	✅	52ms
Versioned Boolean Matching.Matching Version 2	✅	51ms
Versioned Boolean Matching.Version Only Reload 1 2 1 2 Missing	✅	29ms

veria-ai · 2026-10-08T10:42:55Z

PR overview

All previously flagged issues have been addressed. No open security concerns remain on this pull request.

Security review

No open security issues remain on this pull request.

Fixed/addressed: 1 · PR risk: 0/10

* feat(flask): add error tracking integration * fix(flask): use canonical exception metadata * chore(flask): type exception capture metadata * refactor(flask): expose request properties terminology * fix(flask): preserve exception privacy settings (cherry picked from commit 292855d)

hpouillot requested a review from a team as a code owner October 8, 2026 09:42

hpouillot self-assigned this Oct 8, 2026

hpouillot force-pushed the cockpit-3e09dc1306ad42b6b06a3d0b39778a60 branch from 88e4ef9 to 0de9930 Compare October 8, 2026 10:22

Base automatically changed from hp/exception-event-metadata to main October 8, 2026 10:28

hpouillot added 3 commits October 8, 2026 12:31

feat(flask): add error tracking integration

c1c709f

fix(flask): use canonical exception metadata

51d7fb5

chore(flask): type exception capture metadata

1c4a8c9

hpouillot force-pushed the cockpit-3e09dc1306ad42b6b06a3d0b39778a60 branch from 0de9930 to 1c4a8c9 Compare October 8, 2026 10:31

hpouillot requested review from a team and ablaszkiewicz October 8, 2026 10:31

refactor(flask): expose request properties terminology

82e40ea

veria-ai Bot reviewed Oct 8, 2026

View reviewed changes

Comment thread posthog/integrations/flask.py

ablaszkiewicz approved these changes Oct 8, 2026

View reviewed changes

fix(flask): preserve exception privacy settings

807f85b

hpouillot requested a review from a team October 8, 2026 14:20

hpouillot merged commit 292855d into main Oct 8, 2026
44 checks passed

hpouillot deleted the cockpit-3e09dc1306ad42b6b06a3d0b39778a60 branch October 8, 2026 14:29

hpouillot mentioned this pull request Oct 8, 2026

feat(integrations): align request middleware configuration #1040

Open

3 of 5 tasks

eli-r-ph mentioned this pull request Oct 9, 2026

chore: sync main into v1 (7.65.0–7.67.0) #1044

Open

3 of 5 tasks

Navigation Menu

Repository navigation

feat(flask): add error tracking integration - #1038

feat(flask): add error tracking integration#1038
hpouillot merged 5 commits into
mainfrom
cockpit-3e09dc1306ad42b6b06a3d0b39778a60

hpouillot commented Oct 8, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 8, 2026 •

edited

Loading

Uh oh!

Uh oh!

veria-ai Bot commented Oct 8, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

hpouillot commented Oct 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

If releasing new changes

🤖 Agent context

Uh oh!

github-actions Bot commented Oct 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

posthog-python Compliance Report

✅ All Tests Passed!

Capture_V1 Tests

Capture_Ai Tests

Feature_Flags Tests

Feature_Flags_Local_Evaluation Tests

Uh oh!

Uh oh!

veria-ai Bot commented Oct 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR overview

Security review

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hpouillot commented Oct 8, 2026 •

edited

Loading

github-actions Bot commented Oct 8, 2026 •

edited

Loading

veria-ai Bot commented Oct 8, 2026 •

edited

Loading