vybekiit 0.7.34 → 0.7.35

package/dist/global-skills/instrument-product-analytics/references/elixir.md

@@ -2,6 +2,21 @@
 
 # Elixir
 
+Canonical URL: https://posthog.com/docs/libraries/elixir
+
+> **Cloud region:** This page uses US Cloud hosts. For an EU Cloud project, use `https://eu.i.posthog.com` instead of `https://us.i.posthog.com` (ingestion host).
+
+## On this page
+
+- [Installation](#installation)
+- [Identifying users](#identifying-users)
+- [Capturing events](#capturing-events)
+- [Request context](#request-context)
+- [Feature flags](#feature-flags)
+- [Error tracking](#error-tracking)
+- [Advanced configuration](#advanced-configuration)
+- [Thanks](#thanks)
+
 This library provides an Elixir HTTP client for PostHog. [See the repository](https://github.com/posthog/posthog-elixir) for more information.
 
 ## Installation
@@ -10,8 +25,6 @@ This library provides an Elixir HTTP client for PostHog. [See the repository](ht
 
 The package can be installed by adding `posthog` to your list of dependencies in `mix.exs`:
 
-Elixir
-
 ```elixir
 def deps do
   [
@@ -42,16 +55,14 @@ For a test environment, you can pass in `test_mode: true` value to the config. T
 
 ## Identifying users
 
-> **Identifying users is required.** Backend events need a `distinct_id` that matches the ID your frontend uses when calling `posthog.identify()`. Without this, backend events are orphaned — they can't be linked to frontend event captures, [session replays](/docs/session-replay.md), [LLM traces](/docs/ai-engineering.md), or [error tracking](/docs/error-tracking.md).
+> **Identifying users is required.** Backend events need a `distinct_id` that matches the ID your frontend uses when calling `posthog.identify()`. Without this, backend events are orphaned — they can't be linked to frontend event captures, [session replays](https://posthog.com/docs/session-replay.md), [LLM traces](https://posthog.com/docs/ai-engineering.md), or [error tracking](https://posthog.com/docs/error-tracking.md).
 >
-> See our guide on [identifying users](/docs/getting-started/identify-users.md) for how to set this up.
+> See our guide on [identifying users](https://posthog.com/docs/getting-started/identify-users.md) for how to set this up.
 
 ## Capturing events
 
 To capture an event, use `PostHog.capture/2`:
 
-Elixir
-
 ```elixir
 PostHog.capture("user_signed_up", %{distinct_id: "distinct_id_of_the_user"})
 ```
@@ -60,9 +71,7 @@ PostHog.capture("user_signed_up", %{distinct_id: "distinct_id_of_the_user"})
 
 ### Setting event properties
 
-Optionally, you can include additional information with the event by including a [properties](/docs/data/events.md#event-properties) object:
-
-Elixir
+Optionally, you can include additional information with the event by including a [properties](https://posthog.com/docs/data/events.md#event-properties) object:
 
 ```elixir
 PostHog.capture("user_signed_up", %{
@@ -78,8 +87,6 @@ Carrying `distinct_id` around all the time might not be the most convenient appr
 
 The context is stored in the `Logger` metadata and PostHog automatically attaches these properties to any events you capture with `PostHog.capture/2`, as long as they happen in the same process.
 
-Elixir
-
 ```elixir
 PostHog.set_context(%{distinct_id: "distinct_id_of_the_user"})
 PostHog.capture("page_opened")
@@ -87,8 +94,6 @@ PostHog.capture("page_opened")
 
 You can also scope the context to a specific event name:
 
-Elixir
-
 ```elixir
 PostHog.set_event_context("sensitive_event", %{"$process_person_profile": false})
 ```
@@ -107,16 +112,12 @@ For example:
 
 #### Create alias
 
-Elixir
-
 ```elixir
 PostHog.capture("$create_alias", %{distinct_id: "frontend_id", alias: "backend_id"})
 ```
 
 #### Group analytics
 
-Elixir
-
 ```elixir
 PostHog.capture("$groupidentify", %{
   distinct_id: "static_string_used_for_all_group_events",
@@ -138,8 +139,6 @@ plug MyAppWeb.Router
 
 For plain Plug routers, add it before `:match` and `:dispatch`:
 
-Elixir
-
 ```elixir
 defmodule MyRouter do
   use Plug.Router
@@ -154,13 +153,13 @@ end
 
 The plug adds request metadata such as `$current_url`, `$host`, `$pathname`, `$request_method`, `$user_agent`, and `$ip`. It also reads `X-PostHog-Distinct-Id` and `X-PostHog-Session-Id` as analytics context so backend events and errors can be linked to frontend users and sessions.
 
-If you're using [PostHog JS](/docs/libraries/js.md) on the frontend, configure [`tracing_headers`](/docs/libraries/js/config.md#tracing-headers) for your Phoenix or Plug backend hostname so browser requests include these headers.
+If you're using [PostHog JS](https://posthog.com/docs/libraries/js.md) on the frontend, configure [`tracing_headers`](https://posthog.com/docs/libraries/js/config.md#tracing-headers) for your Phoenix or Plug backend hostname so browser requests include these headers.
 
 Tracing headers are client-controlled analytics context, not authentication or authorization. Pass an authenticated `distinct_id` explicitly for security-sensitive server-side decisions.
 
 ## Feature flags
 
-PostHog's [feature flags](/docs/feature-flags.md) enable you to safely deploy and roll back new features as well as target specific users and groups with them.
+PostHog's [feature flags](https://posthog.com/docs/feature-flags.md) enable you to safely deploy and roll back new features as well as target specific users and groups with them.
 
 There are two steps to implement feature flags in Elixir:
 
@@ -170,8 +169,6 @@ Call `PostHog.FeatureFlags.evaluate_flags/1` once for the user, then read values
 
 #### Boolean feature flags
 
-Elixir
-
 ```elixir
 {:ok, snapshot} = PostHog.FeatureFlags.evaluate_flags("distinct_id_of_your_user")
 
@@ -184,8 +181,6 @@ end
 
 #### Multivariate feature flags
 
-Elixir
-
 ```elixir
 {:ok, snapshot} = PostHog.FeatureFlags.evaluate_flags("distinct_id_of_your_user")
 
@@ -204,9 +199,9 @@ end
 
 ### Step 2: Include feature flag information when capturing events
 
-If you want use your feature flag to breakdown or filter events in your [insights](/docs/product-analytics/insights.md), you'll need to include feature flag information in those events. This ensures that the feature flag value is attributed correctly to the event.
+If you want use your feature flag to breakdown or filter events in your [insights](https://posthog.com/docs/product-analytics/insights.md), you'll need to include feature flag information in those events. This ensures that the feature flag value is attributed correctly to the event.
 
-> **Note:** This step is only required for events captured using our server-side SDKs or [API](/docs/api.md).
+> **Note:** This step is only required for events captured using our server-side SDKs or [API](https://posthog.com/docs/api.md).
 
 There are two methods you can use to include feature flag information in your events:
 
@@ -214,8 +209,6 @@ There are two methods you can use to include feature flag information in your ev
 
 Put the same `snapshot` object that you used for branching into context. Subsequent captures from the same process attach the exact flag values from that evaluation and don't make another `/flags` request.
 
-Elixir
-
 ```elixir
 {:ok, snapshot} = PostHog.FeatureFlags.evaluate_flags("distinct_id_of_your_user")
 
@@ -231,8 +224,6 @@ By default, this attaches every flag in the snapshot using `$feature/<flag-key>`
 
 To reduce event property bloat, put a filtered snapshot in context:
 
-Elixir
-
 ```elixir
 {:ok, snapshot} = PostHog.FeatureFlags.evaluate_flags("distinct_id_of_your_user")
 
@@ -254,8 +245,6 @@ PostHog.FeatureFlags.set_in_context(
 
 In the event properties, include `$feature/feature_flag_name: variant_key`:
 
-Elixir
-
 ```elixir
 PostHog.capture("event_name", %{
   "$feature/feature-flag-key" => "variant-key",
@@ -267,8 +256,6 @@ PostHog.capture("event_name", %{
 
 By default, `evaluate_flags/1` evaluates every flag for the user. If you only need a few flags, pass `flag_keys` to request only those flags:
 
-Elixir
-
 ```elixir
 {:ok, snapshot} =
   PostHog.FeatureFlags.evaluate_flags(%{
@@ -279,13 +266,13 @@ Elixir
 
 ### Sending `$feature_flag_called` events
 
-Capturing `$feature_flag_called` events enables PostHog to know when a flag was accessed by a user and provide [analytics and insights](/docs/product-analytics/insights.md) on the flag. With `evaluate_flags/1`, the SDK sends this event when you call `PostHog.FeatureFlags.Evaluations.enabled?/2` or `PostHog.FeatureFlags.Evaluations.get_flag/2` for a flag.
+Capturing `$feature_flag_called` events enables PostHog to know when a flag was accessed by a user and provide [analytics and insights](https://posthog.com/docs/product-analytics/insights.md) on the flag. With `evaluate_flags/1`, the SDK sends this event when you call `PostHog.FeatureFlags.Evaluations.enabled?/2` or `PostHog.FeatureFlags.Evaluations.get_flag/2` for a flag.
 
 `PostHog.FeatureFlags.Evaluations.get_flag_payload/2` doesn't send `$feature_flag_called` events.
 
 ### Local feature flag evaluation
 
-Local evaluation is available in version 2.15.0 and later. Follow the [server-side local evaluation guide](/docs/feature-flags/local-evaluation.md) to find your secure key and see how to pass the person properties, groups, and group properties that your flag conditions require.
+Local evaluation is available in version 2.15.0 and later. Follow the [server-side local evaluation guide](https://posthog.com/docs/feature-flags/local-evaluation.md) to find your secure key and see how to pass the person properties, groups, and group properties that your flag conditions require.
 
 Store the secure key in a server-side environment variable. Don't expose it to client-side applications:
 
@@ -309,7 +296,7 @@ Use these configuration options to control local evaluation:
 | `flag_definition_request_timeout_ms` | `10_000` | Sets the timeout for each definition request. |
 | `flag_definition_cache_provider_timeout_ms` | `5_000` | Sets the timeout for each shared cache provider callback. |
 
-For multiple server instances, you can implement `PostHog.FeatureFlags.FlagDefinitionCacheProvider` and set `flag_definition_cache_provider: {module, state}`. This optional provider shares definitions and coordinates which instance polls PostHog. See [local evaluation in distributed environments](/docs/feature-flags/local-evaluation/distributed-environments?tab=Elixir.md) for the callback contract and configuration.
+For multiple server instances, you can implement `PostHog.FeatureFlags.FlagDefinitionCacheProvider` and set `flag_definition_cache_provider: {module, state}`. This optional provider shares definitions and coordinates which instance polls PostHog. See [local evaluation in distributed environments](https://posthog.com/docs/feature-flags/local-evaluation/distributed-environments?tab=Elixir.md) for the callback contract and configuration.
 
 ## Error tracking
 
@@ -319,8 +306,6 @@ As a matter of fact, since this is built on top of Elixir's `Logger` module, it
 
 You can always disable it by setting `enable_error_tracking` to false:
 
-Elixir
-
 ```elixir
 config :posthog,
   enable_error_tracking: false
@@ -399,8 +384,6 @@ end
 
 Then, each function in the PostHog module accepts an optional first argument with the name of the PostHog supervisor tree that will process the capture:
 
-Elixir
-
 ```elixir
 PostHog.capture(AnotherPostHog, "user_signed_up", %{distinct_id: "user123"})
 ```
@@ -408,11 +391,3 @@ PostHog.capture(AnotherPostHog, "user_signed_up", %{distinct_id: "user123"})
 ## Thanks
 
 The library is maintained by the PostHog team since February 2025. Thanks to [nkezhaya](https://github.com/nkezhaya) for contributing v0.1.0. Thanks to [martosaur](https://github.com/martosaur) for contributing v2.0.0.
-
-### Still have questions?
-
-Ask PostHog AI
-
-### Was this page useful?
-
-HelpfulCould be better

package/dist/global-skills/instrument-product-analytics/references/flask.md

@@ -2,9 +2,22 @@
 
 # Flask
 
+Canonical URL: https://posthog.com/docs/libraries/flask
+
+> **Cloud region:** This page uses US Cloud hosts. For an EU Cloud project, use `https://eu.i.posthog.com` instead of `https://us.i.posthog.com` (ingestion host), and use `https://eu.posthog.com` instead of `https://app.posthog.com` (app host for links).
+
+## On this page
+
+- [Installation](#installation)
+- [Identifying users](#identifying-users)
+- [Request contexts](#request-contexts)
+- [Error tracking](#error-tracking)
+- [Next steps](#next-steps)
+- [Supported versions](#supported-versions)
+
 PostHog makes it easy to get data about traffic and usage of your Flask app. Integrating PostHog enables analytics, custom events capture, feature flags, error tracking, and more.
 
-This guide walks you through integrating PostHog into your Flask app using the [Python SDK](/docs/libraries/python.md).
+This guide walks you through integrating PostHog into your Flask app using the [Python SDK](https://posthog.com/docs/libraries/python.md).
 
 > These docs cover version `7.x` of the Python SDK, which requires Python 3.10 or higher. On Python 3.9? See [supported versions](#supported-versions).
 
@@ -44,8 +57,6 @@ You can find your project token and instance address in [your project settings](
 >
 > In Python, you can do this through a context. All event captures in the same context will be tagged automatically with the correct `distinct_id`. Typically, you would set a fresh context and identify at the top of each route.
 >
-> Python
->
 > ```python
 > from posthog import new_context, identify_context, capture
 >
@@ -61,45 +72,58 @@ You can find your project token and instance address in [your project settings](
 
 ## Request contexts
 
-Use [contexts](/docs/libraries/python.md#contexts) to share identity, session IDs, and tags across multiple captures during a request.
-
-If you're using [PostHog JavaScript Web](/docs/libraries/js.md) on the frontend, configure [`tracing_headers`](/docs/libraries/js/config.md#tracing-headers) for your Flask backend hostname so browser requests include the session and distinct ID headers.
+Version `7.69.0` and later of the Python SDK includes a Flask integration that creates a fresh [context](https://posthog.com/docs/libraries/python.md#contexts) for every request. It adds the request URL, method, path, route, IP address, and user agent to events captured during the request.
 
-Then read the incoming headers in your Flask request handler. Tracing headers are client-controlled analytics context, not authentication or authorization, so prefer your authenticated user ID when one is available:
+Register the integration after you create your Flask app and PostHog client:
 
-Python
+app.py
 
 ```python
-from flask import request, session
-from posthog import identify_context, set_context_session, tag
+from posthog.integrations.flask import PosthogFlaskIntegration
 
-@app.route('/api/dashboard', methods=['POST'])
-def api_dashboard():
-    with posthog.new_context(fresh=True):
-        distinct_id = session.get('user_id') or request.headers.get('X-POSTHOG-DISTINCT-ID')
-        if distinct_id:
-            identify_context(str(distinct_id))
+PosthogFlaskIntegration(
+    app,
+    client=posthog,
+    capture_exceptions=True,
+)
+```
 
-        session_id = request.headers.get('X-POSTHOG-SESSION-ID')
-        if session_id:
-            set_context_session(session_id)
+Setting `capture_exceptions=True` captures unhandled Flask exceptions. Set it to `False` for request enrichment without automatic exception capture. If you omit it, the integration inherits the client's `enable_exception_autocapture` setting.
 
-        tag('$current_url', request.url)
-        tag('$request_method', request.method)
-        tag('$request_path', request.path)
+You can also provide:
 
-        posthog.capture('dashboard_api_called')
+-   `request_filter` to skip both enrichment and automatic exception capture for selected requests
+-   `extra_properties` to add application-specific properties to the request context
+-   `trust_tracing_headers` to accept PostHog session and distinct ID headers
 
-    return '', 204
+If you're using [PostHog JavaScript Web](https://posthog.com/docs/libraries/js.md) on the frontend, configure [`tracing_headers`](https://posthog.com/docs/libraries/js/config.md#tracing-headers) for your Flask backend hostname so browser requests include the session and distinct ID headers.
+
+The integration ignores these headers by default because clients can control them. Set `trust_tracing_headers=True` when registering the integration to accept them as analytics context. Don't use them for authentication or authorization.
+
+Identify the request context from your route when you have an authenticated user ID:
+
+```python
+from flask import session
+from posthog import identify_context
+
+@app.route("/api/dashboard", methods=["POST"])
+def api_dashboard():
+    user_id = session.get("user_id")
+    if user_id:
+        identify_context(str(user_id))
+
+    posthog.capture("dashboard_api_called")
+
+    return "", 204
 ```
 
-Events captured without a context or explicit `distinct_id` are sent as [anonymous events](/docs/data/anonymous-vs-identified-events.md) with an auto-generated `distinct_id`. See the [Python SDK docs](/docs/libraries/python.md#person-profiles-and-properties) for more details.
+Events captured without a context or explicit `distinct_id` are sent as [anonymous events](https://posthog.com/docs/data/anonymous-vs-identified-events.md) with an auto-generated `distinct_id`. See the [Python SDK docs](https://posthog.com/docs/libraries/python.md#person-profiles-and-properties) for more details.
 
 ## Error tracking
 
-Flask has built-in error handlers. This means PostHog’s default exception autocapture won’t work and we need to manually capture errors instead using `capture_exception()`:
+`PosthogFlaskIntegration` captures unhandled exceptions when you set `capture_exceptions=True` or enable exception autocapture on its client. It doesn't capture expected HTTP exceptions or exceptions consumed by your application's error handlers.
 
-Python
+Call `capture_exception()` from a custom error handler when you want to report a handled exception:
 
 ```python
 from flask import Flask, jsonify
@@ -122,13 +146,13 @@ def handle_exception(e):
 
 ## Next steps
 
-For any technical questions for how to integrate specific PostHog features into Flask (such as analytics, feature flags, A/B testing, etc.), have a look at our [Python SDK docs](/docs/libraries/python.md).
+For any technical questions for how to integrate specific PostHog features into Flask (such as analytics, feature flags, A/B testing, etc.), have a look at our [Python SDK docs](https://posthog.com/docs/libraries/python.md).
 
 Alternatively, the following tutorials can help you get started:
 
--   [How to set up analytics in Python and Flask](/tutorials/python-analytics.md)
--   [How to set up feature flags in Python and Flask](/tutorials/python-feature-flags.md)
--   [How to set up A/B tests in Python and Flask](/tutorials/python-ab-testing.md)
+-   [How to set up analytics in Python and Flask](https://posthog.com/tutorials/python-analytics.md)
+-   [How to set up feature flags in Python and Flask](https://posthog.com/tutorials/python-feature-flags.md)
+-   [How to set up A/B tests in Python and Flask](https://posthog.com/tutorials/python-ab-testing.md)
 
 ## Supported versions
 
@@ -137,11 +161,3 @@ These docs cover version `7.x` of the PostHog Python SDK, which requires Python
 Everything on this page works the same way on `6.9.3`. Event capture, the context API (`new_context`, `identify_context`, `set_context_session`), and `PosthogContextMiddleware` are identical on `6.9.3` and `7.0.0` — `7.0.0` only dropped Python 3.9 and bumped the optional LLM provider SDKs. That includes the middleware identifying the request context from the `X-POSTHOG-DISTINCT-ID` header and falling back to the authenticated user, which behaves the same across both lines.
 
 Later `7.x` releases add what the 6.x line does not receive, such as the Celery integration, tracing header sanitization, and `set_context_device_id`. They also changed the middleware's own captured properties: `7.x` sends the request IP as `$ip`, where `6.9.3` sends it as `$ip_address`, and `7.x` additionally captures `$request_path`, `$raw_user_agent`, and the authenticated user's `email`.
-
-### Still have questions?
-
-Ask PostHog AI
-
-### Was this page useful?
-
-HelpfulCould be better