vybekiit 0.4.0 → 0.6.0

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

@@ -0,0 +1,272 @@
+# Identify users - Docs
+
+Linking events to specific users enables you to build a full picture of how they're using your product across different sessions, devices, and platforms.
+
+This is straightforward to do when [capturing backend events](/docs/product-analytics/capture-events?tab=Node.js.md), as you associate events to a specific user using a `distinct_id`, which is a required argument.
+
+However, in the frontend of a [web](/docs/libraries/js/features.md#capturing-events) or [mobile app](/docs/libraries/ios.md#capturing-events), a `distinct_id` is not a required argument — PostHog's SDKs will generate an anonymous `distinct_id` for you automatically and you can capture events anonymously, provided you use the appropriate [configuration](/docs/libraries/js/features.md#capturing-anonymous-events).
+
+To link events to specific users, call `identify`:
+
+PostHog AI
+
+### Web
+
+```javascript
+posthog.identify(
+  'distinct_id',  // Replace 'distinct_id' with your user's unique identifier
+  { email: 'max@hedgehogmail.com', name: 'Max Hedgehog' } // optional: set additional person properties
+);
+```
+
+### Android
+
+```kotlin
+PostHog.identify(
+    distinctId = distinctID, // Replace 'distinctID' with your user's unique identifier
+    // optional: set additional person properties
+    userProperties = mapOf(
+        "name" to "Max Hedgehog",
+        "email" to "max@hedgehogmail.com"
+    )
+)
+```
+
+### iOS
+
+```swift
+PostHogSDK.shared.identify("distinct_id", // Replace "distinct_id" with your user's unique identifier
+                           userProperties: ["name": "Max Hedgehog", "email": "max@hedgehogmail.com"]) // optional: set additional person properties
+```
+
+### React Native
+
+```jsx
+posthog.identify('distinct_id', { // Replace "distinct_id" with your user's unique identifier
+    email: 'max@hedgehogmail.com', // optional: set additional person properties
+    name: 'Max Hedgehog'
+})
+```
+
+### Dart
+
+```dart
+await Posthog().identify(
+  userId: 'distinct_id', // Replace "distinct_id" with your user's unique identifier
+  userProperties: {
+    'email': 'max@hedgehogmail.com', // optional: set additional person properties
+    'name': 'Max Hedgehog',
+  },
+);
+```
+
+Events captured after calling `identify` are identified events and this creates a person profile if one doesn't exist already.
+
+Due to the cost of processing them, anonymous events can be up to 4x cheaper than identified events, so it's recommended you only capture identified events when needed.
+
+## How identify works
+
+When a user starts browsing your website or app, PostHog automatically assigns them an **anonymous ID**, which is stored locally.
+
+Provided you've [configured persistence](/docs/libraries/js/persistence.md) to use cookies or `localStorage`, this enables us to track anonymous users – even across different sessions.
+
+By calling `identify` with a `distinct_id` of your choice (usually the user's ID in your database, or their email), you link the anonymous ID and distinct ID together.
+
+Thus, all past and future events made with that anonymous ID are now associated with the distinct ID.
+
+This enables you to do things like associate events with a user from before they log in for the first time, or associate their events across different devices or platforms.
+
+Using identify in the backend
+
+Although you can call `identify` using our backend SDKs, it is used most in frontends. This is because there is no concept of anonymous sessions in the backend SDKs, so calling `identify` only updates person profiles.
+
+## Best practices when using `identify`
+
+### 1\. Call `identify` as soon as you're able to
+
+In your frontend, you should call `identify` as soon as you're able to.
+
+Typically, this is every time your **app loads** for the first time, and directly after your **users log in**.
+
+This ensures that events sent during your users' sessions are correctly associated with them.
+
+You only need to call `identify` once per session, and you should avoid calling it multiple times unnecessarily.
+
+If you call `identify` multiple times with the same data without reloading the page in between, PostHog will ignore the subsequent calls.
+
+### 2\. Use unique strings for distinct IDs
+
+If two users have the same distinct ID, their data is merged and they are considered one user in PostHog. Two common ways this can happen are:
+
+-   Your logic for generating IDs does not generate sufficiently strong IDs and you can end up with a clash where 2 users have the same ID.
+-   There's a bug, typo, or mistake in your code leading to most or all users being identified with generic IDs like `null`, `true`, or `distinctId`.
+
+PostHog also has built-in protections to stop the most common distinct ID mistakes.
+
+### 3\. Reset after logout
+
+If a user logs out on your frontend, you should call `reset()` to unlink any future events made on that device with that user.
+
+This is important if your users are sharing a computer, as otherwise all of those users are grouped together into a single user due to shared cookies between sessions.
+
+**We strongly recommend you call `reset` on logout even if you don't expect users to share a computer.**
+
+You can do that like so:
+
+PostHog AI
+
+### Web
+
+```javascript
+posthog.reset()
+```
+
+### iOS
+
+```swift
+PostHogSDK.shared.reset()
+```
+
+### Android
+
+```kotlin
+PostHog.reset()
+```
+
+### React Native
+
+```jsx
+posthog.reset()
+```
+
+### Dart
+
+```dart
+await Posthog().reset();
+```
+
+If you *also* want to reset the `device_id` so that the device will be considered a new device in future events, you can pass `true` as an argument:
+
+Web
+
+PostHog AI
+
+```javascript
+posthog.reset(true)
+```
+
+### 4\. Person profiles and properties
+
+You'll notice that one of the parameters in the `identify` method is a `properties` object.
+
+This enables you to set [person properties](/docs/product-analytics/person-properties.md).
+
+Whenever possible, we recommend passing in all person properties you have available each time you call identify, as this ensures their person profile on PostHog is up to date.
+
+Person properties can also be set being adding a `$set` property to a event `capture` call.
+
+See our [person properties docs](/docs/product-analytics/person-properties.md) for more details on how to work with them and best practices.
+
+### 5\. Use deep links between platforms
+
+We recommend you call `identify` [as soon as you're able](#1-call-identify-as-soon-as-youre-able), typically when a user signs up or logs in.
+
+This doesn't work if one or both platforms are unauthenticated. Some examples of such cases are:
+
+-   Onboarding and signup flows before authentication.
+-   Unauthenticated web pages redirecting to authenticated mobile apps.
+-   Authenticated web apps prompting an app download.
+
+In these cases, you can use a [deep link](https://developer.android.com/training/app-links/deep-linking) on Android and [universal links](https://developer.apple.com/documentation/xcode/supporting-universal-links-in-your-app) on iOS to identify users.
+
+1.  Use `posthog.get_distinct_id()` to get the current distinct ID. Even if you cannot call identify because the user is unauthenticated, this will return an anonymous distinct ID generated by PostHog.
+2.  Add the distinct ID to the deep link as query parameters, along with other properties like UTM parameters.
+3.  When the user is redirected to the app, parse the deep link and handle the following cases:
+
+-   The mobile app is already authenticated. In this case, call [`posthog.alias()`](/docs/libraries/js/features.md#alias) with the distinct ID from the web. This associates the two distinct IDs as a single person.
+-   The mobile app is unauthenticated. In this case, call [`posthog.identify()`](/docs/libraries/js/features.md#identifying-users) with the distinct ID from the web so pre-login mobile events stay connected to the web session. When the user later logs in on mobile, call `identify()` again with your canonical user ID.
+
+As long as you associate the distinct IDs with `posthog.identify()` or `posthog.alias()`, you can track events generated across platforms.
+
+Here's an example implementation for handling deep links from web to mobile:
+
+PostHog AI
+
+### iOS
+
+```swift
+import PostHog
+class DeepLinkIdentityManager {
+    static let shared = DeepLinkIdentityManager()
+    // MARK: - Deep Link Received
+    func handleDeepLink(_ url: URL, isAuthenticatedOnMobile: Bool) {
+        guard let webDistinctId = URLComponents(url: url, resolvingAgainstBaseURL: true)?
+            .queryItems?.first(where: { $0.name == "ph_distinct_id" })?.value else {
+            return
+        }
+        if isAuthenticatedOnMobile {
+            // The mobile app already knows the current user.
+            // Alias the incoming web distinct ID to that user.
+            PostHogSDK.shared.alias(webDistinctId)
+        } else {
+            // Reuse the web distinct ID until login on mobile.
+            PostHogSDK.shared.identify(webDistinctId)
+        }
+    }
+    // MARK: - Login/Signup
+    func handleLogin(canonicalUserId: String) {
+        // Switch from the web distinct ID (or a mobile anon ID)
+        // to your canonical user ID.
+        PostHogSDK.shared.identify(canonicalUserId)
+        // Set user properties, track signup event, etc.
+    }
+    func handleLogout() {
+        PostHogSDK.shared.reset()
+    }
+}
+```
+
+### Android
+
+```kotlin
+import android.net.Uri
+import com.posthog.PostHog
+object DeepLinkIdentityManager {
+    // Deep Link Received
+    fun handleDeepLink(uri: Uri, isAuthenticatedOnMobile: Boolean) {
+        val webDistinctId = uri.getQueryParameter("ph_distinct_id") ?: return
+        if (isAuthenticatedOnMobile) {
+            // The mobile app already knows the current user.
+            // Alias the incoming web distinct ID to that user.
+            PostHog.alias(webDistinctId)
+        } else {
+            // Reuse the web distinct ID until login on mobile.
+            PostHog.identify(webDistinctId)
+        }
+    }
+    // Login/Signup
+    fun handleLogin(canonicalUserId: String) {
+        // Switch from the web distinct ID (or a mobile anon ID)
+        // to your canonical user ID.
+        PostHog.identify(canonicalUserId)
+        // Set user properties, track signup event, etc.
+    }
+    fun handleLogout() {
+        PostHog.reset()
+    }
+}
+```
+
+## Further reading
+
+-   [Identifying users docs](/docs/product-analytics/identify.md)
+-   [How person processing works](/docs/how-posthog-works/ingestion-pipeline.md#2-person-processing)
+-   [An introductory guide to identifying users in PostHog](/tutorials/identifying-users-guide.md)
+
+### Community questions
+
+Ask a question
+
+### Was this page useful?
+
+HelpfulCould be better

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

@@ -0,0 +1,154 @@
+# iOS - Docs
+
+The PostHog iOS SDK is a library that you can use to track events, identify users, record session replays, evaluate feature flags, run experiments, build surveys, and more.
+
+This page shows you how to install the SDK and get started with it. If you've already installed the SDK, you can skip ahead to learn about [using the features](/docs/libraries/ios/usage.md) and [configuring the SDK](/docs/libraries/ios/configuration.md).
+
+## Installation
+
+PostHog is available through [CocoaPods](http://cocoapods.org) or you can add it as a Swift Package Manager based dependency.
+
+### CocoaPods
+
+Podfile
+
+PostHog AI
+
+```ruby
+pod "PostHog", "~> 3.59.3"
+```
+
+### Swift Package Manager
+
+Add PostHog as a dependency in your Xcode project "Package Dependencies" and select the project target for your app, as appropriate.
+
+For a Swift Package Manager based project, add PostHog as a dependency in your `Package.swift` file's Package dependencies section:
+
+Package.swift
+
+PostHog AI
+
+```swift
+dependencies: [
+  .package(url: "https://github.com/PostHog/posthog-ios.git", from: "3.59.3")
+],
+```
+
+and then as a dependency for the Package target utilizing PostHog:
+
+Package.swift
+
+PostHog AI
+
+```swift
+.target(
+    name: "myApp",
+    dependencies: [.product(name: "PostHog", package: "posthog-ios")]),
+```
+
+### Configuration
+
+Configuration is done through the `PostHogConfig` object. Here's a basic configuration example to get you started.
+
+You can find more advanced configuration options in the [configuration page](/docs/libraries/ios/configuration.md).
+
+## UIKit
+
+Swift
+
+PostHog AI
+
+```swift
+import Foundation
+import PostHog
+import UIKit
+class AppDelegate: NSObject, UIApplicationDelegate {
+    func application(_: UIApplication, didFinishLaunchingWithOptions _: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
+        let POSTHOG_PROJECT_TOKEN = "<ph_project_token>"
+        // usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com'
+        let POSTHOG_HOST = "https://us.i.posthog.com"
+        let config = PostHogConfig(projectToken: POSTHOG_PROJECT_TOKEN, host: POSTHOG_HOST)
+        PostHogSDK.shared.setup(config)
+        return true
+    }
+}
+```
+
+## SwiftUI
+
+Swift
+
+PostHog AI
+
+```swift
+import SwiftUI
+import PostHog
+@main
+struct YourGreatApp: App {
+    // Add PostHog to your app's initializer.
+    // If using UIApplicationDelegateAdaptor, see the UIKit tab.
+    init() {
+        let POSTHOG_PROJECT_TOKEN = "<ph_project_token>"
+        // usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com'
+        let POSTHOG_HOST = "https://us.i.posthog.com"
+        let config = PostHogConfig(projectToken: POSTHOG_PROJECT_TOKEN, host: POSTHOG_HOST)
+        PostHogSDK.shared.setup(config)
+    }
+    var body: some Scene {
+        WindowGroup {
+            ContentView()
+        }
+    }
+}
+```
+
+## Identifying users
+
+> **Identifying users is required.** Call `posthog.identify('your-user-id')` after login to link events to a known user. This is what connects frontend event captures, [session replays](/docs/session-replay.md), [LLM traces](/docs/ai-engineering.md), and [error tracking](/docs/error-tracking.md) to the same person — and lets backend events link back too.
+>
+> See our guide on [identifying users](/docs/getting-started/identify-users.md) for how to set this up.
+
+## Offline behavior
+
+The PostHog iOS SDK will continue to capture events when the device is offline. The events are stored in a queue in the device's file storage and are flushed when the device is online.
+
+-   The queue has a maximum size defined by `maxQueueSize` in the configuration.
+-   When the queue is full, the oldest event is deleted first.
+-   The queue is flushed only when the device is online.
+
+You can find the options for configuring the offline behavior in the [configuration page](/docs/libraries/ios/configuration.md#all-configuration-options).
+
+## Using PostHog with application extensions
+
+PostHog supports sharing analytics data between your main app and application extensions (such as widgets, app clips, share extensions, and custom keyboards) through App Groups. This ensures that users maintain the same identity across all parts of your app ecosystem.
+
+By default, each iOS app target stores its data in its own sandboxed directory. This means that if a user interacts with your main app and then uses a widget or extension, PostHog would treat them as two different anonymous users. This can lead to:
+
+-   Inflated user counts in your analytics
+-   Fragmented user journeys
+-   Difficulty tracking feature adoption across your app ecosystem
+
+[Learn more about setting up app groups](/docs/libraries/ios/configuration.md#setting-up-app-groups).
+
+## Method swizzling
+
+The PostHog iOS SDK uses method swizzling 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 particularly important for accurate session metrics tracking. When disabled, the SDK cannot capture optimal session metrics.
+
+You can learn more about configuring method swizzling in the [configuration page](/docs/libraries/ios/configuration.md#method-swizzling).
+
+## Next steps
+
+Now that you've installed the SDK, explore the configuration and usage options:
+
+-   [Learn about using all of the features of PostHog with iOS SDK](/docs/libraries/ios/usage.md)
+-   [Learn about configuration options for the iOS SDK](/docs/libraries/ios/configuration.md)
+
+### Community questions
+
+Ask a question
+
+### Was this page useful?
+
+HelpfulCould be better

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

@@ -0,0 +1,170 @@
+# Laravel - Docs
+
+PostHog integrates with Laravel through the [PostHog PHP SDK](/docs/libraries/php.md). This page covers Laravel-specific setup. For SDK features such as event capture, identifying users, feature flags, group analytics, and configuration options, see the [PHP SDK docs](/docs/libraries/php.md).
+
+## Installation
+
+Install the PHP SDK as described in the [PHP installation guide](/docs/libraries/php.md#installation), then add your project token and host to `.env`:
+
+.env
+
+PostHog AI
+
+```bash
+POSTHOG_API_KEY=<ph_project_token>
+POSTHOG_HOST=https://us.i.posthog.com
+```
+
+Add PostHog to Laravel's services config:
+
+config/services.php
+
+PostHog AI
+
+```php
+'posthog' => [
+    'api_key' => env('POSTHOG_API_KEY'),
+    'host' => env('POSTHOG_HOST', 'https://us.i.posthog.com'),
+],
+```
+
+Initialize PostHog in the `boot` method of `app/Providers/AppServiceProvider.php`:
+
+app/Providers/AppServiceProvider.php
+
+PostHog AI
+
+```php
+<?php
+namespace App\Providers;
+use Illuminate\Support\ServiceProvider;
+use PostHog\PostHog;
+class AppServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        if (! config('services.posthog.api_key')) {
+            return;
+        }
+        PostHog::init(
+            config('services.posthog.api_key'),
+            [
+                'host' => config('services.posthog.host'),
+            ]
+        );
+    }
+}
+```
+
+## Request context middleware
+
+Client SDKs such as [PostHog JS](/docs/libraries/js.md) can send tracing headers to your Laravel backend. Configure [`tracing_headers`](/docs/libraries/js/config.md#tracing-headers) for your Laravel backend hostname so browser requests include the session and distinct ID headers.
+
+The PHP SDK can read `X-PostHog-Distinct-Id` and `X-PostHog-Session-Id` headers and apply them to events captured during the request. Tracing headers are client-controlled analytics context, not authentication or authorization. For security-sensitive server-side events or decisions, pass an authenticated `distinctId` explicitly, such as `auth()->id()`. For the lower-level context APIs, see the [PHP request context docs](/docs/libraries/php.md#request-context).
+
+Add middleware like this:
+
+app/Http/Middleware/PostHogRequestContext.php
+
+PostHog AI
+
+```php
+<?php
+namespace App\Http\Middleware;
+use Closure;
+use Illuminate\Http\Request;
+use PostHog\PostHog;
+use Symfony\Component\HttpFoundation\Response;
+final class PostHogRequestContext
+{
+    public function handle(Request $request, Closure $next): Response
+    {
+        if (! config('services.posthog.api_key')) {
+            return $next($request);
+        }
+        $context = PostHog::contextFromHeaders($request->headers->all());
+        $context['properties'] = array_merge(
+            $context['properties'] ?? [],
+            array_filter([
+                '$current_url' => $request->fullUrl(),
+                '$request_method' => $request->method(),
+                '$request_path' => $request->getPathInfo(),
+                '$user_agent' => $request->userAgent(),
+                '$ip' => $request->ip(),
+            ], static fn ($value): bool => $value !== null && $value !== '')
+        );
+        return PostHog::withContext(
+            $context,
+            static fn (): Response => $next($request),
+            ['fresh' => true]
+        );
+    }
+}
+```
+
+Register this middleware using your Laravel version's normal middleware registration.
+
+## Error tracking in Laravel
+
+The PHP SDK supports [error tracking](/docs/libraries/php.md#error-tracking), but Laravel handles most request exceptions before they become uncaught PHP exceptions. Capture Laravel-reported exceptions explicitly.
+
+In Laravel 11 and later, add a report callback in `bootstrap/app.php`:
+
+bootstrap/app.php
+
+PostHog AI
+
+```php
+use Illuminate\Foundation\Configuration\Exceptions;
+use PostHog\PostHog;
+use Throwable;
+->withExceptions(function (Exceptions $exceptions): void {
+    $exceptions->report(function (Throwable $e): void {
+        if (! config('services.posthog.api_key')) {
+            return;
+        }
+        PostHog::captureException(
+            $e,
+            auth()->id() !== null ? (string) auth()->id() : null,
+            [
+                '$current_url' => request()->fullUrl(),
+                '$request_method' => request()->method(),
+            ]
+        );
+    });
+})
+```
+
+For older Laravel versions, call `PostHog::captureException()` from your exception handler's `report` method.
+
+## Long-running processes
+
+In normal PHP request lifecycles, queued events flush when the client is destroyed. In long-running Laravel processes such as queue workers, Horizon, or Octane, call `PostHog::flush()` after capturing important events or at the end of a job/request.
+
+If you prefer immediate delivery in queue workers, configure the PHP SDK with `batch_size` set to `1` for those workers:
+
+PHP
+
+PostHog AI
+
+```php
+PostHog::init(
+    '<ph_project_token>',
+    [
+        'host' => config('services.posthog.host'),
+        'batch_size' => 1,
+    ]
+);
+```
+
+## Next steps
+
+See the [PHP SDK docs](/docs/libraries/php.md) for usage examples and the full API reference.
+
+### Community questions
+
+Ask a question
+
+### Was this page useful?
+
+HelpfulCould be better