PRTG Manual: GitLab_Build_Status Sensor

Important Notice

This sensor type is deprecated. We provide the documentation in this section for your information only. We removed this sensor type from PRTG with version 21.1.65. Your sensor will then stop monitoring and show a Down status.

The GitLab Build Status sensor monitors the status of the latest build on one specific branch. You can monitor your builds in either your own GitLab environment or on gitlab.com.

z_i_square_cyanFor a detailed list and descriptions of the channels that this sensor can show, see section Channel List.

GitLab Build Status Sensor

GitLab Build Status Sensor

Sensor in Other Languages

  • Dutch: GitLab Build Status
  • French: État de build de GitLab
  • German: GitLab Buildstatus
  • Japanese: GitLab ビルドステータス
  • Portuguese: Estado do build no GitLab
  • Russian: Статус сборки GitLab
  • Simplified Chinese: GitLab 构建状态
  • Spanish: Estado de compilación de GitLab

Remarks

  • We strongly recommend that you use this sensor with care. This sensor has a high impact on the performance of your GitLab server. Do not add too many sensors of this type to your GitLab server, only monitor the most important branches.
  • This sensor can only monitor builds that are using GitLab Continuous Integration (CI). Builds using external CI tools (for example, Jenkins) are not supported.
  • This sensor uses the IP or Domain Name System (DNS) address of the parent device to find the GitLab server. To monitor branches in the GitLab cloud, enter gitlab.com as address in the settings of the parent device.
  • We do not recommend this sensor for temporarily existing branches. This is not useful in most cases.
  • This sensor supports the IPv6 protocol.
  • This sensor has a low performance impact.
  • This sensor uses lookups to determine the status values of one or more channels. This means that possible states are defined in a lookup file. You can change the behavior of a channel by editing the lookup file that the channel uses. For details, see section Define Lookups.

Add Sensor

The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the settings that are required to create the sensor. Therefore, you do not see all settings in this dialog. You can change nearly all settings on the sensor's Settings tab after creation.

The sensor requires an Access Token to access your projects on GitLab. Before you can actually create the sensor, it asks you for this token. You can create it on the GitLab web interface in your profile under Profile Settings | Access Token. Copy the created token and paste it into the GitLab Access Token field in the GitLab Credentials dialog of the sensor.

GitLab Repository

Setting

Description

Branch

Select the branches that you want to add a sensor for.

z_i_round_blueAdd check marks in front of the respective lines to select the items. Use the check box in the table header to select all items or to cancel the selection. In large tables, use the search function in the upper-right corner.

To better find what you want to monitor, particularly in large tables, use the search function in the upper-right corner. For example, you can filter for a specific project to only show related branches.

z_i_round_redThe sensor scans the last 100 builds of all projects during sensor creation (meta-scan). If you miss a branch in the overview, start a build on the branch that is missing and add the sensor anew.

Basic Sensor Settings

Click the Settings tab of a sensor to change its settings.

Basic Sensor Settings

Basic Sensor Settings

Setting

Description

Sensor Name

Enter a meaningful name to identify the sensor. By default, PRTG shows this name in the device tree, as well as in alarms, logs, notifications, reports, maps, libraries, and tickets.

z_i_round_blueIf the name contains angle brackets (<>), PRTG replaces them with braces ({}) for security reasons. For more information, see the Knowledge Base: What security features does PRTG include?

Parent Tags

Shows tags that the sensor inherits from its parent device, parent group, and parent probe.

z_i_round_blueThis setting is for your information only. You cannot change it.

Tags

Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited.

z_i_round_blueIt is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with parentheses (()) or angle brackets (<>).

The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:

  • gitlab

Priority

Select a priority for the sensor. This setting determines the position of the sensor in lists. The highest priority is at the top of a list. Choose from the lowest priority (z_i_priority_1) to the highest priority (z_i_priority_5).

GitLab Credentials

Setting

Description

GitLab Access Token

Enter the Access Token that you defined in your GitLab profile. You can create the token on the GitLab web interface in your profile under Profile Settings | Access Token.

By default, this field shows the access token that you provided during sensor creation.

GitLab Repository

Setting

Description

Project ID

These fields show various information about the project and branch that this sensor monitors.

Project Name

Branch

Sensor Display

Setting

Description

Primary Channel

Select a channel from the list to define it as the primary channel. In the device tree, the last value of the primary channel is always displayed below the sensor's name. The available options depend on what channels are available for this sensor.

z_i_round_blueYou can set a different primary channel later by clicking z_b_channel_primary below a channel gauge on the sensor's Overview tab.

Graph Type

Define how different channels are shown for this sensor:

  • Show channels independently (default): Show a graph for each channel.
  • Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This generates a graph that visualizes the different components of your total traffic.
    z_i_round_redYou cannot use this option in combination with manual Vertical Axis Scaling (available in the channel settings).

Stack Unit

This setting is only visible if you enable Stack channels on top of each other as Graph Type. Select a unit from the list. All channels with this unit are stacked on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so.

Inherited Settings

By default, all of the following settings are inherited from objects that are higher in the hierarchy. We recommend that you change them centrally in the root group settings if necessary. To change a setting for this object only, click z_b_inherited_enabled under the corresponding setting name to disable the inheritance and to display its options.

z_i_square_cyanFor more information, see section Inheritance of Settings.

Scanning Interval

Click z_b_inherited_enabled to interrupt the inheritance.

Setting

Description

Scanning Interval

Select a scanning interval from the dropdown list. The scanning interval determines the amount of time that the sensor waits between two scans. Choose from:

  • 30 seconds
  • 60 seconds
  • 5 minutes
  • 10 minutes
  • 15 minutes
  • 30 minutes
  • 1 hour
  • 4 hours
  • 6 hours
  • 12 hours
  • 24 hours

z_i_round_blueYou can change the available intervals in the system administration on PRTG on premises installations.

If a Sensor Query Fails

Select the number of scanning intervals that the sensor has time to reach and to check a device again if a sensor query fails. Depending on the option that you select, the sensor can try to reach and to check a device again several times before the sensor shows the Down status. This can avoid false alarms if the monitored device only has temporary issues. For previous scanning intervals with failed requests, the sensor shows the Warning status. Choose from:

  • Set sensor to down immediately: Set the sensor to the Down status immediately after the first request fails.
  • Set sensor to warning for 1 interval, then set to down (recommended): Set the sensor to the Warning status after the first request fails. If the second request also fails, the sensor shows the Down status.
  • Set sensor to warning for 2 intervals, then set to down: Set the sensor to the Down status only after the third request fails.
  • Set sensor to warning for 3 intervals, then set to down: Set the sensor to the Down status only after the fourth request fails.
  • Set sensor to warning for 4 intervals, then set to down: Set the sensor to the Down status only after the fifth request fails.
  • Set sensor to warning for 5 intervals, then set to down: Set the sensor to the Down status only after the sixth request fails.

z_i_round_blueSensors that monitor via Windows Management Instrumentation (WMI) always wait at least one scanning interval before they show the Down status. It is not possible to immediately set a WMI sensor to the Down status, so the first option does not apply to these sensors. All other options can apply.

z_i_round_blueIf you define error limits for a sensor's channels, the sensor immediately shows the Down status. None of the interval options apply.

z_i_round_blueIf a channel uses lookup values, the sensor immediately shows the Down status. None of the interval options apply.

Schedules, Dependencies, and Maintenance Windows

z_i_round_blueYou cannot interrupt the inheritance for schedules, dependencies, and maintenance windows. The corresponding settings from the parent objects are always active. However, you can define additional schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.

Setting

Description

Schedule

Select a schedule from the list. You can use schedules to monitor during a certain time span (days or hours) every week. Choose from:

  • None
  • Saturdays
  • Sundays
  • Weekdays
  • Weekdays Eight-To-Eight (08:00 - 20:00)
  • Weekdays Nights (17:00 - 09:00)
  • Weekdays Nights (20:00 - 08:00)
  • Weekdays Nine-To-Five (09:00 - 17:00)
  • Weekends

z_i_round_blueYou can create schedules, edit schedules, or pause monitoring for a specific time span. For more information, see section Schedules.

Maintenance Window

Select if you want to set up a one-time maintenance window. During a maintenance window, monitoring stops for the selected object and all child objects. They show the Paused status instead. Choose between:

  • Do not set up a one-time maintenance window: Do not set up a one-time maintenance window. Monitoring is always active.
  • Set up a one-time maintenance window: Set up a one-time maintenance window and pause monitoring. You can define a time span for the pause below.

z_i_round_blueTo terminate an active maintenance window before the defined end date, change the time entry in Maintenance Ends to a date in the past.

Maintenance Begins

This setting is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the start date and time of the one-time maintenance window.

Maintenance Ends

This setting is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the end date and time of the one-time maintenance window.

Dependency Type

Select a dependency type. You can use dependencies to pause monitoring for an object depending on the status of a different object. You can choose from:

  • Use parent: Use the dependency type of the parent object.
  • Select a sensor: Use the dependency type of the parent object. Additionally, pause the current object if a specific sensor is in the Down status or in the Paused status because of another dependency.
  • Master sensor for parent: Make this sensor the master object for its parent device. The sensor influences the behavior of its parent device: If the sensor is in the Down status, the device is paused. For example, it is a good idea to make a Ping sensor the master object for its parent device to pause monitoring for all other sensors on the device in case the device cannot even be pinged. Additionally, the sensor is paused if the parent group is paused by another dependency.

z_i_round_blueTo test your dependencies, select Simulate Error Status from the context menu of an object that other objects depend on. A few seconds later, all dependent objects are paused. You can check all dependencies under Devices | Dependencies in the main menu bar.

Dependency

This setting is only visible if you enable Select a sensor above. Click z_b_search_light and use the object selector to select a sensor on which the current object will depend.

Dependency Delay (Sec.)

This setting is only visible if you enable Select a sensor above. Define a time span in seconds for the dependency delay.

After the master sensor for this dependency returns to the Up status, PRTG additionally delays the monitoring of the dependent objects by the time span you define. This can prevent false alarms, for example, after a server restart or to give systems more time for all services to start. Enter an integer.

z_i_round_redThis setting is not available if you set this sensor to Use parent or to be the Master sensor for parent. In this case, define delays in the parent device settings or in its parent group settings.

Access Rights

Click z_b_inherited_enabled to interrupt the inheritance.

Setting

Description

User Group Access

Define the user groups that have access to the sensor. You see a table with user groups and group access rights. The table contains all user groups in your setup. For each user group, you can choose from the following group access rights:

  • Inherited: Inherit the access rights settings of the parent object.
  • No access: Users in this user group cannot see or edit the sensor. The sensor neither shows up in lists nor in the device tree.
  • Read access: Users in this group can see the sensor and view its monitoring results. They cannot edit any settings.
  • Write access: Users in this group can see the sensor, view its monitoring results, and edit its settings. They cannot edit its access rights settings.
  • Full access: Users in this group can see the sensor, view its monitoring results, edit its settings, and edit its access rights settings.

z_i_square_cyanFor more details on access rights, see section Access Rights Management.

Channel Unit Configuration

Click z_b_inherited_enabled to interrupt the inheritance.

Setting

Description

Channel Unit Types

For each type of channel, select the unit in which PRTG displays the data. If you define this setting on probe, group, or device level, you can inherit these settings to all sensors underneath. You can set units for the following channel types (if available):

  • Bandwidth
  • Memory
  • Disk
  • File
  • Custom

z_i_round_blueCustom channel types are only available on sensor level.

Channel List

z_i_round_blueWhich channels the sensor actually shows might depend on the monitored device, the available components, and the sensor setup.

Channel

Description

Build Duration

The duration of the last build

Downtime

In the channel table on the Overview tab, this channel never shows any values. PRTG uses this channel in graphs and reports to show the amount of time in which the sensor was in the Down status in percent.

Overall Status

The overall status of the last build

  • Up status: Created, Pending, Running, Success
  • Warning status: Canceled
  • Down status: Failed
  • Unknown status: None

z_i_round_blueThis channel is the primary channel by default.

[Build Step]

The status of the build steps

  • Up status: Created, Pending, Running, Success
  • Warning status: Canceled
  • Down status: Failed
  • Unknown status: None

Time Since Last Build

The time since the last build

More

z_i_square_blueKNOWLEDGE BASE

What security features does PRTG include?

Sensor Settings Overview

For more information about sensor settings, see the following sections: