Skip to main content
Sumo Logic

Install the GitLab App and View Dashboards

Learn how to install the Sumo Logic GitLab App and review Dashboard options.

This section demonstrates how to install the GitLab App and view dashboards.

Install the App

To install the app, do the following:

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 the 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 another specified folder. From here, you can share it with your organization. 

Panels will start to fill automatically. 

Troubleshooting

If you are getting the following error in the app dashboards after installation: 

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

Do the following to resolve:

  1. Close all app dashboards.

  2. In Sumo Logic, click Manage Data > Logs > Fields and delete the x-gitlab-event field.

  3. Add it again using the Dropped Fields section:

    • At Dropped Fields drop-down, click on x-gitlab-event, then click Create Field to create the field. 

    • Wait for new events to be pushed from GitLab. The app should work without any "Field x-gitlab-event not found" errors.

      github-troubleshooting.png
      gitlab-troubleshooting.png

  4. Re-open GitLab dashboards.

Dashboards

GitLab - Overview

The GitLab - Overview dashboard provides users with a high-level view of events such as Issues, Merge Requests, Builds, Deployments, and pipelines. 

Use this dashboard to:

  • Get insight into the number of opened and closed Issues and Merge Requests. 

  • Get insight into the number of successful and failed Builds, Deployments, and Pipelines. 

  • Get details like average duration to close issue, the average duration of a build by project, and average duration of a pipeline by projects.

Gitlab-Overview.png

GitLab - Deployments 

The GitLab - Deployments dashboard provides users with a high-level view of activities such as deployments failed or success. 

Use this dashboard to:

  • Understand the number of deployments that failed or succeeded.

  • Get insight into failed deployments by project and environments.

  • Identify the Failed and Successful deployments in chronological order. You can use filters to drill down to a more detailed view.

Gitlab-Deployments.png

GitLab - Builds 

The GitLab - Builds dashboard provides users with a high-level view of activities such as builds failed or success. 

Use this dashboard to:

  • Understand the number of builds that failed or succeeded.

  • Identify the Failed and Successful deployments in chronological order. You can use filters to drill down to a more detailed view.

  • Get statistics of build duration by Repository, Project, Build Name, and Stage Name. 

Gitlab-Builds.png

GitLab - Pipeline 

The GitLab - Pipeline dashboard provides users with a high-level view of activities such as builds failed or success. 

Use this dashboard to:

  • Understand the number of pipelines that failed or succeeded.

  • Get insight into the average pipeline and job duration by project.

  • Identify the Failed and Successful pipelines in chronological order. You can use filters to drill down to a more detailed view.

  • Identify the Failed and Successful pipeline jobs in chronological order. You can use filters to drill down to a more detailed view.

Gitlab-Pipeline.png

GitLab - Merge Requests 

The GitLab - Merge Requests dashboard provides users with a high-level view of activities such as Merge Requests opened, closed, and merged. 

Use this dashboard to:

  • Understand the number of merge requests being opened, closed, and merged.

  • Get insight into open merge requests by project, repository, and creators 

  • Get insight into the average duration to merge requests by project, repository, and assignees.

  • Get the review comments on the merge requests.

  • Identify the Open, Reopened, Unassigned, and Closed merge requests in chronological order. You can use filters to drill down to a more detailed view.

Gitlab-Merge-Requests.png

GitLab - Commits

The GitLab - Commits dashboard provides users with a high-level view of activities such as files modified, added, and removed by commit. 

Use this dashboard to:

  • Get insight into the total number of commits by branch, project, repository, and user. 

  • Identify the Modified, Added, and Removed files by commit id in chronological order. You can use filters to drill down to a more detailed view.

Gitlab-Commits.png