Skip to content

feat: send $release_id from POSTHOG_RELEASE_ID on every event - #975

Merged
ablaszkiewicz merged 1 commit into
mainfrom
ab/feat/release-id-env
Sep 22, 2026
Merged

ablaszkiewicz merged 1 commit into
mainfrom
ab/feat/release-id-env

Conversation

@ablaszkiewicz

@ablaszkiewicz ablaszkiewicz commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

💡 Motivation and Context

A Python app cannot link its error tracking issues to a release. posthog-cli injects the release id into JavaScript bundles, and Python has no bundle.

  • The SDK now reads POSTHOG_RELEASE_ID (the id that posthog-cli release resolve prints) and sends it as $release_id on every event.
  • On $exception events the server resolves the release by a direct id lookup.
  • Both clients read the variable once at init. The value is trimmed, and a blank value counts as unset.
  • An explicit $release_id in event properties or in super_properties wins over the env var.
  • Minimal $feature_flag_called events keep their cross-SDK property allowlist, so they do not carry the id.

💚 How did you test it?

  • 25 new tests in posthog/test/test_release_id.py. The full suite passes (3467 passed, 16 skipped), as do ruff, mypy, and the public API check.
  • End to end against a local PostHog stack: a wheel built from this branch, a release from a locally built posthog-cli release resolve, one handled exception, and one plain event. Both events carried $release_id, and the server resolved python-release-env@1.0.0 from it. Not tested against production.

The issue page resolves the release that the CLI created:

python-release-issue

The event JSON shows the $release_id that the SDK sent and the $exception_release that the server resolved from it (same id):

python-release-json

📝 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)

Written with Claude Code (Claude Fable 5.1), directed by the PR assignee.

  • The env var was chosen over a CLI-written file (fragile file discovery) and over git or version auto-detection (that gives a version, not a release id).
  • The first iteration sent the id on $exception events only. The assignee then asked for all events.
  • The changeset file was written by hand in the .sampo/changesets format, not with the sampo add command.

🤖 Generated with Claude Code

A Python app has no bundle to inject a release id into, so the SDK reads
the id that `posthog-cli release resolve` prints from the
POSTHOG_RELEASE_ID env var and sends it as `$release_id` on every event.
On `$exception` events the server resolves the release by a direct id
lookup.

An explicit `$release_id` in the event properties or super_properties
wins over the env var. Minimal `$feature_flag_called` events keep their
strict cross-SDK property allowlist and do not carry the id.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@ablaszkiewicz ablaszkiewicz self-assigned this Sep 21, 2026
@github-actions

github-actions Bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

posthog-python Compliance Report

Date: 2026-09-21 13:27:59 UTC
Duration: 256074ms

✅ 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 509ms
Required Headers.Has Authorization Bearer Header 508ms
Required Headers.Has Content Type Json 510ms
Required Headers.Has Posthog Sdk Info Format 509ms
Required Headers.Has Posthog Attempt Header 508ms
Required Headers.Has Posthog Request Id 509ms
Required Headers.Has Posthog Request Timestamp 508ms
Required Headers.Has User Agent 509ms
Body Format.Body Has Created At And Batch 509ms
Body Format.No Api Key In Body 508ms
Body Format.No Sent At In Body 508ms
Event Format.Event Has Required Root Fields 508ms
Event Format.Event Uuid Is Valid 509ms
Event Format.Event Timestamp Is Rfc3339 508ms
Event Format.Distinct Id Is String 509ms
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 509ms
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 511ms
Event Format.Event Timestamp Is Rfc3339 Batch 511ms
Event Format.Distinct Id Is String Batch 511ms
Event Format.Distinct Id At Root Not Properties Batch 511ms
Event Format.Custom Properties Preserved Batch 512ms
Event Format.Set Properties Preserved Batch 513ms
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 515ms
Batch Behavior.Batch Envelope Smoke 512ms
Batch Behavior.Flush With No Events Sends Nothing 506ms
Batch Behavior.Flush At Triggers Batch 1009ms
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 6517ms
Deduplication.Preserves Timestamp On Retry 6518ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry 6520ms
Deduplication.No Duplicate Events In Batch 515ms
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 6517ms
Header Behavior On Retry.Different Requests Have Different Request Ids 3018ms
Header Behavior On Retry.Request Timestamp Changes On Retry 6513ms
Response Format Validation.Success Response Has Uuid Keyed Results 509ms
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 511ms
Response Format Validation.Response Echoes Request Id 508ms
Retry Behavior.Retries On 408 6517ms
Retry Behavior.Retries On 500 6514ms
Retry Behavior.Retries On 503 8517ms
Retry Behavior.Retries On 504 6517ms
Retry Behavior.Retryable Errors Have Retry After 3514ms
Retry Behavior.Respects Retry After On Retryable Error 11520ms
Retry Behavior.Does Not Retry On 400 2512ms
Retry Behavior.Does Not Retry On 401 2512ms
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 2512ms
Retry Behavior.Implements Backoff 22532ms
Retry Behavior.Max Retries Respected 22525ms
Partial Batch Handling.Handles 200 Full Success 2511ms
Partial Batch Handling.Handles 200 With All Ok 3515ms
Partial Batch Handling.Does Not Retry Dropped Events 3512ms
Partial Batch Handling.Does Not Retry Limited Events 3511ms
Partial Batch Handling.Prunes Ok Events On Partial Retry 6517ms
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 6519ms
Partial Batch Handling.Partial Retry Attempt Header Increments 6514ms
Partial Batch Handling.Partial Retry Request Id Preserved 6515ms
Partial Batch Handling.Respects Retry After On Partial 8518ms
Partial Batch Handling.Unknown Result Treated As Terminal 3514ms
Partial Batch Handling.Mixed Ok Drop Limited No Retry 3516ms
Compression.Sends Gzip Content Encoding 509ms
Compression.No Content Encoding When Disabled 509ms
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 509ms
Event Options.Process Person Profile Override 508ms
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

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 8ms
Request Payload.Flags Request Omits Authorization Header 7ms
Request Payload.Token In Flags Body Matches Init 7ms
Request Payload.Groups Round Trip 7ms
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 311ms
Side Effect Events.Get Feature Flag Captures Feature Flag Called Event 509ms

@greptile-apps

greptile-apps Bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Retrigger

The PR appears safe to merge with the intended release-ID behavior consistently implemented across synchronous and asynchronous clients.

Reviews (1) · Last reviewed commit: "feat: send $release_id from POSTHOG_RELE..."

@posthog

posthog Bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

🦔 PostHog Review reviewed this pull request

Nothing worth raising this time, so here's a calming picture instead:

A happy dog on a sunny path

@ablaszkiewicz
ablaszkiewicz marked this pull request as ready for review September 22, 2026 09:06
@ablaszkiewicz
ablaszkiewicz requested a review from a team as a code owner September 22, 2026 09:06
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.

2 participants