Learn how to setup RevDeBug with a RevDeBug.setup file
Estimated reading time: 3 mins
Last edited: 04 Nov 2019
RevDeBug.setup is a file that is created after a successful build with RevDeBug. Either through an IDE or a build server. It is located in the output folder of your application.
If you open the file in a text editor you should see a similar content:
Repository.Port=42742; Repository.Address=127.0.0.1; Application.Name=Starter; SolutionName=RDBShowRoom; ConnectivityType=Continuous; Release=; BacklogSize=1000;
It is very important to understand what is happening in this file.
First of all - Repository.Port and Repository.Address. This fields are used to connect to your data repository. Which in most cases is your RevDeBug Server - a place to store your recordings.
Next - Application.Name - this field will be used during recording. It will inform you what is currently beeing recorded. It appears in IDE Extension in the Status tab and as the name of the application in Standalone Recorder.
Similar purpose is this of the SolutionName, but this one is going to be used in DevOps Monitor. The division between this and previous fields is very important, because the latter is mostly used for applications in production environment. In this field you can set up a distinguishable name for each of your clients or environments and have a better understanding of what’s happening with you application. DevOps Monitor will see each application as different one.
On the ConnectivityType field you should ponder a little bit more, because it is crucial for the performance of your application. There are three values, that you can use here:
- Continuous - which means, that your application will be continuously connected to the RevDeBug Server. Even if you choose the standby or crash recording mode, the application will be connected. It won’t stream data, but there will be slight decrease in the performance.
- OnEvent - works quite on the contrary. The application connects to the RevDeBug Server only in case of a specified event. And this event needs to come from the application. For example a crash, or a specific method or object you wanted to record
- Noop - this field is especially useful when you want to connect to RevDeBug Server only in case of an emergency, or you care really much about performance. For example you can build your application with RevDeBug, prepare all the events that should be recorded, but unless you change this Noop setting, nothing will be recorded.
Release - allows you to distinguish versions of your application - it really comes in handy while using RevDeBug DevOps Monitor. Thanks to this field you can keep track of performance of each release and see what errors were introduced there.
And last, but not least - BacklogSize. An important field that is used in two cases:
- when ConnectivityType is set to OnEvent
- when ConnectivityType is set to Continuous and the recording mode is set to crash
This field holds the information about the amount of states/events, that are going to be recorded. In other words: it defines the size of data retention. For example - in case of a crash, how many events before the error you need to investigate the matter? As you can see in the example above, the default value is 1000, but you can change it according to your needs or usecase.