No results for ""
EXPAND ALL
  • Home
  • API docs

GIVE DOCS FEEDBACK

Live events

Read time: 5 minutes
Last edited: Jun 07, 2024

Overview

This topic explains how to use live events.

The Live events page gives you real-time insight into the events your application is sending to LaunchDarkly, so you can ensure that you've set up LaunchDarkly correctly. Different types of events appear, in detail or in summary, depending on what you want to view.

About live events

The Live events page shows you a real-time stream of events arriving in LaunchDarkly from your app. When you first open the page, it connects to the event stream to show events as they appear. Establishing the connection can take up to 30 seconds, but the connection state updates to show you the connection process status. In high-volume environments, it may display sampled events, rather than 100% of events.

Click Filters and choose from the Flags, Contexts, and Experiments filters to view subsets of your live events. Use the search bar to search for specific events by context or event type, key, or kind.

The Live events page must be active to work

The Live events page does not process new events when it is not the active tab in your browser. Leave it open and visible to view new events as they occur. If you need to click around in your app to generate events, open your app in a second window.

The Live events page will time out after ten minutes of inactivity. After the timeout, click the prompt to keep loading events.

The connection state for the Live events page indicates if events have occurred in your environment recently:

  • Connected and waiting for events, last flag evaluation occurred N days/minutes/seconds ago: LaunchDarkly is connected to a live event stream with recent events.
  • Connected and waiting for events, but we haven't seen any events in this environment before: LaunchDarkly is connected to a live event stream, with no events received yet. If you receive this status frequently, it may mean that you have configured your SDK incorrectly. To learn more, read SDKs.
  • Disconnected from event stream: LaunchDarkly is not connected to a live event stream. This may appear because of an internal error or network disruptions. Refresh your browser, or click the Resume button to reconnect:
The "Resume" button on the Live events page.
The "Resume" button on the Live events page.

Flag events

To view live events by flag, use the Flags filter:

The "Flags" filter on the Live events page.
The "Flags" filter on the Live events page.

There are three types of events that can appear on the Live events page when you filter by flags:

  • Feature events
  • Summary events
  • Debug events

Feature events

Feature events include specific flag evaluation details. For more information about the contexts used in the flag evaluation, click View attributes. The Attribute viewer dialog appears. It lists the context attributes and includes a link to the context details page. To view an example, read Feature events.

Summary events

Summary events display a summary of flag evaluation events. This saves data load. To view an example, read Summary events.

Older SDK versions send detailed events for every evaluation, rather than summary events.

Click to expand the minimum required SDK version to use summary events

The minimum required version for each SDK to use summary events is:

  • .NET: 5.0.0
  • Go: 4.0.0
  • Java: 4.0.0
  • Node: 5.0.0
  • Python: 6.0.0
  • Ruby: 4.0.0
  • Rust: 1.0.0-beta.1
  • JavaScript: 2.0.0
  • Android: 2.4.0
  • iOS: 2.13.0
  • PHP: The PHP SDK does not itself support summary events. However, when PHP is used with the LaunchDarkly Relay Proxy, the LD Relay event forwarding mode has the ability to turn the events received from the PHP SDK into summary events. Other SDKs do not require a Relay Proxy update to use summary events.
    • If you are using PHP SDK version 3.1.0 to 6.0.x and you are using the Relay Proxy with PHP, then you will need to upgrade the Relay Proxy to version 4.0.0 or higher.
    • If you are using PHP SDK version 6.1.0 or higher and you are using the Relay Proxy with PHP, then you will need to upgrade the Relay Proxy to version 8.4.0 or higher.

Debug events

Debug events describe feature flag evaluations. The information can help you to troubleshoot feature flag evaluations.

To enable debug events, click Full fidelity details next to the summary event for a flag. This sends an update to the LaunchDarkly SDK. Then, the SDK sets the debugEventsUntilDate field and temporarily generates debug events for that flag. To view the details of a generated debug event, click View attributes next to the debug event for a flag.

To view an example, read Debug events.

Context events

To view only live events related to specific contexts, use the Contexts filter.

There are two types of context events that display on the Live events page:

  • Identify events are explicitly triggered by your application code
  • Index events are automatically triggered by the LaunchDarkly SDK based on flag evaluations

To view examples, read Identify events and Index events.

For more information about the context, click View attributes. The Attribute viewer dialog appears. It lists the context attributes and includes a link to the context details page.

Context events do not display information about the specific flag that was evaluated for this context. To find the corresponding flag, you can copy the context key, from the "Key" column, and then search for that key under the Flags filter.

The list of context events, with the "Copy to clipboard" button and the search field called out.
The list of context events, with the "Copy to clipboard" button and the search field called out.

Experimentation events

To view only live events from your experiments, use the Experiments filter. The Experiments filter only displays for customers who have Experimentation enabled. To learn more, read Experimentation.

There are three types of experiment events that display on the Live events page::

  • Click events
  • Page view events
  • Custom events

These events correspond to the kind of metric that triggered the event. To view examples, read Click events, Page view events, and Custom events.

For more information about the experiment, click the name of the experiment in the "Event" column.

For more information about the context participating in the experiment, click View attributes. The Attribute viewer dialog appears. It lists the context attributes and includes a link to the context details page.

Event schema

This topic describes the different types of live events. For details on the JSON schema for each type of event, read Data Export schema reference.