vybekiit 0.4.0 → 0.6.0

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

@@ -0,0 +1,299 @@
+# iOS SDK configuration - Docs
+
+## Autocapture configuration
+
+You can enable or disable autocapture through the `PostHogConfig` object.
+
+## Tracing headers
+
+Use `tracingHeaders` to connect iOS network requests to backend events, errors, and LLM traces captured by a server-side PostHog SDK:
+
+Swift
+
+PostHog AI
+
+```swift
+let configuration = PostHogConfig(projectToken: "<ph_project_token>", host: "https://us.i.posthog.com")
+configuration.tracingHeaders = ["api.example.com"]
+PostHogSDK.shared.setup(configuration)
+```
+
+Hostnames are matched exactly and should not include protocols, paths, ports, or wildcard subdomains. Matching `URLSession` requests include `X-POSTHOG-DISTINCT-ID` and `X-POSTHOG-SESSION-ID` when those values are available.
+
+Tracing headers require method swizzling, so `configuration.enableSwizzling` must remain `true`.
+
+## Flush configuration
+
+The iOS SDK uses an internal queue to make calls fast and non-blocking. It also batches requests and flushes asynchronously, making it perfect to use in any part of your mobile app.
+
+You can configure how many events queue before flushing with `flushAt`. Setting this to `1` will send events immediately and will use more battery. The default is `20`.
+
+You can also configure the flush interval with `flushIntervalSeconds` (default `30`), after which queued events are sent regardless of how many have been gathered:
+
+Swift
+
+PostHog AI
+
+```swift
+configuration.flushAt = 1
+configuration.flushIntervalSeconds = 30
+```
+
+You can also manually flush the queue to start sending events immediately instead of waiting for the next batch:
+
+Swift
+
+PostHog AI
+
+```swift
+PostHogSDK.shared.capture("logged_out")
+PostHogSDK.shared.flush()
+```
+
+Flushing is best-effort and asynchronous – it starts sending queued events in the background but doesn't wait for the request to finish, so it isn't a delivery guarantee.
+
+## Amending, dropping or sampling events
+
+Since version 3.28.0, you can provide a `BeforeSendBlock` function when initializing the SDK to amend, drop or sample events before they are sent to PostHog.
+
+> **⚠️ Note:** This replaces the deprecated `propertiesSanitizer` option and provides more flexibility in modifying events. You can achieve the same functionality as `propertiesSanitizer` by using a `BeforeSendBlock` that mutates the event's properties in place.
+
+> **🚨 Warning:** Amending and sampling events is advanced functionality that requires careful implementation. Core PostHog features may require 100% of unmodified events to function properly. We recommend only modifying or sampling your own custom events if possible, and preserving all PostHog internal events in their original form.
+
+### Redacting information in events
+
+`BeforeSendBlock` gives you one place to edit or redact information before it is sent to PostHog. For example:
+
+Redact URLs in event properties
+
+Swift
+
+PostHog AI
+
+```swift
+let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")
+config.setBeforeSend { event in
+    // Redact URLs
+    if let url = event.properties["url"] as? String {
+        event.properties["url"] = url.map { _ in "*" }.joined()
+    }
+    return event
+}
+```
+
+Redact sensitive information from event properties
+
+Swift
+
+PostHog AI
+
+```swift
+let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")
+config.setBeforeSend { event in
+    // Redact sensitive information
+    if let email = event.properties["email"] as? String {
+        event.properties["email"] = email.map { _ in "*" }.joined()
+    }
+    return event
+}
+```
+
+Drop events by event name
+
+Swift
+
+PostHog AI
+
+```swift
+let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")
+config.setBeforeSend { event in
+    // Drop all events named "Stale Event"
+    if event.event == "Stale Event" {
+        return nil
+    }
+    return event
+}
+```
+
+Filter autocaptured screen views
+
+You can stop specific screens from being autocaptured by filtering them in your before-send hook. Return `null` for any `$screen` event whose `$screen_name` matches a screen you don't want to track, and it's dropped before being sent – keeping unwanted screen views out of your event log.
+
+Because it's just a function, you can filter however you like – an **ignorelist** (drop the screens you name), an **allowlist** (invert the check to capture only the screens you name), or any custom rule such as a name prefix, a regex, or a check against the event's properties.
+
+Swift
+
+PostHog AI
+
+```swift
+let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")
+let ignoredScreens: Set<String> = ["Splash", "Debug"]
+config.setBeforeSend { event in
+    if event.event == "$screen",
+       let screenName = event.properties["$screen_name"] as? String,
+       ignoredScreens.contains(screenName) {
+        return nil
+    }
+    return event
+}
+```
+
+### Sampling events
+
+Sampling lets you choose to send only a percentage of events to PostHog. It is a good way to control your costs without having to completely turn off features of the SDK.
+
+Sample events by event name
+
+Swift
+
+PostHog AI
+
+```swift
+let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")
+config.setBeforeSend { event in
+    // Sample 10% of Sampled Event events
+    if event.event == "Sampled Event" {
+        if Double.random(in: 0...1) < 0.1 {
+            event.properties["$sample_type"] = ["sampleByEvent"]
+            event.properties["$sample_threshold"] = 0.1
+            event.properties["$sampled_events"] = ["Sampled Event"]
+            return event
+        }
+        return nil
+    }
+    return event
+}
+```
+
+### Chaining multiple BeforeSendBlocks
+
+You can provide an array of `BeforeSendBlock` functions to be called one after the other:
+
+Swift
+
+PostHog AI
+
+```swift
+let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")
+config.setBeforeSend(
+    // First block: Drop all events named "Stale Event"
+    { event in
+        if event.event == "Stale Event" {
+            return nil
+        }
+        return event
+    },
+    // Second block: Redact sensitive information
+    { event in
+        if let email = event.properties["email"] as? String {
+            event.properties["email"] = email.map { _ in "*" }.joined()
+        }
+        return event
+    }
+)
+```
+
+**Note:** When chaining beforeSend blocks, order is important. The first block is executed first and the mutated event is passed along to the second block, and so on. If at any point in the chain the event is dropped, any subsequent blocks will not be executed.
+
+## Setting up app groups
+
+1.  **Configure App Groups**: Set up an [App Group](https://developer.apple.com/documentation/xcode/configuring-app-groups) in Xcode for your main app and extension targets
+2.  **Configure PostHog**: Use the same App Group identifier in all targets:
+
+Swift
+
+PostHog AI
+
+```swift
+let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")
+config.appGroupIdentifier = "group.com.yourcompany.yourapp"
+PostHogSDK.shared.setup(config)
+```
+
+## Method swizzling
+
+Method swizzling is a technique that enables the SDK to intercept and modify method calls at runtime to provide advanced features like screen view tracking, element interactions, session replay, surveys, and more.
+
+Method swizzling is enabled by default, but can be disabled by setting the relevant config option to `false` in the `PostHogConfig` object:
+
+| Feature | Description | Config option |
+| --- | --- | --- |
+| Screen view tracking | Automatically captures when view controllers are presented | config.captureScreenViews |
+| Element interactions | Automatically tracks user interactions with UI elements | config.captureElementInteractions |
+| Rage clicks | Automatically captures $rageclick events for rapid repeated taps in the same area (iOS/macCatalyst, UIKit) | config.rageClickConfig.enabled |
+| Session replay | Records user sessions | config.sessionReplay |
+| Surveys | Displays surveys at appropriate times | config.surveys |
+| Advanced metrics tracking | Provides more precise session ID calculation and rotation by detecting user activity and idleness | N/A |
+
+### Disabling all method swizzling
+
+Since version 3.34.0, you can opt out of all swizzling using the `enableSwizzling` configuration option. When you disable swizzling, the SDK disables the features listed above.
+
+Swift
+
+PostHog AI
+
+```swift
+let config = PostHogConfig(projectToken: "<ph_project_token>", host: "<ph_api_client_host>")
+config.enableSwizzling = false
+PostHogSDK.shared.setup(config)
+```
+
+> **Note:** When method swizzling is disabled, features that depend on it will not work even if they are individually enabled in the config. For example, if you set `config.sessionReplay = true` and `config.enableSwizzling = false`, session replay will **not** be enabled.
+
+### Session metrics management
+
+Method swizzling is particularly important for accurate [session metrics tracking](/tutorials/session-metrics.md). With swizzling enabled, the SDK can better detect user activity and idle times to provide a better session rotation.
+
+With swizzling disabled, the SDK only uses application open/backgrounded events to detect user activity, which can lead to a sub-optimal session calculation.
+
+## Custom keyboard extensions
+
+Custom keyboard extensions have stricter security rules than other extension types. To use PostHog in a custom keyboard, the keyboard must have [Open Access permission](https://developer.apple.com/documentation/uikit/configuring-open-access-for-a-custom-keyboard) enabled. This permission is required for network requests and write access to shared containers.
+
+Users must explicitly grant Open Access in **Settings > General > Keyboard > Keyboards > \[Your Keyboard\] > Allow Full Access**.
+
+## All configuration options
+
+The [`PostHogConfig` object](https://github.com/PostHog/posthog-ios/blob/main/PostHog/PostHogConfig.swift) contains several other settings you can toggle:
+
+| Attribute | Description |
+| --- | --- |
+| flushAtType: IntegerDefault: 20 (5 on tvOS) | The number of queued events that the posthog client should flush at. Setting this to 1 will not queue any events and will use more battery. |
+| flushIntervalSecondsType: TimeIntervalDefault: 30 | The amount of time to wait before each tick of the flush timer, in seconds. Smaller values will make events delivered in a more real-time manner and also use more battery. A value smaller than 10 seconds will seriously degrade overall performance. |
+| maxQueueSizeType: IntegerDefault: 1000 (100 on tvOS) | The maximum number of items to queue before starting to drop old ones. This should be a value greater than zero, the behavior is undefined otherwise. |
+| maxBatchSizeType: IntegerDefault: 50 | Number of maximum events in a batch call. |
+| maxRetriesType: IntegerDefault: 3 | Maximum number of consecutive flush attempts before the entire queue is dropped to avoid infinite retries against a permanently-broken backend (e.g. wrong API key, exhausted quota, deterministic 5xx). Increments on every retriable failure including HTTP 413 cap halving; resets on a successful 2xx response. |
+| captureApplicationLifecycleEventsType: BooleanDefault: true | Whether the posthog client should automatically make a capture call for application lifecycle events, such as "Application Installed", "Application Updated" and "Application Opened". |
+| captureScreenViewsType: BooleanDefault: true | Whether the posthog client should automatically make a screen call when a view controller is added to a view hierarchy. Because the underlying implementation uses method swizzling, we recommend initializing the posthog client as early as possible (before any screens are displayed), ideally during the Application delegate's applicationDidFinishLaunching method. |
+| enableSwizzlingType: BooleanDefault: true | Enable method swizzling for SDK functionality that depends on it. When disabled, functionality that requires swizzling (like autocapture, screen views, session replay, surveys) will not be installed. |
+| captureElementInteractionsType: BooleanDefault: false | (UIKit only) Whether the posthog client should automatically make a capture call when the user interacts with an element in a screen. |
+| rageClickConfigType: ObjectDefault: .init() | (iOS/macCatalyst, UIKit) Rage click detection configuration. Includes enabled (default true), minimumTapCount (default 3), thresholdPoints (default 30), and timeoutInterval (default 1.0). Works independently of captureElementInteractions. Available in version 3.51.0+. |
+| sendFeatureFlagEventType: BooleanDefault: true | Send a $feature_flag_called event when a feature flag is used automatically. |
+| preloadFeatureFlagsType: BooleanDefault: true | Preload feature flags automatically. |
+| evaluationContextsType: Array of StringsDefault: undefined | Evaluation context tags that constrain which feature flags are evaluated. When set, only flags with matching evaluation context tags (or no evaluation context tags) will be returned. See [evaluation contexts documentation](/docs/feature-flags/evaluation-contexts.md) for more details. Available in version 3.38.0+. The legacy parameter evaluationEnvironments (version 3.33.0+) is also supported for backward compatibility. |
+| debugType: BooleanDefault: false | Logs the SDK messages to the Xcode console. |
+| optOutType: BooleanDefault: false | Prevents capturing any data if enabled. |
+| getAnonymousIdType: FunctionDefault: undefined | Hook that allows for modification of the default mechanism for generating anonymous id (which as of now is just random UUID v7). |
+| dataModeType: EnumDefault: .any | Controls when queued data is flushed. Use .wifi to flush only on Wi-Fi; .cellular is a legacy value and behaves like .any. |
+| personProfilesType: EnumDefault: .identifiedOnly | Determines the behavior for processing user profiles. |
+| setDefaultPersonPropertiesType: BooleanDefault: true | Automatically set common device and app properties (such as $app_version, $os_name, and $device_type) as person properties for feature flag evaluation. See [property overrides](/docs/feature-flags/property-overrides.md) for more details. |
+| sessionReplayType: BooleanDefault: false | Enable Recording of Session Replays. |
+| sessionReplayConfigType: ObjectDefault: .init() | Session Replay configuration. See [Session Replay installation](/docs/session-replay/installation/ios.md) for more details. |
+| tracingHeadersType: Array of StringsDefault: nil | Exact hostnames that should receive PostHog tracing headers when the SDK instruments URLSession requests. |
+| errorTrackingConfigType: ObjectDefault: .init() | Error Tracking configuration. See the [error tracking docs](/docs/error-tracking.md) for more details. |
+| logsType: ObjectDefault: .init() | Structured Logs configuration. See [Logs installation](/docs/logs/installation/ios.md) for more details. |
+| surveysConfigType: ObjectDefault: .init() | Surveys configuration, including custom survey delegates and display language overrides. |
+| urlSessionConfigurationType: URLSessionConfigurationDefault: .default | Custom URLSessionConfiguration used by the SDK for PostHog API requests. |
+| appGroupIdentifierType: StringDefault: nil | The identifier of the App Group that should be used to store shared analytics data. PostHog will try to get the physical location of the App Group's shared container, otherwise fallback to the default location. |
+| reuseAnonymousIdType: BooleanDefault: false | Whether the SDK should reuse the anonymous Id between user changes. When enabled, a single Id will be used for all anonymous users on this device. |
+| surveysType: BooleanDefault: true | Enable Surveys. |
+| setBeforeSendType: FunctionDefault: undefined | Hook that allows for amending, sampling, or dropping events before they are sent to PostHog. |
+
+### Community questions
+
+Ask a question
+
+### Was this page useful?
+
+HelpfulCould be better

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

@@ -0,0 +1,263 @@
+# Django - Docs
+
+PostHog makes it easy to get data about traffic and usage of your Django app. Integrating PostHog enables analytics, custom events capture, feature flags, error tracking, and more.
+
+This guide walks you through integrating PostHog into your Django app using the [Python SDK](/docs/libraries/python.md).
+
+## Beta: integration via LLM
+
+Install PostHog for Django in seconds with our wizard by running this prompt with [LLM coding agents](/blog/envoy-wizard-llm-agent.md) like Cursor and Bolt, or by running it in your terminal.
+
+`npx @posthog/wizard`
+
+[Learn more](/wizard.md)
+
+Or, to integrate manually, continue with the rest of this guide.
+
+## Installation
+
+To start, run `pip install posthog` to install PostHog’s Python SDK.
+
+> **Note:** Version `7.x` of the PostHog Python SDK requires Python 3.10 or higher.
+
+Then, configure PostHog in your app config so it's initialized when Django starts:
+
+your\_app/apps.py
+
+PostHog AI
+
+```python
+from django.apps import AppConfig
+import posthog
+class YourAppConfig(AppConfig):
+    name = 'your_app_name'
+    def ready(self):
+        posthog.api_key = '<ph_project_token>'
+        posthog.host = 'https://us.i.posthog.com'
+```
+
+Next, if you haven't done so already, add your `AppConfig` to `INSTALLED_APPS` in `settings.py`:
+
+settings.py
+
+PostHog AI
+
+```python
+INSTALLED_APPS = [
+    # ... other apps
+    'your_app_name.apps.YourAppConfig',
+]
+```
+
+You can find your project token and instance address in [your project settings](https://app.posthog.com/project/settings).
+
+To capture events from any file, import `posthog` and call the method you need. For example:
+
+Python
+
+PostHog AI
+
+```python
+import posthog
+from posthog import identify_context
+def some_request(request):
+    with posthog.new_context():
+        # Django includes request.user for anonymous visitors too. Only identify
+        # the context when the visitor is logged in.
+        if request.user.is_authenticated:
+            identify_context(str(request.user.pk))
+        posthog.capture('event_name')
+```
+
+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.
+
+## Identifying users
+
+> **Identifying users is required.** Backend events need a `distinct_id` to associate events with the correct user.
+>
+> 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
+>
+> PostHog AI
+>
+> ```python
+> from posthog import new_context, identify_context, capture
+> @app.get("/foo")
+> def foo(current_user: User = Depends(get_current_user)):
+>     with new_context(): # Set context at the top of a route
+>         identify_context(current_user.id)
+>         capture("foo_viewed")
+>     return {"status": "ok"}
+> ```
+
+## Django contexts middleware
+
+The Python SDK provides a Django middleware that automatically wraps all requests with a [context](/docs/libraries/python.md#contexts). This middleware extracts session and user information from each request and tags all events captured during that request with relevant metadata.
+
+### Basic setup
+
+Add the middleware to your Django settings. If your app uses Django authentication, place it after `django.contrib.auth.middleware.AuthenticationMiddleware` so the middleware can use the authenticated Django user as a distinct ID fallback and capture the user's email.
+
+Python
+
+PostHog AI
+
+```python
+MIDDLEWARE = [
+    # ... other middleware
+    'posthog.integrations.django.PosthogContextMiddleware',
+    # ... other middleware
+]
+```
+
+The middleware uses the globally configured `posthog` client by default, so you don't need to create or pass it a separate client instance.
+
+The middleware automatically extracts and uses:
+
+-   **Session ID** from the `X-POSTHOG-SESSION-ID` header, if present
+-   **Distinct ID** from the `X-POSTHOG-DISTINCT-ID` header, if present, falling back to the authenticated Django user's `pk` (Django's primary-key alias, which works with custom user models)
+-   **User email** from the authenticated Django user's `email` as `email`
+-   **Current URL** as `$current_url`
+-   **Request method** as `$request_method`
+-   **Request path** as `$request_path`
+-   **Forwarded IP address** from `X-Forwarded-For` as `$ip`
+-   **User agent** from `User-Agent` as `$user_agent`
+
+The session and distinct ID headers are sanitized before use. Empty values are ignored, control characters are removed, values are trimmed, and values are capped at 1000 characters.
+
+All events captured during the request (including exceptions) include these properties and are associated with the extracted session and distinct ID.
+
+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 Django backend hostname so browser requests include the session and distinct ID headers.
+
+### Exception capture
+
+By default, the middleware captures exceptions and sends them to PostHog's error tracking using the globally configured `posthog` client. This includes Django view exceptions that Django converts into error responses.
+
+Disable this by setting:
+
+Python
+
+PostHog AI
+
+```python
+# settings.py
+POSTHOG_MW_CAPTURE_EXCEPTIONS = False
+```
+
+### Adding custom tags
+
+Use `POSTHOG_MW_EXTRA_TAGS` to add custom properties to all requests:
+
+Python
+
+PostHog AI
+
+```python
+# settings.py
+def add_user_tags(request):
+    # type: (HttpRequest) -> Dict[str, Any]
+    tags = {}
+    if hasattr(request, 'user') and request.user.is_authenticated:
+        # Use pk instead of id so this works with custom User primary keys.
+        tags['user_id'] = str(request.user.pk)
+        tags['email'] = request.user.email
+    return tags
+POSTHOG_MW_EXTRA_TAGS = add_user_tags
+```
+
+#### Filtering requests
+
+Skip tracking for certain requests using `POSTHOG_MW_REQUEST_FILTER`:
+
+Python
+
+PostHog AI
+
+```python
+# settings.py
+def should_track_request(request):
+    # type: (HttpRequest) -> bool
+    # Don't track health checks or admin requests
+    if request.path.startswith('/health') or request.path.startswith('/admin'):
+        return False
+    return True
+POSTHOG_MW_REQUEST_FILTER = should_track_request
+```
+
+### Modifying default tags
+
+Use `POSTHOG_MW_TAG_MAP` to modify or remove default tags:
+
+Python
+
+PostHog AI
+
+```python
+# settings.py
+def customize_tags(tags):
+    # type: (Dict[str, Any]) -> Dict[str, Any]
+    # Remove URL for privacy
+    tags.pop('$current_url', None)
+    # Add custom prefix to method
+    if '$request_method' in tags:
+        tags['http_method'] = tags.pop('$request_method')
+    return tags
+POSTHOG_MW_TAG_MAP = customize_tags
+```
+
+### Complete configuration example
+
+Python
+
+PostHog AI
+
+```python
+# settings.py
+def add_request_context(request):
+    # type: (HttpRequest) -> Dict[str, Any]
+    tags = {}
+    if hasattr(request, 'user') and request.user.is_authenticated:
+        tags['user_type'] = 'authenticated'
+        # Use pk instead of id so this works with custom User primary keys.
+        tags['user_id'] = str(request.user.pk)
+    else:
+        tags['user_type'] = 'anonymous'
+    # Add request info
+    tags['user_agent'] = request.META.get('HTTP_USER_AGENT', '')
+    return tags
+def filter_tracking(request):
+    # type: (HttpRequest) -> bool
+    # Skip internal endpoints
+    return not request.path.startswith(('/health', '/metrics', '/admin'))
+def clean_tags(tags):
+    # type: (Dict[str, Any]) -> Dict[str, Any]
+    # Remove sensitive data
+    tags.pop('user_agent', None)
+    return tags
+POSTHOG_MW_EXTRA_TAGS = add_request_context
+POSTHOG_MW_REQUEST_FILTER = filter_tracking
+POSTHOG_MW_TAG_MAP = clean_tags
+POSTHOG_MW_CAPTURE_EXCEPTIONS = True
+```
+
+All events captured within the request context automatically include the configured tags and are associated with the session and user identified from the request headers or Django authentication.
+
+The middleware supports both sync (WSGI) and async (ASGI) Django applications. In async mode, it uses Django's `request.auser()` API when available to avoid synchronous user access.
+
+## Next steps
+
+For any technical questions for how to integrate specific PostHog features into Django (such as analytics, feature flags, A/B testing, etc.), have a look at our [Python SDK docs](/docs/libraries/python.md).
+
+Alternatively, the following tutorials can help you get started:
+
+-   [Setting up Django analytics, feature flags, and more](/tutorials/django-analytics.md)
+-   [How to set up A/B tests in Django](/tutorials/django-ab-tests.md)
+
+### Community questions
+
+Ask a question
+
+### Was this page useful?
+
+HelpfulCould be better