Setting Custom Data

Attach custom user attributes to Android reports so you can filter them on the dashboard. Includes the 100 attribute cap and key and value limits.

User Attributes

You can assign custom attributes to your users and they will show up on your Luciq dashboard with each report. These attributes can later be used to filter reports in your dashboard.

To add a new user attribute use the following method.

Kotlin

Luciq.setUserAttribute("Age", "18")
Luciq.setUserAttribute("Logged", "True")

Disclaimers:

• Each Bug or Crash Report could have up to 100 user attributes only.
• The character limit for the Keys and Values is 90 characters each.

You can also retrieve the current value of a certain user attribute, or retrieve all user attributes.

Kotlin

// Getting specific attribute
Luciq.getUserAttribute("Logged in")


// Getting all attributes
Luciq.getAllUserAttributes();

Or remove the current value of a certain user attribute

Kotlin

Luciq.removeUserAttribute("Completed IAP")

User Events

You can log custom user events throughout your application. Custom events are automatically included with each report.

Kotlin

Luciq.logUserEvent("OnFeedbackButtonClicked")

Logging User Events with Parameters

Starting from SDK version 19.7.0, you can attach key-value parameters to a user event to capture additional context. Pass one or more UserEventParam instances after the event name.

Kotlin

Luciq.logUserEvent(
    "Completed Purchase",
    UserEventParam("item", "Premium Plan"),
    UserEventParam("currency", "USD")
)

Scope and behavior

• Starting from SDK version 19.10.0, event names are cleaned up before being recorded: surrounding whitespace and any newline characters are removed, and names are limited to 200 characters. Events with an empty name are not recorded and log a console error.
• Keys are limited to 50 characters and values to 200 characters. Parameters that are empty, exceed these limits, or repeat a key already added in the same call are dropped with a console error. For duplicate keys, the first occurrence is kept.
• Up to 15 parameters can be attached to a single event. Any parameters beyond the limit are dropped with a console error.

Tags

You can add custom tags to your bug and crash reports. These tags can later be used to filter reports or set custom rules from your dashboard.

The example below demonstrates how to add tags to a report.

Kotlin

Luciq.addTags("Tag 1", "Tag 2")

Adding tags before sending reports

Sometimes it's useful to be able to add a tag to a bug report before it's been sent. In these cases, the perfect solution would be use the event handlers of the bug reporting class.

You can also get all the currently set tags as follows.

Kotlin

Luciq.getTags()

Last, you can reset all the tags.

Kotlin

Luciq.resetTags()

Managing Tags

If you'd like to remove a particular tag from your dashboard to prevent it from appearing again when entering a new tag manually, you can do so by navigating to the tags page under the settings options and remove the tag. You can also edit and rename the tag.

---

Feature Flags

In certain scenarios, you might find that you're rolling out different experiments to different users, where your user base would see different features depending on what's enabled for them. In scenarios such as these, you'll want to keep track of the enabled experiments for each user and even filter by them.

Notes:

1. Feature Flag Naming: Each feature flag name should not exceed 70 characters and each variant name should not exceed 70 characters. Otherwise, they will get ignored by the SDK. Note that feature flag names are case-insensitive.
2. Feature Flag Persistence: Feature flag persist beyond individual sessions and are not automatically removed at the end of a session. Additionally, calling the logOut function does not impact the existence of the feature flag. The feature flag is only removed when you call the removing method or the clearing method.
3. The amount of feature flags sent in a session is 200 with maximum of 1 variant per a multivariate feature flag. For example, a feature flag that has 3 variants sent within 1 session will only be sent to our backend as the last variant, and not all 3.

For more information on feature flags, visit Feature Flags.

Adding Feature Flags

Boolean Feature Flags - Example Usage

Below is an example of where in your code you would use feature flag. In this example, you are experimenting with feature logic that controls whether or not the user has a Dark Mode toggle available.

Kotlin

Luciq.addFeatureFlag(LuciqFeatureFlag("dark_mode"))

Multivariant Feature Flags - Example Usage

Below is an example of where in your code you would use feature flag with multiple variants. In this example, you are experimenting with feature logic that controls multiple versions of a specific feature.

Kotlin

Luciq.addFeatureFlag(LuciqFeatureFlag("checkout_v2", "variant_b"))

Removing Feature Flags

If your feature flag is concluded or you would like to simply remove it, you can use this method:

Kotlin

Luciq.removeFeatureFLag("dark_mode"); // remove single key
Luciq.removeFeatureFlag(listOf("dark_mode", "checkout_v2")) // remove several at once

Clearing Feature Flags

You can use the below method to clear all the Feature Flags from your reports:

Kotlin

Luciq.removeAllFeatureFlags()