Do not follow this guide unless instructed to by Deskpro Support.
The service which this guide covers will generate a large number of log files which will not rotate.
If left running, this can cause your server to run out of available disk space.
This guide covers the use of the Jaeger Tracing addon. This addon can record in-depth telemetry from your helpdesk which can help identify issues with your helpdesk.
Adding the plugin
To add the Jaeger Tracing, first go to the plugins menu in the OPC: 
Here you have the option to deploy a custom add-on, but also add pre-configured add-ons provided by Deskpro.
To add Jaeger click 'Deploy' from the bottom of the page, this will then ask you to confirm you want to add the plugin, click confirm and it will be added to your OPC.
Configure and run the collector
Once the plugin has been added, it will show in the list at the top of the page, click the cog icon next to the name to configure the add-on 
To start the telemtry service working you will need to restart the instance container, click start when ready to enable the log collection 
Once enabled you will be taken by to the instance overview page which will have a new banner advising that telemetry collection is running, this also has a button to stop the logging once you have replicated the issue you have been seeing. 
Once the collection is running, you will then need to navigate to your instance and replicate the issue that you are reporting. This will then get logged by the telemetry collection.
Generating the log archive
Now that Jaeger Tracing is running, you will need to replicate the issue that you reported to the support team. Access your instance and try to reproduce the issue you are seeing 3 or 4 times, this will allow us to see exactly what is going on via the addon.
Once you have replicated the issue you then stop the collector by clicking the stop button on the banner. Clicking 'stop' will restart your instance container. 
It is important to click 'stop' as if left running, this can cause your server to run out of available disk space.
Once stopped, navigate back to the Jaeger Tracing addon menu, here you will be able to see that the collector is not running. In the download traces box, click the button 'Prepare Archive' 
This will compile all the generated data into an archive directory you can then download directly from the configuration page. 
Once downloaded you also have the option to delete the archive file.
Please log in or register to submit a comment.