Enabling collection of Apdex data

If you want to collect Apdex (Application Performance Index) data, you must configure the agent to enable the data collection.

About this task

Application Performance Index

Apdex (Application Performance Index) is an open standard for measuring performance of software applications in computing. Its purpose is to convert measurements into insights about user satisfaction, by specifying a uniform way to analyze and report on the degree to which measured performance meets user expectations.

Apdex Formula

Apdex Score = (SatisfiedCount + ToleratingCount * ToleratingFactor + FrustatedCount * 0) / TotalSamples

For example:

Satisfied count = Count of requests which are executing in less than 3 secs: say 60
Tolerating count = Count of requests which are getting executed in between 3secs and 12secs: say 30
Frustrated count= Count of requests which are getting executed in greater than 12 secs: say 10
Total samples = Total number of requests executed: say 100(60+30+10)

Apdex Score = (60+30*0.5+10*0)/100 = 0.75

In the example, the tolerating time is 12 secs which is usually 4 times the satisfactory time (3secs) and the tolerating factor is 0.5.

Procedure

After agent installation, perform the following steps:
1. Launch a command prompt in administrator mode and navigate to CANDLE_HOME\qe\bin.
2. Run the following command:
```
net stop DotNetProfilerService
```
```
iisreset /stop
```
3. Edit the apdexconfig.txt located at CANDLE_HOME\qe\config.
  Example of apdexconfig.txt:
```
10,3,12,0.5  
8,2,9,0.3
4,4,10,0.6
```
  Note: On the second line: 8 is SiteID; 2 is satisfactory time in seconds; 9 is tolerating time in seconds; 0.3 is tolerating factor.
  Based on the sample file content, satisfied count will be the number of requests that take less than 2 seconds; tolerating count will be number of requests that take time between 2 seconds and 9 seconds.
  Valid Inputs
  - Tolerating Factor should be >0 and < 1
  - Satisfactory time != Tolerating time
  - Tolerating time > Satisfactory time
  Apdex Score obtained should always be >=0 and <=1.
If you wish to add or enable a new website later to collect the Apdex data, complete the following steps:
1. Launch a command prompt in administrator mode and navigate to CANDLE_HOME\qe\bin.
2. Run the following commands:
```
net stop DotNetProfilerService
```
```
iisreset /stop 
```
3. Edit the apdexconfig.txt located at CANDLE_HOME\qe\config\ with the new SiteID values on a next new line.
4. Run the following commands:
```
configdc unregisterdc all
```
```
configdc registerdc all
```
```
net start DotNetProfilerService
```
```
iisreset /start
```
The Apdex data range is referenced to decide the score severity as Critical, Waring and Normal. The data range values are showed below:
Critical: 0 - 0.40
Warning: 0.41 - 0.70
Normal: 0.71 - 1.00
The multiple web applications hosted under one website should use the same config values of the website. Refer to the SiteID in apdexconfig.txt.
UI display:
1. On Overview page, Apdex widget shows a table with columns Application Name and Apdex Score. The color code of Apex Score indicates its severity based on the Apex data range.
2. By clicking any row in the Apdex widget, a line chart is displayed to show the historical data of the selected Application Name, with time on X-axis and Apdex value on Y-axis.
3. Attribute details tab shows Apdex data.