Ignoring Sessions
highlight.io allows you to ignore sessions that you don't want to see in your session feed. This is useful for sessions that you know are not relevant to your application, or that are not actionable.
Ignore sessions by user identifier
In some cases, you may want to ignore sessions from a specific user. You can do this by adding the user identifier to the "Excluded Sessions" input under the "Session Replay" tab in your project settings. Please note that we use the identifier
(or first argument) sent in your H.identify
method to ignore against (SDK docs here).
Ignoring sessions without an error
If you're using Highlight mostly for error monitoring, enable the "Filter sessions without an error" in your project settings to only record sessions with an error.
Ignoring sessions using custom logic
If you'd like to ignore sessions based on custom logic (e.g. ignoring sessions from users who have not logged in), use the manualStart
flag in your H.init
configuration. This will allow you to start and stop a session at your discretion.
H.init({ manualStart: true, // ... other options })
Then you can manually start a session by calling H.start
:
useEffect(() => { if (userIsLoggedIn) { H.start() } }, [userIsLoggedIn])
Disable all session recording
If you're interested in using Highlight for the error monitoring or logging products without session replay, use the follow setting:
import { H } from 'highlight.run'; H.init('<YOUR_PROJECT_ID>', { disableSessionRecording: true, // ... });
Want to ignore something else?
If you'd like an easier way to ignore specific types of sessions, we're open to feedback. Please reach out to us in our discord community.