Skip to main content
Sumo Logic

Install the GitHub App and view the Dashboards

  1. Last updated
  2. Save as PDF
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 to analyze your data.

To install the app:

Locate and install the app you need from the App Catalog. If you want to see a preview of the dashboards included with the app before installing, click Preview Dashboards.

  1. From the App Catalog, search for and select the app. 
  2. Select the version of the service you're using and click Add to Library.
  1. To install the app, complete the following fields.
    1. App Name. You can retain the existing name, or enter a name of your choice for the app.

    2. Data Source. Select either of these options for the data source.

      • Choose Source Category, and select a source category from the list.

      • Choose Enter a Custom Data Filter, and enter a custom source category beginning with an underscore. Example: (_sourceCategory=MyCategory).

    3. Advanced. Select the Location in Library (the default is the Personal folder in the library), or click New Folder to add a new folder.
  2. 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. 

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. 

Troubleshooting

If you are getting the following error after installing the App:

Field x-github-event not found, please check the spelling and try again.

Do the following to resolve:

  1. In Sumo Logic, click Manage Data > Logs > Fields and delete your x-github-event.

  2. Add it again using the Dropped Fields option.

github-troubleshooting.png

Dashboards

​GitHub - Overview

The GitHub - Overview dashboard provides an at-a-glance view of your GitHub issues, pull requests, and the commits over time.

Use this dashboard to:

  • Get an overview of Github commits, Pull Requests, and Issues.

GitHub - Overview.png

GitHub - Branch Overview

The GitHub - Branch Overview dashboard provides information about the commits, file operations like addition, deletion, and modifications per branch.

Use this dashboard to:

  • Review branch-specific details.
  • Identify the type of files being added, deleted, or modified.
  • Review the commit details.

Github -Branch Overview.png

GitHub - Issue Overview

The GitHub - Issue Overview dashboard provides detailed information about the issues opened, closed, and unassigned issues.

Use this dashboard to:

  • Review issue status including unassigned, open, and closed issues.
  • Quickly review the issue details and take action accordingly.

GitHub - Issue Overview.png

GitHub - Pull Request Overview

The GitHub - Pull Request Overview dashboard gives the view of pull requests by the target branch. It also provides a detailed view of the pull requests in comparison to created, merged, and declined.

Use this dashboard to:

  • View and review pull requests.
  • Review comments on pull requests.
  • Identify open and not merged critical pull requests.

GitHub-Pull Request Overview.png

GitHub - Security

The GitHub - Security dashboard provides detailed information on the security events and repositories.

Use this dashboard to:

  • Manage users.
  • Review and manage repositories.
  • View and manage teams.

GitHub-Security.png

GitHub - User Activity

The GitHub - User Activity dashboard provides detailed insight into all user activity and potential suspicious activities.

Use this dashboard to:

  • Review and manage user activity.
  • Determine files added, removed, and modified by users.
  • Identify any harmful file types added by users.

Github-User Activity.png