doc/administration/admin_area.md
{{< details >}}
{{< /details >}}
The Admin area provides a web UI to manage and configure features of a GitLab Self-Managed instance. If you are an administrator, to access the Admin area:
If the GitLab instance uses Admin Mode, you must enable Admin Mode for your session before Admin is visible.
[!note] Only administrators on GitLab Self-Managed or GitLab Dedicated can access the Admin area. On GitLab.com, the Admin area feature is not available.
{{< history >}}
admin_projects_vue. Disabled by default.admin_projects_vue removed.{{< /history >}}
To administer all projects in the GitLab instance:
In the upper-right corner, select Admin.
Select Overview > Projects. The page shows each project's:
Optional. Select a tab:
Optional. Combine filters to find your desired projects. Filter by:
Optional. To change the sort order, select the sort dropdown list and choose the desired order. The available sort options are:
To edit a project's name or description from the Admin area's Projects page:
To delete a project:
{{< history >}}
{{< /history >}}
The Admin area's Users page shows this information for each user:
To administer all users from the Admin area's Users page:
In the upper-right corner, select Admin.
Select Overview > Users.
Optional. To change the sort order, which defaults to user name:
Optional. Use the user search box to search and filter users by:
Optional. In the user search field, enter text, then press <kbd>Enter</kbd>. This case-insensitive text search applies partial matching to name, username, and email.
To edit a user, find the user's row and select Edit.
To delete the user, or delete the user and their contributions, from the Admin area's Users page:
An administrator can impersonate any other user, including other administrators. This enables you to see what the user sees in GitLab, and take actions on behalf of the user.
To impersonate a user:
All impersonation activities are captured with audit events. By default, impersonation is enabled. GitLab can be configured to disable impersonation.
{{< details >}}
{{< /details >}}
{{< history >}}
{{< /history >}}
When using authentication providers, administrators can see the identities for a user. This page shows the user's identities, including SCIM identities. Use this information to troubleshoot SCIM-related issues and confirm the identities being used for an account.
To do this:
{{< details >}}
{{< /details >}}
When you export user permissions, the exported information shows the direct membership users have in groups and projects. It includes this data, and is limited to the first 100,000 users:
To export user permissions for all active users in your GitLab instance:
The Users statistics page provides an overview of user accounts by role. These statistics are calculated daily. User changes made after the last update are not reflected. These totals are also included:
GitLab billing is based on the number of billable users.
To add email addresses to user accounts manually:
The Cohorts tab displays the monthly cohorts of new users and their activities over time.
Administrators can prevent specific users from creating top-level groups. These users can still create subgroups and collaborate in existing organizational structures.
To prevent a user from creating top-level groups:
After you turn off this setting:
{{< history >}}
admin_groups_vue. Disabled by default.admin_groups_vue removed.{{< /history >}}
[!flag] The availability of this feature is controlled by a feature flag. For more information, see the history.
To administer all groups in the GitLab instance:
In the upper-right corner, select Admin.
Select Overview > Groups. The page shows each group's:
Optional. Select a tab:
Optional. To change the sort order, select the sort dropdown list and choose the desired order. The available sort options are:
Optional. To filter groups by name, in the search bar, enter at least three characters.
Optional. To create a new group select New group.
To edit a group's name or description from the Admin area's Groups page:
To delete a group:
{{< details >}}
{{< /details >}}
Categorize and find similar projects with topics.
To view all topics in the GitLab instance:
For each topic, the page displays its name and the number of projects labeled with the topic.
To create a topic:
The created topics are displayed on the Explore topics page.
The assigned topics are visible only to everyone with access to the project, but everyone can see which topics exist on the GitLab instance. Do not include sensitive information in the name of a topic.
You can edit a topic's name, title, description, and avatar at any time. To edit a topic:
If you no longer need a topic, you can permanently remove it. To remove a topic:
You can move all projects assigned to a topic to another topic. The source topic is then permanently deleted. After a merged topic is deleted, you cannot restore it.
To merge topics:
You can list all Gitaly servers in the GitLab instance from the Admin area's Gitaly servers page. For more details, see Gitaly.
To access the Gitaly servers page:
The page includes this information about each Gitaly server:
| Field | Description |
|---|---|
| Storage | Repository storage |
| Address | Network address on which the Gitaly server is listening |
| Server version | Gitaly version |
| Git version | Version of Git installed on the Gitaly server |
| Up to date | Indicates if the Gitaly server version is the latest version available. A green dot indicates the server is up to date. |
{{< history >}}
ui_for_organizations. Disabled by default.{{< /history >}}
[!flag] On GitLab Self-Managed, by default this feature is not available. To make it available, an administrator can enable the feature flag named
ui_for_organizations. On GitLab.com and GitLab Dedicated, this feature is not available. This feature is not ready for production use.
The Organizations page in the Admin area lists all projects by default, in reverse order of when they were last updated. Each project shows:
To administer all organizations in the GitLab instance from this page:
{{< history >}}
{{< /history >}}
To administer all runners in the GitLab instance:
This information is shown for each runner:
| Attribute | Description |
|---|---|
| Status | The status of the runner. In GitLab 15.1 and later, for the Ultimate tier, the upgrade status is available. |
| Runner details | Information about the runner, including partial token and details about the computer the runner was registered from. |
| Version | GitLab Runner version. |
| Jobs | Total number of jobs run by the runner. |
| Tags | Tags associated with the runner. |
| Last contact | Timestamp indicating when the runner last contacted the GitLab instance. |
You can also edit, pause, or remove each runner.
For more information, see GitLab Runner.
To search runners' descriptions:
To filter runners by status, type, and tag:
{{< history >}}
{{< /history >}}
To delete multiple runners at the same time:
{{< history >}}
{{< /history >}}
To administer all jobs in the GitLab instance:
For each job, the following details are listed:
| Field | Description |
|---|---|
| Status | Job status. One of passed, skipped, or failed. |
| Job | Includes links to the job, branch, and the commit that started the job. |
| Pipeline | Includes a link to the specific pipeline. |
| Project | Name of the project, and organization, to which the job belongs. |
| Runner | Name of the CI runner assigned to execute the job. |
| Stage | Stage that the job is declared in a .gitlab-ci.yml file. |
| Name | Name of the job specified in a .gitlab-ci.yml file. |
| Timing | Duration of the job, and how long ago the job completed. |
| Coverage | Percentage of tests coverage. |
The following topics document the Monitoring section of the Admin area.
{{< history >}}
{{< /history >}}
The System information page provides the following statistics:
| Field | Description |
|---|---|
| CPU | Number of CPU cores available |
| Memory Usage | Memory in use, and total memory available |
| Disk Usage | Disk space in use, and total disk space available |
| System started | When the system hosting GitLab was started. In GitLab 15.1 and earlier, this was an uptime statistic. |
These statistics are updated only when you go to the System information page, or you refresh the page in your browser.
The Background jobs page displays the Sidekiq dashboard. Sidekiq is used by GitLab to perform background processes.
The Sidekiq dashboard contains:
{{< history >}}
{{< /history >}}
The Data management page provides a comprehensive interface to view and manage verification status across all components on a Geo primary site. The components include all data types supported by Geo.
Use this page to:
The list view displays verification status for a selected component.
Choose a component from the dropdown list to switch between different verification models (Projects, Uploads, etc.). From the list view, you can:
Select an individual model from the list view to see comprehensive information about a specific object's verification status, like:
{{< history >}}
{{< /history >}}
The database diagnostics page consists of a number of checks that attempt to flag common problems with the database:
To run each check, select the run button for the check. Selecting the run button schedules a background job that will report information from the check to the page.
The collation health check attempts to detect PostgreSQL issues that
result in corrupted indexes. This commonly happens if the previous
operating system running PostgreSQL used a version of glibc earlier than
version 2.28. For more information, see the documentation about
upgrading operating systems for PostgreSQL.
Any issues are listed in a Corrupted Indexes section. If you have issues, you can repair corrupted indexes.
The collation health check also attempts to flag duplicates on commonly-affected tables:
ci_refsci_resource_groupsenvironmentsmerge_request_diff_commit_userssbom_componentstagstopicsFor more information, see issue 505982.
The dashboard lists the identical information shown in the
gitlab:db:collation_checker Rake task.
The schema health check compares the state of the database against the target schema and lists detected discrepancies. No automated schema repair tool is available.
If you notice any false positives or have any questions about the results of the check, see the feedback issue.
The contents of these log files can help troubleshoot a problem. The content of each log file is listed in chronological order. To minimize performance issues, a maximum 2000 lines of each log file are shown.
| Log file | Contents |
|---|---|
application_json.log | GitLab user activity |
git_json.log | Failed GitLab interaction with Git repositories |
production.log | Requests received from Puma, and the actions taken to serve those requests |
sidekiq.log | Background jobs |
repocheck.log | Repository activity |
integrations_json.log | Activity between GitLab and integrated systems |
kubernetes.log | Kubernetes activity |
For details of these log files and their contents, see Log system.
The Log view has been removed from the Admin area dashboard to prevent confusion for administrators of multi-node systems. This view presents partial information for multi-node setups. For multi-node systems, ingest the logs into services like Elasticsearch and Splunk.
{{< details >}}
{{< /details >}}
The Audit events page lists changes made to the GitLab server. Use this information to control, analyze, and track every change.
The Instance overview section of the Dashboard lists the current statistics of the GitLab instance. Retrieve this information with the Application statistics API.
These statistics show exact counts for values less than 10,000. For values of 10,000 and higher,
these statistics show approximate data
when TablesampleCountStrategy and
ReltuplesCountStrategy
strategies are used for calculations.