GitHub

GitHub is a Git-based platform for version control and small-to-large scale project collaboration. Code can be hosted, searched, updated, reviewed, and more.

Observe helps you monitor the GitHub activity of your organizations with these features:

  • Datasets containing frequently-updated information about GitHub Action runs, commits, pull requests, releases, and issues for investigation of emergent issues.

  • Organizational data about repositories, users, and security and admin settings.

  • Dashboards for quickly checking the state of your organization.

  • The ability to tightly control permissions around the data included in your logs.

List of GitHub datasets generated in Observe.

Figure 1 - List of GitHub datasets in Observe

Viewing GitHub data in Observe

When you install the GitHub app, the app also installs default dashboards for monitoring and reviewing GitHub events. The following dashboards are installed by default:

  • GitHub/Actions

  • GitHub/Activity

  • GitHub/Administration

  • GitHub/Commits

  • GitHub/Issues

  • GitHub/Organizations

  • GitHub/Pull Request

  • GitHub/Release

  • GitHub/Repository

GitHub/Activity Dashboard

The GitHub/Activity dashboard provides a high-level overview of your organizational output, with information on the following activity:

  • Actions

  • Commits

  • Pull Requests

  • Releases

Activity dashboard for GitHub. You can see an overview of the organization, repository, conclusion, and author data.

Figure 2 - GitHub Activity dashboard

Use the dashboard for debugging and troubleshooting as well as viewing the activity in your GitHub organization within a time window. Use it to answer questions such as:

  • Which Action runs are failing or hanging?

  • Were there any force pushed commits around the time of an emergent issue?

  • Did any new releases get created during a specific timeframe?

  • Did any pull requests merge during a specific timeframe?

GitHub/Administration Dashboard

Get an overview of your organizations for administrative and security purposes, with insights for the following:

  • Organizations

  • Repositories

  • Issues

  • Members

Administration dashboard for GitHub.

Figure 3 - GitHub/Administration dashboard

From the dashboard, you see an overview of your organization members, repositories, following/followers, and disk usage. As well as recently created and updated repository information, and recently created issues.

GitHub/Issues Dashboard

Review the GitHub/Issues dashboard for open and closed GitHub/Issues occurring in your GitHub repositories.

Issues dashboard for GitHub.

Figure 4 - GitHub/Issues dashboard

Setup

The GitHub App ingests data using webhooks and the Observe API poller. To install and configure data collection, see the GitHub Installation Guide.

After configuration, data from GitHub populates the datasets and boards and displays information about all of your organizations.