Skip to content

feat(error-tracking): standardize exception event metadata - #898

Open
hpouillot wants to merge 3 commits into
mainfrom
hp/exception-event-metadata
Open

feat(error-tracking): standardize exception event metadata#898
hpouillot wants to merge 3 commits into
mainfrom
hp/exception-event-metadata

Conversation

@hpouillot

Copy link
Copy Markdown
Contributor

💡 Motivation and Context

Standardize Python exception events with the cross-SDK metadata contract so severity, capture source, mechanism semantics, nested linkage, and reserved property ownership are predictable.

Canonical contract: https://github.com/PostHog/sdk-specs/blob/main/openspec/specs/exception-event-metadata/spec.md

💚 How did you test it?

  • Focused exception capture, Django, and Celery tests: 78 passed
  • Ruff format and lint checks
  • Focused mypy checks
  • Public API snapshot 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 pi from the shared OpenSpec contract. Integration-only capture metadata is kept out of the public API while manual and automatic capture paths preserve their existing behavior.

@hpouillot hpouillot self-assigned this Aug 26, 2026
@github-actions

github-actions Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

posthog-python Compliance Report

Date: 2026-08-26 10:13:13 UTC
Duration: 256343ms

✅ All Tests Passed!

111/111 tests passed


Capture_V1 Tests

94/94 tests passed

View Details
Test Status Duration
Endpoint And Method.Targets V1 Endpoint 515ms
Endpoint And Method.Does Not Use Legacy Endpoints 510ms
Required Headers.Has Authorization Bearer Header 510ms
Required Headers.Has Content Type Json 510ms
Required Headers.Has Posthog Sdk Info Format 511ms
Required Headers.Has Posthog Attempt Header 510ms
Required Headers.Has Posthog Request Id 511ms
Required Headers.Has Posthog Request Timestamp 510ms
Required Headers.Has User Agent 510ms
Body Format.Body Has Created At And Batch 510ms
Body Format.No Api Key In Body 510ms
Body Format.No Sent At In Body 510ms
Event Format.Event Has Required Root Fields 510ms
Event Format.Event Uuid Is Valid 511ms
Event Format.Event Timestamp Is Rfc3339 513ms
Event Format.Distinct Id Is String 510ms
Event Format.Distinct Id At Root Not Properties 510ms
Event Format.Custom Properties Preserved 511ms
Event Format.Set Properties Preserved 511ms
Event Format.Set Once Properties Preserved 511ms
Event Format.Groups Properties Preserved 511ms
Event Format.Sdk Generates Uuid If Not Provided 511ms
Event Format.Event Has Required Root Fields Batch 514ms
Event Format.Event Uuid Is Valid Batch 516ms
Event Format.Event Timestamp Is Rfc3339 Batch 514ms
Event Format.Distinct Id Is String Batch 514ms
Event Format.Distinct Id At Root Not Properties Batch 513ms
Event Format.Custom Properties Preserved Batch 514ms
Event Format.Set Properties Preserved Batch 513ms
Event Format.Set Once Properties Preserved Batch 514ms
Event Format.Groups Properties Preserved Batch 515ms
Event Format.Sdk Generates Uuid If Not Provided Batch 514ms
Batch Behavior.Multiple Events In Single Batch 518ms
Batch Behavior.Batch Envelope Smoke 515ms
Batch Behavior.Flush With No Events Sends Nothing 507ms
Batch Behavior.Flush At Triggers Batch 1012ms
Batch Behavior.Created At Reflects Batch Creation Time 510ms
Deduplication.Generates Unique Uuids 518ms
Deduplication.Different Events Same Content Different Uuids 513ms
Deduplication.Preserves Uuid On Retry 6520ms
Deduplication.Preserves Timestamp On Retry 6521ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry 6521ms
Deduplication.No Duplicate Events In Batch 519ms
Header Behavior On Retry.Attempt Header Starts At One 510ms
Header Behavior On Retry.Attempt Header Increments On Retry 13522ms
Header Behavior On Retry.Request Id Preserved On Retry 6520ms
Header Behavior On Retry.Different Requests Have Different Request Ids 3021ms
Header Behavior On Retry.Request Timestamp Changes On Retry 6521ms
Response Format Validation.Success Response Has Uuid Keyed Results 511ms
Response Format Validation.Success Response Has Ok For Each Event 516ms
Response Format Validation.Success No Retry After When All Ok 514ms
Response Format Validation.Success Retry After Present When Retry Events 1517ms
Response Format Validation.Success No Retry After When Drop Only 513ms
Response Format Validation.Response Echoes Request Id 512ms
Retry Behavior.Retries On 408 6515ms
Retry Behavior.Retries On 500 6522ms
Retry Behavior.Retries On 503 8524ms
Retry Behavior.Retries On 504 6521ms
Retry Behavior.Retryable Errors Have Retry After 3517ms
Retry Behavior.Respects Retry After On Retryable Error 11525ms
Retry Behavior.Does Not Retry On 400 2514ms
Retry Behavior.Does Not Retry On 401 2514ms
Retry Behavior.Does Not Retry On 402 2514ms
Retry Behavior.Does Not Retry On 413 2514ms
Retry Behavior.Does Not Retry On 415 2515ms
Retry Behavior.Non Retryable Errors Have No Retry After 2515ms
Retry Behavior.Implements Backoff 22538ms
Retry Behavior.Max Retries Respected 22539ms
Partial Batch Handling.Handles 200 Full Success 2513ms
Partial Batch Handling.Handles 200 With All Ok 3518ms
Partial Batch Handling.Does Not Retry Dropped Events 3517ms
Partial Batch Handling.Does Not Retry Limited Events 3514ms
Partial Batch Handling.Prunes Ok Events On Partial Retry 6519ms
Partial Batch Handling.Prunes Dropped Events On Partial Retry 6522ms
Partial Batch Handling.Retries Only Retry Events From Partial 6524ms
Partial Batch Handling.Partial Retry Preserves Uuids 6519ms
Partial Batch Handling.Partial Retry Attempt Header Increments 6524ms
Partial Batch Handling.Partial Retry Request Id Preserved 6523ms
Partial Batch Handling.Respects Retry After On Partial 8518ms
Partial Batch Handling.Unknown Result Treated As Terminal 3518ms
Partial Batch Handling.Mixed Ok Drop Limited No Retry 3520ms
Compression.Sends Gzip Content Encoding 511ms
Compression.No Content Encoding When Disabled 511ms
Compression.Compressed Body Is Decompressible 511ms
Error Handling.Does Not Retry On Unknown 4Xx 2512ms
Event Options.Cookieless Mode Override 512ms
Event Options.Disable Skew Correction Override 511ms
Event Options.Process Person Profile Override 510ms
Event Options.Product Tour Id Override 510ms
Event Options.Unset Options Omitted 512ms
Event Options.Options Override In Batch 514ms
Geoip And Historical Migration.Geoip Disable Injected Into Properties 510ms
Geoip And Historical Migration.Historical Migration Set In Body 510ms
Geoip And Historical Migration.Historical Migration Absent By Default 511ms

Feature_Flags Tests

17/17 tests passed

View Details
Test Status Duration
Request Payload.Request With Person Properties Device Id 11ms
Request Payload.Flags Request Uses V2 Query Param 9ms
Request Payload.Flags Request Hits Flags Path Not Decide 7ms
Request Payload.Flags Request Omits Authorization Header 8ms
Request Payload.Token In Flags Body Matches Init 7ms
Request Payload.Groups Round Trip 8ms
Request Payload.Groups Default To Empty Object 8ms
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 15ms
Request Lifecycle.Mock Response Value Is Returned To Caller 9ms
Retry Behavior.Retries Flags On 502 312ms
Retry Behavior.Retries Flags On 504 314ms
Side Effect Events.Get Feature Flag Captures Feature Flag Called Event 512ms

@hpouillot
hpouillot requested review from a team, ablaszkiewicz and cat-ph August 26, 2026 09:21
@hpouillot
hpouillot marked this pull request as ready for review August 26, 2026 09:21
@hpouillot
hpouillot requested a review from a team as a code owner August 26, 2026 09:21
@greptile-apps

greptile-apps Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor
Prompt To Fix All With AI
### Issue 1
posthog/exception_utils.py:696-698
**Repeated members are omitted**

When an exception object occupies multiple valid positions in an `ExceptionGroup` tree, the shared `seen_exception_ids` set discards every occurrence after the first, causing `$exception_list` to omit members and report incomplete group structure.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "fix(error-tracking): preserve explicit t..." | Re-trigger Greptile

Comment on lines +696 to +698
if id(exc_value) in seen_exception_ids or exception_id >= 50:
return (exception_id, [])
seen_exception_ids.add(id(exc_value))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Repeated members are omitted

When an exception object occupies multiple valid positions in an ExceptionGroup tree, the shared seen_exception_ids set discards every occurrence after the first, causing $exception_list to omit members and report incomplete group structure.

Knowledge Base Used: Event payload processing

Prompt To Fix With AI
This is a comment left during a code review.
Path: posthog/exception_utils.py
Line: 696-698

Comment:
**Repeated members are omitted**

When an exception object occupies multiple valid positions in an `ExceptionGroup` tree, the shared `seen_exception_ids` set discards every occurrence after the first, causing `$exception_list` to omit members and report incomplete group structure.

**Knowledge Base Used:** [Event payload processing](https://app.greptile.com/posthog-org-19734/-/custom-context/knowledge-base/posthog/posthog-python/-/docs/event-payload-processing.md)

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is intentional for the canonical exception graph contract: the same exception object must not be serialized more than once, including when it is referenced by multiple ExceptionGroup positions. The shared identity set also provides cycle safety. I added a regression test covering a repeated group member in 0fbbfc4.

Comment thread posthog/client.py

@marandaneto marandaneto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated advisory code review.


is_exception_group = BaseExceptionGroup is not None and isinstance(
exc_value, BaseExceptionGroup
(_, exceptions) = _exceptions_from_error(

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

blocking: Restrict group traversal to actual exception groups — Routing every exception through _exceptions_from_error now exposes ordinary exceptions to its hasattr(exc_value, "exceptions") group heuristic. A custom exception with an unrelated non-iterable exceptions attribute raises TypeError, which Client.capture_exception swallows and consequently drops the event; an iterable value instead creates phantom child exceptions. Previously, non-BaseExceptionGroup exceptions used walk_exception_chain and avoided this branch, so group-member traversal must remain restricted to actual BaseExceptionGroup instances.

@marandaneto

Copy link
Copy Markdown
Member

This change introduces backwards-incompatible public schema/API/contract changes: Reserved exception properties supplied through capture_exception(..., properties=...) can no longer override SDK-generated or processor-owned values.

If thats intentional, thats ok, but i think its not as designed, user provided props should always win

@marandaneto
marandaneto requested a review from a team August 26, 2026 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants