vybekiit 0.7.34 → 0.7.35

package/dist/global-skills/instrument-product-analytics/references/react-router-v7-framework-mode.md

@@ -2,7 +2,26 @@
 
 # React Router V7 framework mode (Remix V3)
 
-This guide walks you through setting up PostHog for React Router V7 in framework mode. If you're using React Router in another mode, find the guide for that mode in the [React Router page](/docs/libraries/react-router.md). If you're using React with another framework, go to the [React integration guide](/docs/libraries/react.md).
+Canonical URL: https://posthog.com/docs/libraries/react-router/react-router-v7-framework-mode
+
+> **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://us.posthog.com` or `https://app.posthog.com` (app host for links).
+
+## On this page
+
+- [Install client-side SDKs](#install-client-side-sdks)
+- [Add your environment variables](#add-your-environment-variables)
+- [Add the PostHogProvider to your app](#add-the-posthogprovider-to-your-app)
+- [Verify client-side events are captured](#verify-client-side-events-are-captured)
+- [Access PostHog methods](#access-posthog-methods)
+- [Identify your user](#identify-your-user)
+- [Create an error boundary](#create-an-error-boundary)
+- [Tracking element visibility](#tracking-element-visibility)
+- [Install server-side SDKs](#install-server-side-sdks)
+- [Create a server-side middleware](#create-a-server-side-middleware)
+- [Verify server-side events are captured](#verify-server-side-events-are-captured)
+- [Next steps](#next-steps)
+
+This guide walks you through setting up PostHog for React Router V7 in framework mode. If you're using React Router in another mode, find the guide for that mode in the [React Router page](https://posthog.com/docs/libraries/react-router.md). If you're using React with another framework, go to the [React integration guide](https://posthog.com/docs/libraries/react.md).
 
 1.  1
 
@@ -44,7 +63,7 @@ This guide walks you through setting up PostHog for React Router V7 in framework
     > worker-src 'self' blob: data:;
     > ```
     >
-    > `script-src` covers the snippet and the lazy-loaded bundles, `connect-src` covers event ingestion and feature flags, and `worker-src` covers session replay. The [toolbar needs a few more](/docs/advanced/content-security-policy.md), or use a [reverse proxy](/docs/advanced/proxy.md) so everything is first-party. Failing to do so causes silent failures where `capture` and `identify` calls never send, so the integration looks complete while zero events arrive. Remember `connect-src` falls back to `default-src`, so `default-src 'self'` blocks event delivery even when the script itself is bundled.
+    > `script-src` covers the snippet and the lazy-loaded bundles, `connect-src` covers event ingestion and feature flags, and `worker-src` covers session replay. The [toolbar needs a few more](https://posthog.com/docs/advanced/content-security-policy.md), or use a [reverse proxy](https://posthog.com/docs/advanced/proxy.md) so everything is first-party. Failing to do so causes silent failures where `capture` and `identify` calls never send, so the integration looks complete while zero events arrive. Remember `connect-src` falls back to `default-src`, so `default-src 'self'` blocks event delivery even when the script itself is bundled.
 
     In framework mode, you'll also need to set `posthog-js` and `@posthog/react` as external packages in your `vite.config.ts` file to avoid SSR errors.
 
@@ -116,14 +135,12 @@ This guide walks you through setting up PostHog for React Router V7 in framework
 
     To help PostHog track your user sessions across the client and server, you'll need to add the `tracing_headers: ['your-backend-hostname1.com', 'your-backend-hostname2.com', ...]` option to your PostHog initialization. This adds the `X-POSTHOG-DISTINCT-ID` and `X-POSTHOG-SESSION-ID` headers to requests sent to the configured hostnames, which we'll later use on the server-side.
 
-    TypeError: Cannot read properties of undefined
+    **TypeError: Cannot read properties of undefined**
 
     If you see the error `TypeError: Cannot read properties of undefined (reading '...')` this is likely because you tried to call a posthog function when posthog was not initialized (such as during the initial render). On purpose, we still render the children even if PostHog is not initialized so that your app still loads even if PostHog can't load.
 
     To fix this error, add a check that posthog has been initialized such as:
 
-    React
-
     ```jsx
     useEffect(() => {
       posthog?.capture('test') // using optional chaining (recommended)
@@ -142,12 +159,10 @@ This guide walks you through setting up PostHog for React Router V7 in framework
 
     *Confirm that you can capture client-side events and see them in your PostHog project*
 
-    At this point, you should be able to capture client-side events and see them in your PostHog project. This includes basic events like page views and button clicks that are [autocaptured](/docs/product-analytics/autocapture.md).
+    At this point, you should be able to capture client-side events and see them in your PostHog project. This includes basic events like page views and button clicks that are [autocaptured](https://posthog.com/docs/product-analytics/autocapture.md).
 
     You can also try to capture a custom event to verify it's working. You can access PostHog in any component using the `usePostHog` hook.
 
-    TSX
-
     ```jsx
     import { usePostHog } from '@posthog/react'
     
@@ -167,8 +182,6 @@ This guide walks you through setting up PostHog for React Router V7 in framework
 
     On the client-side, you can access the PostHog client using the `usePostHog` hook. This hook returns the initialized PostHog client, which you can use to call PostHog methods. For example:
 
-    TSX
-
     ```jsx
     import { usePostHog } from '@posthog/react'
     
@@ -178,7 +191,7 @@ This guide walks you through setting up PostHog for React Router V7 in framework
     }
     ```
 
-    For a complete list of available methods, see the [posthog-js documentation](/docs/libraries/js.md).
+    For a complete list of available methods, see the [posthog-js documentation](https://posthog.com/docs/libraries/js.md).
 
 6.  5
 
@@ -190,8 +203,6 @@ This guide walks you through setting up PostHog for React Router V7 in framework
 
     Generally, you identify users when they log in or when they input some identifiable information (e.g. email, name, etc.). You can identify users by calling the `identify` method on the PostHog client:
 
-    TSX
-
     ```jsx
     export default function Login() {
       const { user, login } = useAuth();
@@ -262,8 +273,6 @@ This guide walks you through setting up PostHog for React Router V7 in framework
 
     **Basic usage:**
 
-    React
-
     ```jsx
     import { PostHogCaptureOnViewed } from '@posthog/react'
     
@@ -280,8 +289,6 @@ This guide walks you through setting up PostHog for React Router V7 in framework
 
     You can include additional properties with the event to provide more context:
 
-    React
-
     ```jsx
     <PostHogCaptureOnViewed
         name="product-card"
@@ -299,8 +306,6 @@ This guide walks you through setting up PostHog for React Router V7 in framework
 
     Use `trackAllChildren` to track each child element separately. This is useful for galleries or lists where you want to know which specific items were viewed:
 
-    React
-
     ```jsx
     <PostHogCaptureOnViewed
         name="product-gallery"
@@ -319,8 +324,6 @@ This guide walks you through setting up PostHog for React Router V7 in framework
 
     You can customize when elements are considered "viewed" by passing options to the `IntersectionObserver`:
 
-    React
-
     ```jsx
     <PostHogCaptureOnViewed
         name="footer"
@@ -341,7 +344,7 @@ This guide walks you through setting up PostHog for React Router V7 in framework
 
     Recommended
 
-    Install the [PostHog Node SDK](/docs/libraries/node.md) using your package manager. This is the SDK you'll use to capture server-side events.
+    Install the [PostHog Node SDK](https://posthog.com/docs/libraries/node.md) using your package manager. This is the SDK you'll use to capture server-side events.
 
     ### npm
 
@@ -376,7 +379,7 @@ This guide walks you through setting up PostHog for React Router V7 in framework
      Next, create a server-side middleware to help you capture server-side events. This middleware helps you achieve the following:
 
      -   Initialize a PostHog client
-     -   Fetch the session and distinct ID from the `X-POSTHOG-SESSION-ID` and `X-POSTHOG-DISTINCT-ID` headers and pass them to your request as a [context](/docs/libraries/node.md#contexts). This automatically identifies the user and session for you in all subsequent event captures.
+     -   Fetch the session and distinct ID from the `X-POSTHOG-SESSION-ID` and `X-POSTHOG-DISTINCT-ID` headers and pass them to your request as a [context](https://posthog.com/docs/libraries/node.md#contexts). This automatically identifies the user and session for you in all subsequent event captures.
      -   Calls `shutdown()` on the PostHog client to ensure all events are sent before the request is completed.
 
      app/lib/posthog-middleware.ts
@@ -466,17 +469,9 @@ This guide walks you through setting up PostHog for React Router V7 in framework
 
      To get the most out of PostHog, you should familiarize yourself with the following:
 
-     -   [PostHog Web SDK docs](/docs/libraries/js.md): Learn more about the PostHog Web SDK and how to use it on the client-side.
-     -   [PostHog Node SDK docs](/docs/libraries/node.md): Learn more about the PostHog Node SDK and how to use it on the server-side.
-     -   [Identify users](/docs/product-analytics/identify.md): Learn more about how to identify users in your app.
-     -   [Group analytics](/docs/product-analytics/group-analytics.md): Learn more about how to use group analytics in your app.
-     -   [PostHog AI](/docs/posthog-ai.md): After capturing events, use PostHog AI to help you understand your data and build insights.
-     -   [Feature flags and experiments](/docs/libraries/react.md#feature-flags): Feature flag and experiment setup is the same as React. You can find more details in the React integration guide.
-
-### Still have questions?
-
-Ask PostHog AI
-
-### Was this page useful?
-
-HelpfulCould be better
+     -   [PostHog Web SDK docs](https://posthog.com/docs/libraries/js.md): Learn more about the PostHog Web SDK and how to use it on the client-side.
+     -   [PostHog Node SDK docs](https://posthog.com/docs/libraries/node.md): Learn more about the PostHog Node SDK and how to use it on the server-side.
+     -   [Identify users](https://posthog.com/docs/product-analytics/identify.md): Learn more about how to identify users in your app.
+     -   [Group analytics](https://posthog.com/docs/product-analytics/group-analytics.md): Learn more about how to use group analytics in your app.
+     -   [PostHog AI](https://posthog.com/docs/posthog-ai.md): After capturing events, use PostHog AI to help you understand your data and build insights.
+     -   [Feature flags and experiments](https://posthog.com/docs/libraries/react.md#feature-flags): Feature flag and experiment setup is the same as React. You can find more details in the React integration guide.

package/dist/global-skills/instrument-product-analytics/references/ruby-on-rails.md

@@ -2,18 +2,37 @@
 
 # Ruby on Rails
 
+Canonical URL: https://posthog.com/docs/libraries/ruby-on-rails
+
+> **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://us.posthog.com` (app host for links).
+
+## On this page
+
+- [Beta: integration via LLM](#beta-integration-via-llm)
+- [Features](#features)
+- [Installation](#installation)
+- [Identifying users](#identifying-users)
+- [Configuration](#configuration)
+- [Capturing events](#capturing-events)
+- [Request context](#request-context)
+- [Logs](#logs)
+- [Error tracking](#error-tracking)
+- [Feature flags](#feature-flags)
+- [Testing](#testing)
+- [Configuration reference](#configuration-reference)
+- [Troubleshooting](#troubleshooting)
+- [Next steps](#next-steps)
+
 PostHog makes it easy to get data about traffic and usage of your Ruby on Rails app. Integrating PostHog enables analytics, custom event capture, feature flags, and automatic exception tracking.
 
 This guide walks you through integrating PostHog into your Rails app using the [posthog-rails gem](https://github.com/PostHog/posthog-ruby/tree/main/posthog-rails).
 
 ## Beta: integration via LLM
 
-Install PostHog for Rails 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.
+Install PostHog for Rails in seconds with our wizard by running this prompt with [LLM coding agents](https://posthog.com/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.
 
 ## Features
@@ -24,7 +43,7 @@ Or, to integrate manually, continue with the rest of this guide.
 -   **Smart filtering** – Excludes common Rails exceptions (404s, etc.) by default
 -   **Request context** – Adds request metadata and optional PostHog tracing header identity/session context to captured events
 -   **Rails 7.0+ error reporter** – Integrates with Rails' built-in error reporting
--   **Log forwarding** – Optionally forwards `Rails.logger` output to [PostHog Logs](/docs/logs.md) over OpenTelemetry, automatically correlated with request context (Ruby 3.3+)
+-   **Log forwarding** – Optionally forwards `Rails.logger` output to [PostHog Logs](https://posthog.com/docs/logs.md) over OpenTelemetry, automatically correlated with request context (Ruby 3.3+)
 
 ## Installation
 
@@ -39,24 +58,20 @@ gem 'posthog-rails'
 
 Then run:
 
-Terminal
-
 ```bash
 bundle install
 ```
 
 ## 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.
 
 ### Generate the initializer
 
 Run the install generator to create the PostHog initializer:
 
-Terminal
-
 ```bash
 rails generate posthog:install
 ```
@@ -130,8 +145,6 @@ You can find your project token and instance address in [your project settings](
 
 > **Tip:** Use [`Rails.application.credentials`](https://guides.rubyonrails.org/security.html#custom-credentials) to avoid hardcoding API keys. First, add your keys and then reference them in your initializer:
 >
-> Terminal
->
 > ```bash
 > rails credentials:edit
 > ```
@@ -157,8 +170,6 @@ You can find your project token and instance address in [your project settings](
 
 Track custom events anywhere in your Rails app:
 
-Ruby
-
 ```ruby
 PostHog.capture({
   distinct_id: current_user.id,
@@ -169,8 +180,6 @@ PostHog.capture({
 
 Identify a user and set their person properties:
 
-Ruby
-
 ```ruby
 PostHog.identify({
   distinct_id: current_user.id,
@@ -189,32 +198,28 @@ PostHog Rails automatically applies request-scoped context to events captured du
 
 When `use_tracing_headers` is enabled, PostHog tracing headers (`X-PostHog-Distinct-Id` and `X-PostHog-Session-Id`) are also used as default `distinct_id` and `$session_id` values. Explicit `distinct_id` and properties passed to `PostHog.capture` always take precedence.
 
-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 Rails backend hostname so browser requests include the session and distinct ID 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 Rails backend hostname so browser requests include the session and distinct ID headers.
 
 Tracing headers are client-controlled analytics context, not authentication or authorization. Pass an authenticated `distinct_id` explicitly for security-sensitive server-side decisions.
 
 Disable tracing header identity/session capture if you do not want client-supplied tracing headers used for server-side events. Request metadata is still captured:
 
-Ruby
-
 ```ruby
 PostHog::Rails.config.use_tracing_headers = false
 ```
 
 ## Logs
 
-To set up [PostHog Logs](/docs/logs.md) in your Rails app, follow the [Ruby on Rails logs installation guide](/docs/logs/installation/ruby-on-rails.md). The integration forwards `Rails.logger` output to PostHog Logs over OpenTelemetry, automatically correlated with each request's distinct ID and session ID. Requires Ruby 3.3+.
+To set up [PostHog Logs](https://posthog.com/docs/logs.md) in your Rails app, follow the [Ruby on Rails logs installation guide](https://posthog.com/docs/logs/installation/ruby-on-rails.md). The integration forwards `Rails.logger` output to PostHog Logs over OpenTelemetry, automatically correlated with each request's distinct ID and session ID. Requires Ruby 3.3+.
 
 ## Error tracking
 
-For full details on setting up error tracking with Rails, see our [Rails error tracking installation guide](/docs/error-tracking/installation/ruby-on-rails.md).
+For full details on setting up error tracking with Rails, see our [Rails error tracking installation guide](https://posthog.com/docs/error-tracking/installation/ruby-on-rails.md).
 
 ### Automatic exception tracking
 
 When `auto_capture_exceptions` is enabled, exceptions are automatically captured:
 
-Ruby
-
 ```ruby
 class PostsController < ApplicationController
   def show
@@ -230,8 +235,6 @@ end
 
 You can also manually capture exceptions:
 
-Ruby
-
 ```ruby
 PostHog.capture_exception(
   exception,
@@ -242,8 +245,6 @@ PostHog.capture_exception(
 
 If you evaluated feature flags for the request, pass the same snapshot to include matching flag properties on the exception event:
 
-Ruby
-
 ```ruby
 flags = PostHog.evaluate_flags(current_user.id)
 
@@ -259,8 +260,6 @@ PostHog.capture_exception(
 
 When `auto_instrument_active_job` is enabled, ActiveJob exceptions are automatically captured with job context:
 
-Ruby
-
 ```ruby
 class EmailJob < ApplicationJob
   def perform(user_id)
@@ -275,8 +274,6 @@ end
 
 By default, PostHog extracts a `distinct_id` from job arguments by looking for a `user_id` key in hash arguments:
 
-Ruby
-
 ```ruby
 # PostHog will automatically use options[:user_id] as the distinct_id
 ProcessOrderJob.perform_later(order.id, user_id: current_user.id)
@@ -284,8 +281,6 @@ ProcessOrderJob.perform_later(order.id, user_id: current_user.id)
 
 For more control, use the `posthog_distinct_id` class method. The proc or block receives the same arguments as `perform`:
 
-Ruby
-
 ```ruby
 class SendWelcomeEmailJob < ApplicationJob
   posthog_distinct_id ->(user, _options) { user.id }
@@ -298,8 +293,6 @@ end
 
 You can also use a block:
 
-Ruby
-
 ```ruby
 class ProcessOrderJob < ApplicationJob
   posthog_distinct_id do |_order, notify_user_id|
@@ -316,8 +309,6 @@ end
 
 PostHog integrates with Rails' built-in error reporting:
 
-Ruby
-
 ```ruby
 # These errors are automatically sent to PostHog
 Rails.error.handle do
@@ -335,8 +326,6 @@ PostHog Rails automatically captures authenticated user information from your co
 
 If your user method has a different name, configure it:
 
-Ruby
-
 ```ruby
 PostHog::Rails.config.current_user_method = :logged_in_user
 ```
@@ -355,16 +344,12 @@ It also checks hash-like users for `id`, `pk`, and `uuid` keys.
 
 You can configure a specific method:
 
-Ruby
-
 ```ruby
 PostHog::Rails.config.user_id_method = :email
 ```
 
 Or define a method on your User model:
 
-Ruby
-
 ```ruby
 class User < ApplicationRecord
   def posthog_distinct_id
@@ -393,8 +378,6 @@ The following exceptions are not reported by default (common 4xx errors):
 
 Add more with:
 
-Ruby
-
 ```ruby
 PostHog::Rails.config.excluded_exceptions = ['MyException']
 ```
@@ -403,8 +386,6 @@ PostHog::Rails.config.excluded_exceptions = ['MyException']
 
 Evaluate flags once for the current user, then read values from the returned snapshot:
 
-Ruby
-
 ```ruby
 class PostsController < ApplicationController
   def show
@@ -421,8 +402,6 @@ end
 
 For multivariate flags and experiments, use `get_flag`:
 
-Ruby
-
 ```ruby
 flags = PostHog.evaluate_flags(current_user.id)
 variant = flags.get_flag('checkout-experiment')
@@ -434,8 +413,6 @@ end
 
 When capturing an event after branching on a flag, pass the same `flags` snapshot so the event includes the exact flag values used by your code:
 
-Ruby
-
 ```ruby
 flags = PostHog.evaluate_flags(current_user.id)
 
@@ -448,13 +425,11 @@ PostHog.capture({
 
 For local evaluation, ensure you've set `personal_api_key`:
 
-Ruby
-
 ```ruby
 config.personal_api_key = Rails.application.credentials.posthog[:personal_api_key]
 ```
 
-See our [Ruby SDK docs](/docs/libraries/ruby.md#local-evaluation) for details on local evaluation with Puma and Unicorn servers.
+See our [Ruby SDK docs](https://posthog.com/docs/libraries/ruby.md#local-evaluation) for details on local evaluation with Puma and Unicorn servers.
 
 > **Note:** `PostHog.is_feature_enabled`, `PostHog.get_feature_flag`, `PostHog.get_feature_flag_result`, `PostHog.get_feature_flag_payload`, and `PostHog.capture({ ..., send_feature_flags: true })` still work during the migration period, but they're deprecated. Prefer `PostHog.evaluate_flags` for new code.
 
@@ -500,7 +475,7 @@ end
 | `feature_flag_request_timeout_seconds` | Integer | `3` | Timeout, in seconds, for feature flag requests. |
 | `before_send` | Proc | `nil` | Callback that receives the event hash before it is queued or sent. Return a modified event hash, or `nil` to drop the event. |
 
-The `PostHog.init` block supports the options above. Less common core options like `batch_size`, `disable_singleton_warning`, `skip_ssl_verification`, and `flag_definition_cache_provider` can be passed as an options hash to `PostHog.init(...)`; see the [Ruby SDK docs](/docs/libraries/ruby.md#configuration) for details.
+The `PostHog.init` block supports the options above. Less common core options like `batch_size`, `disable_singleton_warning`, `skip_ssl_verification`, and `flag_definition_cache_provider` can be passed as an options hash to `PostHog.init(...)`; see the [Ruby SDK docs](https://posthog.com/docs/libraries/ruby.md#configuration) for details.
 
 ### Rails-specific options
 
@@ -523,8 +498,6 @@ Configure these via `PostHog::Rails.configure` or `PostHog::Rails.config`:
 
 1.  Verify PostHog is initialized:
 
-    Ruby
-
     ```ruby
     Rails.console
     > PostHog.initialized?
@@ -535,8 +508,6 @@ Configure these via `PostHog::Rails.configure` or `PostHog::Rails.config`:
 
 3.  Verify middleware is installed:
 
-    Ruby
-
     ```ruby
     Rails.application.middleware
     ```
@@ -553,12 +524,4 @@ Ensure you've set `personal_api_key` in your configuration.
 
 ## Next steps
 
-For any technical questions for how to integrate specific PostHog features into Rails (such as analytics, feature flags, A/B testing, etc.), have a look at our [Ruby SDK docs](/docs/libraries/ruby.md).
-
-### Still have questions?
-
-Ask PostHog AI
-
-### Was this page useful?
-
-HelpfulCould be better
+For any technical questions for how to integrate specific PostHog features into Rails (such as analytics, feature flags, A/B testing, etc.), have a look at our [Ruby SDK docs](https://posthog.com/docs/libraries/ruby.md).