Git Events Test

A user with a valid account on the GitHub site can perform various actions within his/her account. Every action performed by the user is recorded as an event in a read-only API for GitHub events. These recorded events are helpful for tracking the history of past activities performed in the account. By analyzing the history of events, the user can instantly know the type of events that was performed frequently, the changes on repositories, whether the events were created by himself/herself or from outside, the details on the status of issues, etc. To help the users in this regard, this test monitors the events recorded in the read-only API and reports the number of different events reported over the time.

Target of the test : GitHub

Agent deploying the test : A remote agent

Outputs of the test : One set of the results for each event type.

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.

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 suite 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

Check run events

Indicates the number of events of this type triggered when a check run was created, requested, rerequested and completed.

Number

The check runs API enables you to build GitHub Apps that run powerful checks against code changes in a repository.

Check suite events

Indicates the number of events of this type triggered when a check suite was created, requested, rerequested and completed

Number

A check suite is a collection of the check runs created by a single GitHub App for a specific commit. Check suites summarize the status and conclusion of the check runs that a suite includes.

Commit comment events

Indicates the number of events of this type triggered when a commit comment was created.

Number

 

Content reference events

Indicates the number of events of this type triggered when the body or comment of an issue or pull request includes a URL that matches a configured content reference domain

Number

These events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (https://subdomain.example.com) then only URLs for the subdomain trigger this event. If you register a domain (https://example.com) then URLs for domain and all subdomains trigger this event.

Create events

Indicates the number of events of this type triggered when branches or tags were created.

Number

 

Delete events

Indicates the number of events of this type triggered when branches or tags were deleted.

Number

 

Deployment events

Indicates the number of events of this type triggered when new deployments were created.

Number

Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a deployment event that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native).

Deployment status events

Indicates the number of events of this type triggered when new deployments and deployment statuses were created.

Number

These events allows third-party integrations to receive respond to deployment requests and update the status of a deployment as progress is made.

Deployment statuses allow external services to mark deployments with an error, failure, pending, in progress, queued, or success state that systems listening to deployment status events can consume.

Deployment statuses can also include an optional description and log url, which are highly recommended because they make deployment statuses more useful. The log URL is the full URL to the deployment output, and the description is a high-level summary of what happened with the deployment.

Download events

Indicates the number of events of this type triggered when a new download was created.

Number

 

Follow events

Indicates the number of events of this type triggered when a user follows another user.

Number

 

Fork events

Indicates the number of events of this type triggered when a user forks a repository.

Number

A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.

Fork apply events

Indicates the number of events of this type triggered when a patch was applied in the fork queue.

Number

 

Github app authorization events

Indicates the number of events of this type triggered when a user revoked his authorization of a GitHub App.

Number

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this event, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the Bad Credentials error.

Gist events

Indicates the number of events of this type triggered when a Gist was created or updated.

Number

 

Gollum events

Indicates the number of events of this type triggered when a Wiki page was created or updated.

Number

Gollum is a simple wiki system built on top of Git. A Gollum Wiki is simply a git repository of a specific nature:

  • A Gollum repository's contents are human-editable. Pages are unique text files which may be organized into directories any way you choose, as long as they have a recognized file extension. Other content can also be included, for example images, PDFs and headers/footers.
  • Gollum pages:

    • May be written in a variety of markup languages.
    • Can be edited with your favourite system editor or IDE or with the built-in web interface.
    • Can be displayed in all versions, and can easily be rolled back.
  • Gollum supports advanced functionality like UML diagrams, macros, metadata, and more.

Installation events

Indicates the number of events of this type triggered when a user installed/uninstalled the GitHub App, or accepted new permissions for the GitHub App

Number

 

Installation repositories events

Indicates the number of events of this type triggered when a repository was added or removed from an installation.

Number

 

Issue comment events

Indicates the number of events of this type triggered when an issue comment was created, edited or deleted.

Number

 

Issues events

Indicates the number of events of this type triggered when an issue was opened, edited, deleted, transferred, pinned, unpinned, closed, reopened, assigned, unassigned, labeled, unlabeled, locked, unlocked, milestoned or demilestoned.

Number

 

Label events

Indicates the number of events of this type triggered when a repository's label was created, edited, or deleted.

Number

 

Marketplace purchase events

Indicates the number of events of this type triggered when changes were happened to the a user's plan from the Marketplace purchase.

Number

These events are recorded when a user purchased a GitHub Marketplace plan, canceled the plan, upgraded the plan (effective immediately), downgraded the plan that remains pending until the end of the billing cycle, or cancels a pending plan.

Member events

Indicates the number of events of this type triggered when a user accepted an invitation or was removed as a collaborator to a repository, or had his/her permissions changed.

Number

 

Membership events

Indicates the number of events of this type triggered when a user was added or removed from a team.

Number

 

Milestone events

Indicates the number of events of this type triggered when a milestone was created, closed, opened, edited or deleted.

Number

The milestones are helpful to track progress on groups of issues or pull requests in a repository. When you create a milestone, you can associate it with issues and pull requests.

From the milestone page, you can see:

  • A user-provided description of the milestone, which can include information like a project overview, relevant teams, and projected due dates
  • The milestone's due date
  • The milestone's completion percentage
  • The number of open and closed issues and pull requests associated with the milestone
  • A list of the open and closed issues and pull requests associated with the milestone

Additionally, you can edit the milestone from the milestone page and create new issues that are, by default, associated with the milestone.

Organization events

Indicates the number of events of this type triggered when an organization was deleted and renamed, and when a user was added, removed or invited to the organization.

Number

Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features.

Org block events

Indicates the number of events of this type triggered when an organization owner blocked or unblocked a user.

Number

 

Pagebuild events

Indicates the number of events of this type triggered on push to a GitHub Pages enabled branch (gh-pages for project pages, master for user and organization pages).

Number

A PageBuild Events represents whether an attempted build of a GitHub Pages site is successful or not.

Project card events

Indicates the number of events of this type triggered when a project card was created, edited, moved, converted to an issue, or deleted.

Number

 

Project column events

Indicates the number of events of this type triggered when a project column was created, updated, moved or deleted.

Number

 

Project events

Indicates the number of events of this type triggered when a project was created, updated, closed, reopened or deleted.

Number

 

Public events

Indicates the number of events of this type triggered when a private repository was made public.

Number

 

Pull request events

Indicates the number of events of this type triggered when a pull request was assigned, unassigned, labeled, unlabeled, opened, edited, closed, reopened, synchronized, ready for review, locked, unlocked or when a pull request review was requested or removed.

Number

 

Pull request review events

Indicates the number of events of this type triggered when a pull request review was submitted into a non-pending state, the body of the review was edited, or the review was dismissed.

Number

Reviews allow collaborators to comment on the changes proposed in pull requests, approve the changes, or request further changes before the pull request is merged. Repository administrators can require that all pull requests are approved before being merged.

Pull request review comment events

Indicates the number of events of this type triggered when a comment on a pull request's unified diff was created, edited or deleted.

Number

 

Push events

Indicates the number of events of this type triggered when repository branch pushes and repository tag pushes were performed.

Number

 

Release events

Indicates the number of events of this type triggered when a release was published, unpublished, created, edited, deleted or prereleased.

Number

 

Repository events

Indicates the number of events of this type triggered when a repository was created, archived, unarchived, renamed, edited, transferred, made public, or made private.

Number

 

Repository import events

Indicates the number of events of this type triggered when a successful, canceled, or failed repository import was finished for a GitHub organization or a personal repository.

Number

 

Repository vulnerability alert events

Indicates the number of events of this type triggered when a security alert was created, dismissed or resolved.

Number

 

Security advisory events

Indicates the number of events of this type triggered when a new security advisory was published, updated or withdrawn.

Number

A security advisory provides information about security-related vulnerabilities in software on GitHub. Security Advisory webhooks are available to GitHub Apps only. The security advisory dataset also powers the GitHub security alerts.

Status events

Indicates the number of events of this type triggered when the status of a Git commit changed.

Number

 

Team events

Indicates the number of events of this type triggered when an organization's team was created, deleted, edited, added to repository, or removed from repository.

Number

 

Team add events

Indicates the number of events of this type triggered when a repository was added to a team.

Number

 

Watch events

Indicates the number of events of this type triggered when a user starred a repository.

Number