GitLab plugin

For more information about what this plugin does and the data streams it retrieves, see:

GitLab

Monitor the CI/CD metrics from your GitLab environment.

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.

Before you start

Create a GitLab API Token

  1. Access a GitLab account with access to the target projects.
  2. Navigate to https://gitlab.com/-/profile/personal_access_tokens.
  3. Ensure the access is at least read_api and read_repository. Please note, read_user and read_registry are optional.
  4. Click the Create personal access token button.
  5. Copy the provided API token.

Configuring the data source

  1. Display name:
    Enter a name for your data source. This helps you to identify this data source in the list of your data sources.

  2. Instance URL:
    Enter a URL if you wish to use your own instance of GitLab.

    If you leave this section blank, https://gitlab.com will be used by default.

  3. API Token:
    Paste the API token in here.

  4. Optional: Restrict access to this data source:
    You can enable this option if you only want certain users or groups to have access to the data source, or the permission to link it to new workspaces. See data source access control for more information.

  5. Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method.

Next steps

Data streams

You can use these data streams to create new tiles to show data, or if there are preconfigured dashboards installed you can copy or edit those.

The following data streams are installed with this plugin.

Data stream
Description
All Pipeline Stage Status
All Pipelines and their Stage Status' for a project
Availability
Displays the availability of a environment
Open Issues
Displays the open issues of a project
Open Merge Requests
Displays the open merge requests of a project
Pipeline failures
Displays the failures of a project
Scope Data
Displays the general data of objects
Status
Displays the health of a Pipeline or Deployment

Configurable data streams

The following data streams have configurable Parameters.

Data stream
Description
Parameters
GQL Query
Enter a Graph Query Language (GQL) query to fetch your GitLab data. GQL lets you execute multiple linear graph queries in one query.
  1. GQL Query:
    Enter your GQL query.
  2. RowPath:
    Optionally, focus on results within the GQL query. Target on the array of data that you want to display. For example: projects.nodes.

    This example query shows you how to get the details about the current user, the groups it has access to and the project IDs in those groups.
    query{
  currentUser{
    groups{
      nodes
      {
        projects {
          edges {
            node {
              id
              name
            }
          }
        }
        fullName
        id
      }
      
    }
    name
    id
  }
}

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket