RUM Custom Facets :: Kloudfuse Docs
RUM Custom Facets
Custom facets make custom attributes searchable and visible in the RUM sidebar, enabling you to filter and analyze RUM events based on your application-specific data.
| Since creating Custom Facets impacts indexing and query performance, only an Admin user is currently allowed to add, modify, or delete them. |
Overview
By default, custom attributes included in RUM events are stored but not immediately available for filtering in the RUM interface. Creating a custom facet indexes a custom attribute and adds it to the facet sidebar, allowing you to:
- Filter RUM events by custom attribute values
- Group and aggregate data by custom attributes in analytics
- Create monitors and alerts based on custom attribute values
Create a Custom Facet
To create a custom facet from a RUM event:
Navigate to any RUM view (Sessions, Views, Actions, Errors, or Resources) and select an event to view its details.
In the event details, locate the custom attribute you want to promote to a facet.
Click on the custom attribute value (only attributes under
usr.orcontext.can be promoted to a custom facet).Select Promote to facet from the context menu.
In the dialog that appears, configure the facet properties:
- Attribute Path: Auto-populated with the path to the custom attribute (e.g.,
context.work_city). This uses dot notation for nested properties.- Facet Name: A user-friendly name for the facet that will appear in the RUM sidebar (e.g., "Work City").
- Click Save.
The custom facet will appear in the RUM sidebar and become available for filtering and analysis within a minute.
Manage Custom Facets
Edit a Facet
To modify an existing custom facet's user-friendly name:
- Navigate to RUM > Custom Facets.
- Find the facet you want to edit.
- Click the edit icon.
- Update the facet properties.
- Click Save.
Delete a Facet
To remove a custom facet:
- Navigate to RUM > Custom Facets.
- Find the facet you want to delete.
- Click the delete icon.
- Confirm the deletion.
| Deleting a custom facet removes it from the RUM sidebar but does not delete the underlying custom attribute data from RUM events. |
Considerations
- Custom facets are available within a few minutes of creation.
- High-cardinality facets (attributes with many unique values) may impact query performance.
- All custom attribute values are stored and indexed as strings.
- Use low-cardinality values for optimal performance.
Next Steps
- RUM Custom Attributes: Learn how to add custom attributes to RUM events using the SDK.
- RUM analytics: Use custom facets in RUM analytics to gain deeper insights.
- RUM Events List: Filter and search RUM events using custom facets.