- Basic troubleshooting
- Fixing errors found when running the Geo check rake task
- Fixing replication errors
- Message: “ERROR: replication slots can only be used if max_replication_slots > 0”?
- Message: “FATAL: could not start WAL streaming: ERROR: replication slot “geo_secondary_my_domain_com” does not exist”?
- Message: “Command exceeded allowed execution time” when setting up replication?
- Message: “PANIC: could not write to file ‘pg_xlog/xlogtemp.123’: No space left on device”
- Very large repositories never successfully synchronize on the secondary node
- Resetting Geo secondary node replication
- Fixing Foreign Data Wrapper errors
- Expired artifacts
- Fixing sign in errors
- Fixing common errors
- Geo database configuration file is missing
- An existing tracking database cannot be reused
- Geo node has a database that is writable which is an indication it is not configured for replication with the primary node
- Geo node does not appear to be replicating the database from the primary node
- Geo database version (…) does not match latest migration (…)
- Geo database is not configured to use Foreign Data Wrapper
- GitLab indicates that more than 100% of repositories were synced
- Geo Admin Area returns 404 error for a secondary node
Setting up Geo requires careful attention to details and sometimes it’s easy to miss a step.
Here is a list of steps you should take to attempt to fix problem:
- Perform basic troubleshooting.
- Fix any replication errors.
- Fix any Foreign Data Wrapper errors.
- Fix any common errors.
Before attempting more advanced troubleshooting:
Visit the primary node’s Admin Area > Geo (
your browser. We perform the following health checks on each secondary node
to help identify if something is wrong:
- Is the node running?
- Is the node’s secondary database configured for streaming replication?
- Is the node’s secondary tracking database configured?
- Is the node’s secondary tracking database connected?
- Is the node’s secondary tracking database up-to-date?
For information on how to resolve common errors reported from the UI, see Fixing Common Errors.
If the UI is not working, or you are unable to log in, you can run the Geo health check manually to get this information as well as a few more details.
This rake task can be run on an app node in the primary or secondary Geo nodes:
sudo gitlab-rake gitlab:geo:check
Checking Geo ... GitLab Geo is available ... yes GitLab Geo is enabled ... yes GitLab Geo secondary database is correctly configured ... yes Database replication enabled? ... yes Database replication working? ... yes GitLab Geo tracking database is configured to use Foreign Data Wrapper? ... yes GitLab Geo tracking database Foreign Data Wrapper schema is up-to-date? ... yes GitLab Geo HTTP(S) connectivity ... * Can connect to the primary node ... yes HTTP/HTTPS repository cloning is enabled ... yes Machine clock is synchronized ... yes Git user has default SSH configuration? ... yes OpenSSH configured to use AuthorizedKeysCommand ... yes GitLab configured to disable writing to authorized_keys file ... yes GitLab configured to store new projects in hashed storage? ... yes All projects are in hashed storage? ... yes Checking Geo ... Finished
Current sync information can be found manually by running this rake task on any secondary app node:
sudo gitlab-rake geo:status
http://secondary.example.com/ ----------------------------------------------------- GitLab Version: 11.10.4-ee Geo Role: Secondary Health Status: Healthy Repositories: 289/289 (100%) Verified Repositories: 289/289 (100%) Wikis: 289/289 (100%) Verified Wikis: 289/289 (100%) LFS Objects: 8/8 (100%) Attachments: 5/5 (100%) CI job artifacts: 0/0 (0%) Repositories Checked: 0/289 (0%) Sync Settings: Full Database replication lag: 0 seconds Last event ID seen from primary: 10215 (about 2 minutes ago) Last event ID processed by cursor: 10215 (about 2 minutes ago) Last status report was: 2 minutes ago
To check if PostgreSQL replication is working, check if:
You should make sure your primary Geo node points to the instance with writing permissions.
Any secondary nodes should point only to read-only instances.
Geo finds the current machine’s name in
- Using the
- If that is not defined, using the
To get a machine’s name, run:
sudo gitlab-rails runner "puts GeoNode.current_node_name"
This name is used to look up the node with the same Name in Admin Area > Geo.
To check if current machine is correctly finding its node:
sudo gitlab-rails runner "puts Gitlab::Geo.current_node.inspect"
and expect something like:
#<GeoNode id: 2, schema: "https", host: "gitlab.example.com", port: 443, relative_url_root: "", primary: false, ...>
By running the command above,
primary should be
true when executed in
the primary node, and
false on any secondary node.
When running this rake task, you may see errors if the nodes are not properly configured:
sudo gitlab-rake gitlab:geo:check
Rails did not provide a password when connecting to the database
Checking Geo ... GitLab Geo is available ... Exception: fe_sendauth: no password supplied GitLab Geo is enabled ... Exception: fe_sendauth: no password supplied ... Checking Geo ... Finished
- Ensure that you have the
gitlab_rails['db_password']set to the plain text-password used when creating the hash for
- Ensure that you have the
Rails is unable to connect to the database
Checking Geo ... GitLab Geo is available ... Exception: FATAL: no pg_hba.conf entry for host "22.214.171.124", user "gitlab", database "gitlabhq_production", SSL on FATAL: no pg_hba.conf entry for host "126.96.36.199", user "gitlab", database "gitlabhq_production", SSL off GitLab Geo is enabled ... Exception: FATAL: no pg_hba.conf entry for host "188.8.131.52", user "gitlab", database "gitlabhq_production", SSL on FATAL: no pg_hba.conf entry for host "184.108.40.206", user "gitlab", database "gitlabhq_production", SSL off ... Checking Geo ... Finished
- Ensure that you have the IP address of the rails node included in
- Ensure that you have included the subnet mask on the IP address:
postgresql['md5_auth_cidr_addresses'] = ['220.127.116.11/32'].
- Ensure that you have the IP address of the rails node included in
Rails has supplied the incorrect password
Checking Geo ... GitLab Geo is available ... Exception: FATAL: password authentication failed for user "gitlab" FATAL: password authentication failed for user "gitlab" GitLab Geo is enabled ... Exception: FATAL: password authentication failed for user "gitlab" FATAL: password authentication failed for user "gitlab" ... Checking Geo ... Finished
- Verify the correct password is set for
gitlab_rails['db_password']that was used when creating the hash in
gitlab-ctl pg-password-md5 gitlaband entering the password.
- Verify the correct password is set for
Check returns not a secondary node
Checking Geo ... GitLab Geo is available ... yes GitLab Geo is enabled ... yes GitLab Geo secondary database is correctly configured ... not a secondary node Database replication enabled? ... not a secondary node ... Checking Geo ... Finished
- Ensure that you have added the secondary node in the admin area of the primary node.
- Ensure that you entered the
gitlab_rails['geo_node_name']when adding the secondary node in the admin are of the primary node.
- Prior to GitLab 12.4, edit the secondary node in the admin area of the primary node and ensure that there is a trailing
Check returns Exception: PG::UndefinedTable: ERROR: relation “geo_nodes” does not exist
Checking Geo ... GitLab Geo is available ... no Try fixing it: Upload a new license that includes the GitLab Geo feature For more information see: https://about.gitlab.com/features/gitlab-geo/ GitLab Geo is enabled ... Exception: PG::UndefinedTable: ERROR: relation "geo_nodes" does not exist LINE 8: WHERE a.attrelid = '"geo_nodes"'::regclass ^ : SELECT a.attname, format_type(a.atttypid, a.atttypmod), pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod, c.collname, col_description(a.attrelid, a.attnum) AS comment FROM pg_attribute a LEFT JOIN pg_attrdef d ON a.attrelid = d.adrelid AND a.attnum = d.adnum LEFT JOIN pg_type t ON a.atttypid = t.oid LEFT JOIN pg_collation c ON a.attcollation = c.oid AND a.attcollation <> t.typcollation WHERE a.attrelid = '"geo_nodes"'::regclass AND a.attnum > 0 AND NOT a.attisdropped ORDER BY a.attnum ... Checking Geo ... Finished
When performing a Postgres major version (9 > 10) update this is expected. Follow:
The following sections outline troubleshooting steps for fixing replication errors.
This means that the
max_replication_slots PostgreSQL variable needs to
be set on the primary database. In GitLab 9.4, we have made this setting
default to 1. You may need to increase this value if you have more
Be sure to restart PostgreSQL for this to take effect. See the PostgreSQL replication setup guide for more details.
Message: “FATAL: could not start WAL streaming: ERROR: replication slot “geo_secondary_my_domain_com” does not exist”?
This occurs when PostgreSQL does not have a replication slot for the secondary node by that name.
You may want to rerun the replication process on the secondary node .
This may happen while initiating the replication process on the secondary node, and indicates that your initial dataset is too large to be replicated in the default timeout (30 minutes).
gitlab-ctl replicate-geo-database, but include a larger value for
sudo gitlab-ctl \ replicate-geo-database \ --host=<primary_node_hostname> \ --slot-name=<secondary_slot_name> \ --backup-timeout=21600
This will give the initial replication up to six hours to complete, rather than the default thirty minutes. Adjust as required for your installation.
Determine if you have any unused replication slots in the primary database. This can cause large amounts of
log data to build up in
pg_xlog. Removing the unused slots can reduce the amount of space used in the
Start a PostgreSQL console session:
sudo gitlab-psql gitlabhq_production
Note: Note: Using
gitlab-rails dbconsolewill not work, because managing replication slots requires superuser permissions.
View your replication slots with:
SELECT * FROM pg_replication_slots;
f are not active.
When this slot should be active, because you have a secondary node configured using that slot, log in to that secondary node and check the PostgreSQL logs why the replication is not running.
If you are no longer using the slot (e.g. you no longer have Geo enabled), you can remove it with in the PostgreSQL console session:
GitLab places a timeout on all repository clones, including project imports
and Geo synchronization operations. If a fresh
git clone of a repository
on the primary takes more than a few minutes, you may be affected by this.
To increase the timeout, add the following line to
on the secondary node:
gitlab_rails['gitlab_shell_git_timeout'] = 10800
Then reconfigure GitLab:
sudo gitlab-ctl reconfigure
This will increase the timeout to three hours (10800 seconds). Choose a time long enough to accommodate a full clone of your largest repositories.
If you get a secondary node in a broken state and want to reset the replication state, to start again from scratch, there are a few steps that can help you:
Stop Sidekiq and the Geo LogCursor
It’s possible to make Sidekiq stop gracefully, but making it stop getting new jobs and wait until the current jobs to finish processing.
You need to send a SIGTSTP kill signal for the first phase and them a SIGTERM when all jobs have finished. Otherwise just use the
gitlab-ctl status sidekiq # run: sidekiq: (pid 10180) <- this is the PID you will use kill -TSTP 10180 # change to the correct PID gitlab-ctl stop sidekiq gitlab-ctl stop geo-logcursor
You can watch Sidekiq logs to know when Sidekiq jobs processing have finished:
gitlab-ctl tail sidekiq
Rename repository storage folders and create new ones. If you are not concerned about possible orphaned directories and files, then you can simply skip this step.
mv /var/opt/gitlab/git-data/repositories /var/opt/gitlab/git-data/repositories.old mkdir -p /var/opt/gitlab/git-data/repositories chown git:git /var/opt/gitlab/git-data/repositoriesTip You may want to remove the
/var/opt/gitlab/git-data/repositories.oldin the future as soon as you confirmed that you don’t need it anymore, to save disk space.
(Optional) Rename other data folders and create new onesCaution: You may still have files on the secondary node that have been removed from primary node but removal have not been reflected. If you skip this step, they will never be removed from this Geo node.
Any uploaded content like file attachments, avatars or LFS objects are stored in a subfolder in one of the two paths below:
To rename all of them:
gitlab-ctl stop mv /var/opt/gitlab/gitlab-rails/shared /var/opt/gitlab/gitlab-rails/shared.old mkdir -p /var/opt/gitlab/gitlab-rails/shared mv /var/opt/gitlab/gitlab-rails/uploads /var/opt/gitlab/gitlab-rails/uploads.old mkdir -p /var/opt/gitlab/gitlab-rails/uploads gitlab-ctl start geo-postgresql
Reconfigure in order to recreate the folders and make sure permissions and ownership are correctly
Reset the Tracking Database
gitlab-rake geo:db:drop gitlab-ctl reconfigure gitlab-rake geo:db:setup
Restart previously stopped services
This section documents ways to fix potential Foreign Data Wrapper errors.
When setting up Geo, you might see this warning in the
GitLab Geo tracking database Foreign Data Wrapper schema is up-to-date? ... foreign data wrapper is not configured
There are a few key points to remember:
- The FDW settings are configured on the Geo tracking database.
- The configured foreign server enables a login to the Geo secondary, read-only database.
By default, the Geo secondary and tracking database are running on the same host on different ports. That is, 5432 and 5431 respectively.
To check the configuration:
Enter the database console:
Check whether any tables are present. If everything is working, you should see something like this:
gitlabhq_geo_production=# SELECT * from information_schema.foreign_tables; foreign_table_catalog | foreign_table_schema | foreign_table_name | foreign_server_catalog | foreign_server_name -------------------------+----------------------+-------------------------------------------------+-------------------------+--------------------- gitlabhq_geo_production | gitlab_secondary | abuse_reports | gitlabhq_geo_production | gitlab_secondary gitlabhq_geo_production | gitlab_secondary | appearances | gitlabhq_geo_production | gitlab_secondary gitlabhq_geo_production | gitlab_secondary | application_setting_terms | gitlabhq_geo_production | gitlab_secondary gitlabhq_geo_production | gitlab_secondary | application_settings | gitlabhq_geo_production | gitlab_secondary <snip>
However, if the query returns with
0 rows, then continue onto the next steps.
Check that the foreign server mapping is correct via
\des+. The results should look something like this:
gitlabhq_geo_production=# \des+ List of foreign servers -[ RECORD 1 ]--------+------------------------------------------------------------ Name | gitlab_secondary Owner | gitlab-psql Foreign-data wrapper | postgres_fdw Access privileges | "gitlab-psql"=U/"gitlab-psql" + | gitlab_geo=U/"gitlab-psql" Type | Version | FDW Options | (host '0.0.0.0', port '5432', dbname 'gitlabhq_production') Description |Note: Pay particular attention to the host and port under FDW options. That configuration should point to the Geo secondary database.
If you need to experiment with changing the host or password, the following queries demonstrate how:
ALTER SERVER gitlab_secondary OPTIONS (SET host '<my_new_host>'); ALTER SERVER gitlab_secondary OPTIONS (SET port 5432);
If you change the host and/or port, you will also have to adjust the following settings in
Check that the user mapping is configured properly via
gitlabhq_geo_production=# \deu+ List of user mappings Server | User name | FDW Options ------------------+------------+-------------------------------------------------------------------------------- gitlab_secondary | gitlab_geo | ("user" 'gitlab', password 'YOUR-PASSWORD-HERE') (1 row)
Make sure the password is correct. You can test that logins work by running
# Connect to the tracking database as the `gitlab_geo` user sudo \ -u git /opt/gitlab/embedded/bin/psql \ -h /var/opt/gitlab/geo-postgresql \ -p 5431 \ -U gitlab_geo \ -W \ -d gitlabhq_geo_production
If you need to correct the password, the following query shows how:
ALTER USER MAPPING FOR gitlab_geo SERVER gitlab_secondary OPTIONS (SET password '<my_new_password>');
If you change the user or password, you will also have to adjust the following settings in
If you are using PgBouncer in front of the secondary database, be sure to update the following settings:
If you’re still unable to get FDW working, you may want to try a manual reload of the FDW schema. To manually reload the FDW schema:
On the node running the Geo tracking database, enter the PostgreSQL console via the
sudo \ -u git /opt/gitlab/embedded/bin/psql \ -h /var/opt/gitlab/geo-postgresql \ -p 5431 \ -U gitlab_geo \ -W \ -d gitlabhq_geo_production
Be sure to adjust the port and hostname for your configuration. You may be asked to enter a password.
Reload the schema via:
DROP SCHEMA IF EXISTS gitlab_secondary CASCADE; CREATE SCHEMA gitlab_secondary; GRANT USAGE ON FOREIGN SERVER gitlab_secondary TO gitlab_geo; IMPORT FOREIGN SCHEMA public FROM SERVER gitlab_secondary INTO gitlab_secondary;
Test that queries work:
SELECT * from information_schema.foreign_tables; SELECT * FROM gitlab_secondary.projects limit 1;
GitLab can error with a
Geo database has an outdated FDW remote schema message.
Geo database has an outdated FDW remote schema. It contains 229 of 236 expected tables. Please refer to Geo Troubleshooting.
To resolve this, run the following command:
sudo gitlab-rake geo:db:refresh_foreign_tables
If you notice for some reason there are more artifacts on the Geo secondary node than on the Geo primary node, you can use the rake task to cleanup orphan artifact files.
On a Geo secondary node, this command will also clean up all Geo registry record related to the orphan files on disk.
If you are able to log in to the primary node, but you receive this error when attempting to log into a secondary, you should check that the Geo node’s URL matches its external URL.
- On the primary, visit Admin Area > Geo.
- Find the affected secondary and click Edit.
- Ensure the URL field matches the value found in
external_url "https://gitlab.example.com"on the frontend server(s) of the secondary node.
This section documents common errors reported in the Admin UI and how to fix them.
GitLab cannot find or doesn’t have permission to access the
database_geo.yml configuration file.
In an Omnibus GitLab installation, the file should be in
If it doesn’t exist or inadvertent changes have been made to it, run
sudo gitlab-ctl reconfigure to restore it to its correct state.
If this path is mounted on a remote volume, please check your volume configuration and that it has correct permissions.
Geo cannot reuse an existing tracking database.
It is safest to use a fresh secondary, or reset the whole secondary by following Resetting Geo secondary node replication.
Geo node has a database that is writable which is an indication it is not configured for replication with the primary node
This error refers to a problem with the database replica on a secondary node, which Geo expects to have access to. It usually means, either:
- An unsupported replication method was used (for example, logical replication).
- The instructions to setup a Geo database replication were not followed correctly.
A common source of confusion with secondary nodes is that it requires two separate PostgreSQL instances:
- A read-only replica of the primary node.
- A regular, writable instance that holds replication metadata. That is, the Geo tracking database.
The most common problems that prevent the database from replicating correctly are:
- Secondary nodes cannot reach the primary node. Check credentials, firewall rules, etc.
- SSL certificate problems. Make sure you copied
/etc/gitlab/gitlab-secrets.jsonfrom the primary node.
- Database storage disk is full.
- Database replication slot is misconfigured.
- Database is not using a replication slot or another alternative and cannot catch-up because WAL files were purged.
Make sure you follow the Geo database replication instructions for supported configuration.
If you are using GitLab Omnibus installation, something might have failed during upgrade. You can:
sudo gitlab-ctl reconfigure.
- Manually trigger the database migration by running:
sudo gitlab-rake geo:db:migrateas root on the secondary node.
This error means the Geo Tracking Database doesn’t have the FDW server and credentials configured.
This can be caused by orphaned records in the project registry. You can clear them using a Rake task.
sudo gitlab-rake gitlab:geo:check indicates that the secondary node is
healthy, but a 404 error for the secondary node is returned in the Geo Admin Area on
the primary node.
To resolve this issue:
- Try restarting the secondary using
sudo gitlab-ctl restart.
/var/log/gitlab/gitlab-rails/geo.logto see if the secondary node is using IPv6 to send its status to the primary node. If it is, add an entry to the primary node using IPv4 in the
/etc/hostsfile. Alternatively, you should enable IPv6 on the primary node.