eG Monitoring
 

Measures reported by EXOLoginTest

To pull service status and service health metrics, eG Enterprise uses the Office 365 REST API. The eG agent logs into the REST API and runs commands to collect the required metrics. The typical API logon process is as outlined below:

  • The eG agent uses the Office 365 login credentials configured for the eG tests to login to the REST API.

  • Once Azure AD successfully validates the credentials, the authentication step completes.

  • After successful authentication, the eG agent hits the URL of the Exchange Domain configured for this test to complete the login.

If the eG agent is unable to login to the REST API or takes a long time to, then the following tests will not be able to report metrics:

  • O365LoginTest test

  • SharePoint Online Logon Status Test

  • EXOLoginTest test

If any of these tests fail to report metrics, then you may want to know whether it is owing to issues in the API logon process. In such a situation, it will be good practice to use the Logon Status test.

This test emulates the API logon process and reports the success/failure of each step of the process. Additionally, the test also measures the time taken to complete every step. This way, the test enables you to proactively detect problems in the API logon process and also pinpoint at which step of the logon process the bottleneck lies - in authentication? or in login?

Outputs of the test : One set of results for the Office 365 tenant being monitored.

The measures made by this test are as follows:

Measurement Description Measurement Unit Interpretation
Authentication_status Indicates whether/not the login credentials were validated by Azure AD.   If the login credentials are successfully validated by Azure AD, then this measure will report the value Success. The value Failed is reported if authentication fails.

The numeric values that correspond to these measure values are as follows:

Measure Value Numeric Value
Success 1
Failed 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate the authentication status. In the graph of this measure however, the same is indicated using the numeric equivalents only.

Authentication_time Indicates the time taken for the login credentials to be validated. Seconds An abnormally high value is a cause cor concern, as it indicates that authentication is slow.

If you suspect issues in the API logon process, then compare the value of this measure with that of the Login time measure to know where exactly the logon process is bottlenecked - is it during authentication - i.e., when login credentials are validated by Azure AD? or is it at login - i.e., when the domain-specific URL is hit?
Login_status Indicates whether/not the URL that this test hit returned a valid response page.   If this measure reports the value Success, it means that the test was able to connect to the SharePoint URL of the domain, successfully. On the other hand, if this measure reports the value Failed, it implies that the test could not connect to the SharePoint URL of the domain.

The numeric values that correspond to these measure values are as follows:

Measure Value Numeric Value
Success 1
Failed 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate the login status. In the graph of this measure however, the same is indicated using the numeric equivalents only.

Login_time Indicates the time taken to connect to the URL of the monitored domain. Seconds An abnormally high value is a cause cor concern, as it indicates that it is taking an unusually long time to connect to the URL.

If the Total_login_time reports an abnormally high value, then compare the value of this measure with that of the Authentication time measure to know where exactly the logon process is bottlenecked - is it at authentication - i.e., when login credentials are validated by Azure AD? or is it at login - i.e., when the domain-specific URL is hit?
Total_login_time Indicates the total time taken to complete the API logon process. Seconds A very high value for this measure indicates a bottleneck in the API logon process. Under such circumstances, compare the value of the Authentication time and Login time measures to know what is delaying API logon - authentication? or connecting to the domain-specific URL?