Skip to main content
Sumo Logic

Install the GitHub App and view the Dashboards

The GitHub App provides pre-configured Dashboards that give you a full view of your GitHub repository events.

Install the Sumo Logic App

Now that you have set up collector GitHub, install the Sumo Logic App for GitHub to use the preconfigured searches and dashboards that to analyze your data.

To install the app:

  1. Select App Catalog, search for and select the app, and click Add to Library. (In the classic UI, click Library, click Apps, select the app, and click Install. If you don't find the app under Apps, it might be a preview app. Try clicking Preview to find the app.)
  2. Click Preview Dashboards if you'd like to see a preview of the dashboards included with the app before installing.
  3. In the Install Application dialog box, select the installation path (the default is the Personal folder in the library), or click New Folder to add a new folder.
  4. Select either of these options for the log data source.
  • Choose Select from Existing Source Categories, and select the source catalog from the Source Category list.
  • Choose Enter a Custom Data Filter and enter a custom source category beginning with an underscore. Example: (_sourceCategory=MyCategory).
  1. Click Add to Library.

Once an app is installed, it will appear in your Personal folder, or other folder that you specified. From here, you can share it with your organization. See Welcome to the New Library for information on working with the library in the new UI.

Panels will start to fill automatically. It's important to note that each Panel slowly fills with data matching the time range query and received since the Panel was created. Results won't immediately be available, but with a bit of time, you'll see full graphs and maps. 

Dashboards

​GitHub - Overview

Commits

Commits Over Time. Displays the number of commits over time as a line chart on a timeline for the last seven days.

Commits by Repository. Shows details of commits by repository in a pie chart for the last  seven days.

Top 10 Users by Commit. Tracks the top 10 users by number of commits as a bar chart for the last seven days.

Pull Requests

Pull Requests Opened Over Time. Displays the number of pull requests opened over time as a line chart on a timeline for the last seven days.

Pull Requests Opened by Repository. Provides details on the number of pull requests opened by repository as a stacked column chart for the last seven days.

Pull Requests Still Opened. Shows details on pull requests that were opened since ingestion in a table chart including the ID, title, user, repo name, and date created for the last six hours. repo name, and date created for the last six hours.

Issues

Issues Opened, Closed Over Time. Displays the number of issues that have been opened and closed over time as an area chart on a timeline for the last seven days.

Issues Opened, Closed, and Reopened by Repository. Shows details about the number of issues that were opened, closed, and reopened by repository as a stacked column chart for the last seven days.

Issues Still Opened. Shows details on issues that have existed the longest in a table chart including the ID, title, state, and date created for the last six hours.

GitHub - Branch Overview

Files Added per Branch. Displays the number of files added per branch by user in a line chart on a timeline for the last three days.

Files Deleted per Branch. Shows the number of files added per branch by user in a line chart on a timeline for the last three days.

Commits per Branch. Provides the number of commits per branch by user in a line chart on a timeline for the last three days.

Files Modified per Branch. Displays the number of files modified per branch by user in a line chart on a timeline for the last three days.

GitHub - Issue Overview

Total Number of Open Issues. Displays the number of open issues per repository in a column chart for the last six hours. (Should this be on a timeline?)

Latest Open Issues. Provides details on the latest open issues in a table, including ID, title, created date, user, and state of the issue for the last six hours.

Oldest Open Issues. Shows details on the oldest open issues in a table, including ID, title, created date, user, and state of the issue for the last six hours.

Latest Closed Issues. Displays details on the most recently closed issues in a table, including details on ID, title, close date, user, and state for the last six hours.

Latest Reopened Issues. Shows details on the latest reopened issues in a table, including details on ID, title, update date, user, and state for the last six hours.

Unassigned Issues. Provides details on all unassigned issues including ID, title, created date, user, and state for the last three days.

Top 10 Issue Closers. Tracks the top 10 users who have closed issues in a column chart by user for the last 24 hours.

Top 10 Issue Reporters. Tracks the top 10 users who have reported issues in a column chart by user for the last 24 hours.

GitHub - Pull Request Overview

 

Files Changed, Lines Added, Deleted per Pull Request. Displays details of the files that have been changed with added lines, or deleted per pull request in a table including the ID, title, user, number of lines added, number of lines deleted, and the number of changed files for the last three days.

Review Comments on Pull Request. Shows details on the review comments added to pull requests in a table, including the ID, title, and count for the last three days.

Pull Requests Opened and Merged. Provides information on pull requests that have been opened, merged, and closed in a stacked column chart for the last three days. 

Pull Requests Opened Since Ingestion. Displays the pull requests that have been opened since ingestion in a table including details on the ID, title, state, user, and created time for the last six hours.

Pull Requests Closed and Not Merged. Lists the pull requests that were closed and not merged in a table, including details on the ID, title, repository name, created time, and user for the last three days.

GitHub - Security

Members Added, Removed. Displays details on members added and removed from the repository in a table chart including member name, action, team name, org login, and team permission for the last seven days.

Repositories Created. Shows information on new repositories created in a table chart including the repository name, sender login, and private setting for the last three days.

Teams Added to Repository. Provides details on teams added to the repository in a table chart including repository name, team name, and team permissions for the last seven days.

Fork Count by Repository Over Time. Displays the number of forks by repository over time in a column chart on a timeline for the last three days.

Private Repositories Made Public. Displays details on any private repositories that were made public in a table chart including the repository name, sender login, and owner login for the last three days.

Change in Team and Repository Access Permissions. Displays the change in team and repository access permissions in a table including details on ID, repository name, read, write, and admin permissions for the last 24 hours.

GitHub - User Activity

File Type Added by User. Displays the number and types of files added per user in a stacked bar chart for the last six hours.

Commits by User. Shows the number of commits per user in a bar chart for the last 24 hours.

Review Comments by User. Provides the number of review comments that users have left in the repository per user for the last 24 hours.

Files Changed per Pull Request. Displays the details of files changed in a pull request in a table, including the ID, title, user, and number of changed files for the last 24 hours.

Files Added per Branch. Shows the number and type of files added per branch by user in a stacked bar chart for the last 24 hours.