Git Account Details Test

With a valid GitHub user account, you can do the following:

access all features and components of Git;
create the components such as repositories, branches and gists;
share repositories with other users;
get access to use the storage space allocated on the cloud;
follow other GitHub accounts;
collaborate with other GitHub users;
track the history of changes and events over time;
revert back your changes anytime to any version, etc.

Using this test, you can get an overview of the GitHub user account that is being configured for monitoring. In the process, this test reveals the count of private and public repositories and gists owned by the GitHub user account. In the process, this test sheds light on the disk space utilization in the user account. This helps you determine whether adequate storage space is available to ensure uninterrupted functioning of the repositories owned by the target account. Additionally, this test provides the detailed diagnosis using which you can identify the users who are currently following the target account and the users who are followed by the target account.

Target of the test : GitHub

Agent deploying the test : A remote agent

Outputs of the test : One set of the results for the GitHub user account being monitored

Configurable parameters for the test
Parameter	Description
Test Period	How often should the test be executed. By default, this is set to 1800 seconds.
Host	The IP address of the host for which this test is to be configured.
Port	The port at which the specified host listens. By default, this is NULL
Username and Password	Specify the valid credentials of a user of the GitHub against the Username and Password parameters.
Username	Specify the name of a user who can access the target GitHub account and is authorized to access the GitHub REST API to collect metrics.
API Token	The eG agent requires a Personal Access Token (PAT) to access the GitHub REST API, run API commands, and pull metrics of interest. The steps for generating this token have been detailed in How does eG Enterprise Monitor GitHub? Whenever the eG agent runs this test, it uses the token that is displayed (by default) against this parameter for accessing the GitHub REST API and pulling metrics. If for any reason, you generate a new authentication token for the target GitHub account at a later point in time, then make sure you update this parameter with the change. For that, copy the new token and paste it against this parameter.
Proxy Host	If the eG agent connects to the GitHub REST API via a proxy server, then provide the IP address of the proxy server here. If no proxy is used, then the default setting "none" of this parameter, need not be changed,
Proxy Port	If the eG agent connects to the GitHub REST API via a proxy server, then provide the port number at which that proxy server listens here. If no proxy is used, then the default setting "none" of this parameter, need not be changed,
Proxy Username, Proxy Password and Confirm Password	These parameters are applicable only if the eG agent uses a proxy server to connect to the GitHub REST API, and that proxy server requires authentication. In this case, provide a valid user name and password against the Proxy Username and Proxy Password parameters, respectively. Then, confirm the password by retyping it in the Confirm Password text box. If no proxy server is used, or if the proxy server used does not require authentication, then the default setting - none - of these parameters, need not be changed.
DD Frequency	Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 6:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD frequency.
Detailed Diagnosis	To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option. The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled: The eG manager license should allow the detailed diagnosis capability Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Public repository	Indicates the number of public repositories in the target user account.	Number
Private repositories	Indicates the number of private repositories in the target user account.	Number
Public gists	Indicates the number of public gists in the target user account.	Number	With gists, you can share single files, parts of files, and full applications with other users. Public gists show up in Discover, where people can browse new gists as they're created. They are also searchable, so you can use them if you'd like other people to find and see your work. After creating a gist, you cannot convert it from public to secret.
Private gists	Indicates the number of private gists in the target user account.	Number
Collaborators limit	Indicates the maximum number of collaborators who can access the repositories in the target user account.	Number	The value of this measure varies depending upon the type of GitHub account. For instance, if you're using GitHub Free account, you can add unlimited collaborators on public repositories, and up to three collaborators on private repositories owned by your personal account.
Private repos limit	Indicates the maximum number of repositories that can be maintained personal to the target user account.	Number
Max storage limit	Indicates the maximum amount of storage space allocated for the target user account.	MB	GitHub doesn't have any set user disk quota and provides abundant storage for all Git repositories, although there are hard limits for file and repository sizes. Keeping repositories small ensures that our servers are fast and downloads are quick for our users.
Disk usage	Indicates the amount of storage space utilized in the target user account.	MB
Free disk	Indicates the amount of storage space available for in the target user account.	MB	The value of this measure is desired to be high.
Disk Utilization	Indicates the amount of storage space available for use in the target user account.	Percent
Collaborators	Indicates the number of collaborators in the target user account.	Number	A collaborator is an outside user who has been granted write access to the main repository owned by the user account.
Followers	Indicates the number of users who follows the target user account.	Number	The detailed diagnosis of this measure reveals the login name, ID and type of every user who is following the user account being monitored and the URL of the follower profile.
Following	Indicates the number of users who are all followed by the target user account.	Number	The detailed diagnosis of this measure reveals the login name, ID, type and URL of every user who is being followed by the user account being monitored.

Use the detailed diagnosis of the Follwers measure to view the login name, ID and type of every user who is following the user account being monitored and the URL of the follower profile.

Figure 1 : The detailed diagnosis of the Followers measure

Use the detailed diagnosis of the Following measure to view the login name, ID, type and URL of every user who is being followed by the user account being monitored.

Figure 2 : The detailed diagnosis of the Following measure