Sending custom events

The Track method lets you record actions your users take on your site. This lets you record events that take place on your server.

Here's how:

client.Track("metric-key-123abc");
COPY

You can also attach custom data to your event by passing an extra parameter to Track, using the LdValue class to represent any value that can be encoded in JSON. To learn how, read LdClient.Track.

The track method lets you record actions your end users take in your application. You can also attach custom JSON data to your event by passing an extra JsonElement parameter to track.

Here's how:

client.track("metric-key-123abc", data);
COPY

To learn more, read track.

You can also attach custom data to your event by calling TrackData or TrackMetric.

The Track method allows you to record custom events in your application with LaunchDarkly:

client.Track("event-key-123abc");
COPY

To learn more, read Track.

Evaluating flags, either with variation() or with allFlags(), produces analytics events which you can observe on your LaunchDarkly Debugger page. The initial user you specify in the client constructor, as well as any user you specify with identify(), produces an analytics event which is how LaunchDarkly receives your user data.

You can also explicitly send an event with any data you like using the track function:

client.track('custom-event-key-123abc', { customProperty: someValue });
COPY

The track method lets you record actions your end users take in your application. You can also attach custom JSON data to your event by passing an extra LDValue parameter to track.

Here's how:

await LDClient.track('metric-key-123abc', data: LDValue.objectBuilder().addBool("clicked-button", true).build());
COPY

You can also attach custom data to your event by calling track with optional parameters.

In the iOS SDK, track is a custom event added to the LDClient event store. A client app can set a tracking event to allow client customized data analysis. After an app has called track, the app cannot remove the event from the event store. LDClient periodically transmits events to LaunchDarkly based on the frequency set in LDConfig.eventFlushInterval. The LDClient must be started and online.

After the SDK's event store is full, the SDK discards new events until the event store is cleared when it reports events to LaunchDarkly. Configure the size of the event store using LDConfig.eventCapacity. The first parameter, key, is the key for the event. The SDK does nothing with the key, which can be any string the client app sends. The second parameter, data, is the data for the event. The data parameter is optional. The SDK does nothing with the data, which can be any valid JSON item as an LDValue instance.

Optionally, you can add a metricValue parameter of type Double to track in Swift or as a required parameter to the overloaded track method in Objective-C.

let data: LDValue = ["some-custom-key": "some-custom-value", "another-custom-key": 7]
try LDClient.get()!.track(key: "MY_TRACK_EVENT_NAME", data: data)
COPY

To learn more, read the generated API documentation for Swift or Objective-C.

You can record custom events using the track function. Call track with the event key to record custom conversion/binary metrics.

The second argument is optional. It assists with observational analytics for Data Export destinations. With Data Export, the second argument gives additional information without saving the data to the LaunchDarkly context.

To call track:

client.track('event-name-123abc', { customProperty: someValue });
COPY

To learn how to attach custom data to your event with optional parameters, read track.

Tracking click and page view events in JavaScript

If you've defined click or page view metrics in LaunchDarkly, they'll be sent automatically once the client has been initialized. You do not have to do anything else with the client to send click or page view metrics.

To learn more about click and page view metrics, read Experimentation.

Analytics in JavaScript

Evaluating flags, either with variation() or with allFlags(), produces analytics events which you can observe on your LaunchDarkly Debugger page. The initial context you specify in the client constructor, as well as any context you specify with identify(), produces an analytics event which is how LaunchDarkly receives your context data.

You can also explicitly send an event with any data you like using the track function. The second argument is optional. For example:

client.track('your-event-name', { customProperty: someValue });
COPY

If you define click conversion or page view conversion metrics in LaunchDarkly, the SDK sends them automatically after you have initialized the client. You do not have to do anything else with the client to send click or page view goals. The SDK will generate page view events correctly regardless of how the URL is changed, such as by the HTML5 history API, by changing the URL hash fragment, etc.

To learn more about metrics, read Metrics.

The track method lets you record actions your users take, giving them any event key you want. This lets you record events that take place client-side. The current user data automatically accompany the event.

Here's an example:

client.track('something-happened');
client.track('something-happened-with-custom-data', { someData: 2 });
COPY

To learn how to attach custom data to your event with optional parameters, read track.

The track method lets you record actions your customers take in your app. You can also attach custom JSON data to your event by passing an extra parameter to track.

Optionally, you can add a metricValue parameter to the track method if you are using the latest version of Experimentation.

Here's how:

client.track('metric-flag-key-123abc', false);
client.track('metric-flag-key-with-data-456def', {some_data: 'value'});
COPY

To learn how to attach custom data to your event with optional parameters, read track.

The track method lets you record custom events in your application with LaunchDarkly.

Here's how:

REM without optional data
launchDarkly.track("event-key-123abc")
REM with optional data
launchDarkly.track("event-key-123abc", {"customField": 123})
REM with optional numeric metric
launchDarkly.track("event-key-123abc", invalid, 52.3)
COPY

The Track method lets you record actions customers take on your site. This lets you record events that take place on your server. In LaunchDarkly, you can tie these events to metrics in Experimentation.

Here's an example:

client.Track("metric-key-123abc", context);
COPY

You can also attach custom data to your event by passing an extra parameter to Track. To do this, use the LdValue type, which can contain any kind of data supported by JSON. You can also pass another parameter for a custom metric value.

The track method lets you record actions your users take in your you do application. You can also attach custom JSON data to your event by passing an LDValue parameter to track, or a custom metric value by passing a Double parameter.

Here's how:

client.track(user, 'metric-key-123abc', 52.3, LDValue.of('my value'));
COPY

To learn how to attach custom data to your event with extra parameters, read Other methods.

The LDClientTrack function lets you record actions your users take on your site. This lets you record events that take place on your server.

Here's how:

LDClientTrack(client, "metric-key-123abc", user, NULL);
COPY

To learn more, read LDClientTrack().

You can also attach custom data to your event by calling LDClientTrackMetric().

The track function lets you record actions customers take on your site. This lets you record events that take place on your server.

Here's how:

ldclient:track(<<"metric-key-123abc">>, #{key => <<"context-key-123abc">>}, #{data => <<"example">>})
COPY

To learn more, read track.

You can also attach a JSON object containing arbitrary data to your event, or a custom metric value. To learn how, read track_metric.

The Track methods allow you to record actions your customers take on your site. This lets you record events that take place on your server.

In this example, we use TrackEvent to send an event called completed-purchase. This event can correspond to a metric with the same key.

Here's how:

client.TrackEvent("completed-purchase", context)
COPY

You can also attach custom data to your event by calling TrackData, which takes an extra parameter. Or, if you are using experimentation, you can specify a numeric metric with TrackMetric.

The track function lets you record actions customers take on your site. This lets you record events that take place on your server.

Here's how:

track client context "metric-key-123abc" Nothing Nothing
COPY

You can also attach a JSON object containing arbitrary data to your event, or a custom metric value. To learn how, read track.

The track method lets you record actions end users take on your site. This lets you record events that take place on your server.

Here's how:

client.track("metric-key-123abc", context);
COPY

You can also attach custom JSON data to your event with an alternate version of track, trackData. You can set the data to any value that can be represented in JSON. To learn more, read LDValue.

If you are using Experimentation, you can specify a numeric metric with trackMetric.

The track method lets you record actions your users take. This lets you record events that take place on your server.

Here's how:

client:track("metric-key-123abc", user);
COPY

You can also attach an object containing arbitrary data to your event. To learn how, read track.

The track method lets you record actions that end users take on your site. This lets you record events that take place on your server.

Here's how:

client.track('metric-key-123abc', context);
COPY

You can also attach custom data to your event with optional parameters. To learn how, read track.

The track method lets you record actions your end users take on your site. This lets you record events that take place on your server.

Here's how:

$client->track("metric-key-123abc", $context);
COPY

You can also attach custom data, including anything that can be marshaled to JSON, to your event by passing an extra parameter to track. To learn how, read track().

The track method lets you record actions end users take on your site. This lets you record events that take place on your server.

Here's how:

ldclient.get().track("metric-key-123abc", context)
COPY

You can also attach custom data to your event with optional parameters. To learn how, read track.

The track method lets you record actions your contexts take on your site. This lets you record events that take place on your server.

Here's how:

client.track("metric-key-123abc", context)
COPY

You can also attach an extra hash containing arbitrary data to your event. To learn how, read track.

The track methods allow you to record actions your end users take on your site. This lets you record events that take place on your server.

In this example, we use track_event to send an event called completed-purchase. This event can correspond to a metric with the same key.

Here's how:

client.track_event(context, "completed-purchase");
COPY

You can also attach custom data to your event by calling track_data, which takes an extra parameter. Or, if you are using experimentation, you can specify a numeric metric with track_metric.

Sending events is available in Cloudflare SDK version 2.3.0 and later. You must explicitly enable sending events in your configuration.

The track method lets you record actions that end users take in your application.

Here's how:

client.track('metric-key-123abc', context);
COPY

You can also attach custom data to your event with optional parameters.

Here's how:

const exampleData = { customProperty: 'someValue' };
const metricValue = 10;
client.track('metric-key-123abc', context, exampleData, metricValue);
COPY

When you are working with an edge SDK, you must also call flush after sending any events:

executionContext.waitUntil(
  client.flush((err, res) => {
    console.log(`flushed events result: ${res}, error: ${err}`);
  }),
);
COPY

To learn more, read Flushing events.

Sending events is available in Vercel SDK version 1.2.0 and later. You must explicitly enable sending events in your configuration.

The track method lets you record actions that end users take in your application.

Here's how:

client.track('metric-key-123abc', context);
COPY

You can also attach custom data to your event with optional parameters.

Here's how:

const exampleData = { customProperty: 'someValue' };
const metricValue = 10;
client.track('metric-key-123abc', context, exampleData, metricValue);
COPY

When you are working with an edge SDK, you must also flush the events before your worker exits to ensure that they are sent back to LaunchDarkly. If you call flush inside the waitUntil method, then flushing events will not impact the handler's response time. To learn more, read the Vercel documentation on waitUntil.

Here's how:

context.waitUntil(
  client.flush((err, res) => {
    console.log(`flushed events result: ${res}, error: ${err}`);
  }),
);
COPY

To learn more, read Flushing events.