Troubleshoot Recorder
Validating installation
Once you add the Meticulous snippet open your webapp (either locally or on the environment that you injected the snippet into) and record a session by clicking around on your web app.
If the snippet was installed successfully you should be able to view the recorded session in your Meticulous dashboard in the Sessions section.
I see a warning about high abandon rate
If you see a warning about high abandon rate, it means that the Meticulous recorder is abandoning for large number of sessions due to high load on the network. The Meticulous recorder snippet will automatically abandon if it detects that the load on the network is too large.
This is a protection mechanism for production deployments to prevent any performance degradation.
It is unnecessary for staging and internal deployments. You can add data-is-production-environment="false"
attribute to your script tag which will increase the threshold at which the snippet abandons. Or alternatively, if using the @alwaysmeticulous/recorder-loader
package you can set isProduction: true
when calling tryLoadAndStartRecorder
.
Setting the 'isProduction' flag does not affect whether the recorder will activate in production environments - instead it only marks the recordings that do get recorded as having been recorded from a production environment, and uses settings that are more appropriate for recording in production environments. If you wish to disable recording in production, see instructions here on how to set up the recorder only on specific environments.
I've installed the snippet but why do I not see any sessions in my Meticulous dashboard?
It is possible that the Meticulous recorder snippet is abandoning due to high load on the network.
You can verify whether this is the issue or not by adding a query param ?meticulousForceRecording=true
to the URL and then verifying whether sessions appear in your dashboard. If they do, then the snippet is abandoning due to large payloads being sent to Meticulous. See the section above for how to fix this.
Session recordings are still abandoned even after I've added data-is-production-environment="false"
to the script tag
Setting data-is-production-environment="false"
will increase the threshold at which the snippet abandons, but it will not prevent it from abandoning completely.
If you wish to fully disable this behaviour, you can add data-force-recording="true"
to your script tag. This will force the snippet to record all sessions regardless of the load on the network. Alternatively, if using the @alwaysmeticulous/recorder-loader
package you can set forceRecording: true
when calling tryLoadAndStartRecorder
.
Issues / questions?
We're always happy to help you with any issues you encounter while setting up or anything you might be unsure about.
Get in touch by emailing eng@meticulous.ai
Next Steps
- Relax and sit down while Meticulous is collecting session data for you
- Set up tests to run in CI