Git Licenses Test

GitHub uses a unique-user licensing model. For enterprise products that include multiple deployment options, GitHub determines how many licensed seats you are consuming based on the number of unique users across all your deployments. Each user consumes only one license regardless of the number of GitHub Enterprise Server instances that the user uses, or number of organizations in which the user is a member of on GitHub Enterprise Cloud. This model allows each person to use multiple GitHub Enterprise deployments without incurring extra costs.

To ensure the same user is not consuming more than one license for multiple enterprise deployments, you can synchronize license usage between your GitHub Enterprise Server and GitHub Enterprise Cloud deployments.

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.
Confirm Password	Confirm the password by retyping it here.
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 and Proxy Port	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 Username, Proxy Password and Confirm Password	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,
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
Licenses purchased	Indicates the total number of licenses purchased for the target account.	Number
Licenses consumed	Indicates the number of licenses that are consumed by the target account.	Number	If the value of this measure is close to the value of the License purchased measures, administrators should allocate more licenses or free up the licenses as per the requirement. The detailed diagnosis of this measure reveals the name of user and service ID of the enterprise. In addition, you can also figure our whether the user is a Github user or not, type of license used by each user, etc.
License consumed	Indicates the percentage of licenses consumed by the target account.	Percent