Latest revision as of 06:16, 7 July 2023

Other languages:

English • ‎中文 • ‎日本語

Sometimes, when your account is syncing, the sync status as shown on the dashboard will stick at various percentages(0% and 10% are common). This indicates that there was a problem while syncing that is halting or pausing the sync process. This guide aims to aid you in resolving a stuck sync. Please follow each step.

Ensure you're reading the right guide

First, We have multiple guides for Sync related matters, please ensure you are reading the correct one for your problem, if you sync is not stuck or you're experiencing some other sync issue please see Sync Errors BEFORE you start.

These problems are slightly different and may require differing steps, so we've split them into separate guides.

DO NOT

Delete your Neos data/database or cache files. Doing this will likely make you lose your unsynced items, and can cause other side effects
Try to save and sync any more items/worlds. Doing this will add to your sync queue and if your items/worlds are not syncing properly.
Click "Exit & Save Homes". Doing this will also add to your sync queue.
Send any objects or voice messages through the Contacts tab. Doing this will also add to your sync queue and will not send until any syncing issues are fixed.
Change any settings. Doing this will also add to your sync queue and will not save properly until any syncing issues are fixed.
Reinstall Neos. Doing this does not help syncing issues, as these are stored in a separate location.

Diagnosing a Stuck Sync

The first step for fixing a Stuck Sync, is to ensure it really is stuck. Sometimes syncing may take a long time or appear stuck but, it's just being slow. Follow these steps to confirm the issue:

Examine the sync status section of your Dash menu. It is in the top bar of the dash and will usually display "All Synced" in green
If it says "Syncing" and then a percentage, examine this percentage. See if it changes or increases. Give it a few minutes to double check that its not just being slow.
If it is still not moving, then you have a stuck sync!

Fixing a Stuck Sync

Fixing a stuck sync, is a little challenging depending on what exactly is wrong so make sure to follow our steps.

First, let's try some steps which are common to many sync issues:

Try restarting Neos, this will re-start the sync process and can sometimes get it unstuck.
Try disabling any mods, plugins or other modifications you have made to Neos, these may affect syncing.

If you've tried these initial steps then let's move on to discovering exactly what's wrong:

Examine your Log Files, Sync issues are usually shown in the "Regular" logs.
The most recent file from the log folder should usually be the one to look at, it's more likely to show a stuck sync.
Scroll through the file looking for the phrase "Sync".
- This term is usually quite overloaded as some of Neos' internals are also called "Sync".
- Make sure you're looking for obvious errors, things that have the words "Fail" or "Error" in their text.
Once you've found a relevant log file selection please read below in the following list ("Common Stuck Sync Causes"), to see if you can match any of the problems to your problem.
If you can find a match, click its name in the table to find a dedicated guide just for that problem.
If you cannot find a matching section, or have trouble with reading your log files, then please share a log file in the #questions-help channel, where another user can examine it to see what is wrong.

Common Stuck Sync Causes

Name/Link	Example Log File contents	Description
Out Of Space	`Fail Reason: Out of space`	Your Neos Account's storage is full. Read the Out Of Space page for more help.
Too Many Requests	`Fail Reason: Response status code does not indicate success: TooManyRequests (429);`	The Neos Cloud is making too many requests at the moment. Read the Too Many Requests for more help.
Conflict	Anything that has the word "Conflict"	Your have a sync conflict. Read the Conflict page for more help.

Something else?

If you can't find something that matches the above list. Please report it on our issue tracker or in our Discord. In both cases make sure to provide a log file. For a technical reason on why stuck syncs occur and break the syncing loop, see #3915 on the Neos Public GitHub.

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:3-->
-Sometimes, when your account is syncing the sync status as shown on the dashboard will stick at various percentages(10% is common). This indicates that there was a problem while syncing that is halting or pausing the sync process.
+Sometimes, when your account is syncing, the sync status as shown on the dashboard will stick at various percentages(0% and 10% are common). This indicates that there was a problem while syncing that is halting or pausing the sync process. This guide aims to aid you in resolving a stuck sync. Please follow each step.
 = Ensure you're reading the right guide = <!--T:4-->
-We have multiple guides for Sync related matters, please ensure you are reading the correct one for your problem, for the "Hub" of these see [[Sync Errors]] '''BEFORE''' you start.
+First, We have multiple guides for Sync related matters, please ensure you are reading the correct one for your problem, if you sync is not stuck or you're experiencing some other sync issue please see [[Sync Errors]] '''BEFORE''' you start.
+<!--T:18-->
 These problems are slightly different and may require differing steps, so we've split them into separate guides.
-='''DO NOT'''= <!--T:2-->
+<!--T:19-->
-* Delete your Neos data/database or cache files.
+{{Template:TroubleshootingDoNot}}
-* Try to save and sync any more items/worlds.
-* Send any objects or voice messages through the Contacts tab.
-* Change any settings.
-* Reinstall Neos
 = Diagnosing a Stuck Sync = <!--T:6-->
@@ Line 24: / Line 21: @@
 = Fixing a Stuck Sync = <!--T:7-->
 Fixing a stuck sync, is a little challenging depending on what exactly is wrong so make sure to follow our steps.
+<!--T:20-->
+First, let's try some steps which are common to many sync issues:
+# Try restarting Neos, this will re-start the sync process and can sometimes get it unstuck.
+# Try disabling any mods, plugins or other modifications you have made to Neos, these may affect syncing.
 <!--T:8-->
-# Examine your [[Log Files]]
+If you've tried these initial steps then let's move on to discovering exactly what's wrong:
-# The most recent file that shows a stuck sync, should be the one that you examine.
+# Examine your [[Log Files]], Sync issues are usually shown in the "Regular" logs.
-# Scroll through it looking for issues, If you're unsure try asking on the Discord and somewhere there will be able to identify where the Stuck Sync message is.
+# The most recent file from the log folder should usually be the one to look at, it's more likely to show a stuck sync.
-# Once you've located the message that's related to your stuck sync. Follow the section below which most closely matches the issue you're seeing in the log file.
+# Scroll through the file looking for the phrase "Sync".
+#* This term is usually quite overloaded as some of Neos' internals are also called "Sync".
-== Too Many Requests == <!--T:9-->
+#* Make sure you're looking for obvious errors, things that have the words "Fail" or "Error" in their text.
-If you've found a message that contains something '''like''' this:
+# Once you've found a relevant log file selection please read below in the following list ("Common Stuck Sync Causes"), to see if you can match any of the problems to your problem.
-<pre>
+# If you can find a match, click its name in the table to find a dedicated guide just for that problem.
-Fail Reason: Response status code does not indicate success: TooManyRequests (429); Substatus: 3200; ActivityId: ....; Reason: (
+# If you cannot find a matching section, or have trouble with reading your log files, then please share a [[Log Files|log file]] in the #questions-help channel, where another user can examine it to see what is wrong.
-code : TooManyRequests
-message : The request rate is too large. Please retry after sometime. Learn more: http://aka.ms/cosmosdb-error-429,
-</pre>
-This error means that there's a rate limit occuring between you and our data storage systems which are a part of the Azure cloud service offerings.
-<!--T:10-->
-You can follow these steps to try and resolve it:
-# Try restarting Neos, this will re-start the sync and try it again.
-# Try waiting for a while before restarting or trying to sync again.
-# Try waiting for a quieter time for Neos traffic before syncing. Later at night or earlier in the morning
-<!--T:11-->
-This may take up to 48 hours to resolve.
-<!--T:12-->
-If you are impatient, then there are some more items you can try. These '''WILL CAUSE DATA LOSS''':
-* Force the Sync to ignore records which are causing it to get stuck. This is done by following the [[Sync Conflict] guide and using the <code>-DeleteUnsyncedCloudRecords</code> option within this guide.
-* You can [[Clear your database]].
-=== Avoiding this problem in the future === <!--T:15-->
+= Common Stuck Sync Causes = <!--T:26-->
-The Neos team are aware and are investigating this issue, see the [https://github.com/Neos-Metaverse/NeosPublic/issues/3729 bug report on our issue tracker] for more information. In the mean time, try these recommendations to potentially reduce the amount of times you see it:
-# Avoid repeatedly saving the same object multiple times - For example, waiting a longer period of time between saving copies of worlds or avatars.
-# Avoid saving multiple items at once - For example, don't grab and save every single object you see.
-# Break up your saves, save an item...wait 5 minutes... save another item.
-# Try using your [[Homes|Local Home]] as a Local Backup.
-# Continue posting reports, log files and information on the [https://github.com/Neos-Metaverse/NeosPublic/issues/3729 bug report on our issue tracker]
-# Ask in our discord for more information.
-== Conflicts == <!--T:13-->
+<!--T:27-->
-If you find a message stating that there is a conflict, you'll need to see [[Sync Conflict]] page instead.
+{| class="wikitable"
+|-
+! Name/Link !! Example Log File contents !! Description
+|-
+| [[Stuck Sync/Out Of Space|Out Of Space]] || <code>Fail Reason: Out of space</code> || Your Neos Account's storage is full. Read the [[Stuck Sync/Out Of Space|Out Of Space]] page for more help.
+|-
+| [[Stuck Sync/Too Many Requests|Too Many Requests]] || <code>Fail Reason: Response status code does not indicate success: TooManyRequests (429);</code> || The Neos Cloud is making too many requests at the moment. Read the [[Stuck Sync/Too Many Requests|Too Many Requests]] for more help.
+|-
+| [[Sync Conflict|Conflict]] || Anything that has the word "Conflict" || Your have a sync conflict. Read the [[Sync Conflict|Conflict]] page for more help.
+|}
 == Something else? == <!--T:16-->
-If you can't find something that matches the above list. Please report it on our [https://github.com/Frooxius/NeosPublic/issues issue tracker] or in our Discord. In both cases make sure to provide a [[Log Files|log file]].
+If you can't find something that matches the above list. Please report it on our [https://github.com/Frooxius/NeosPublic/issues issue tracker] or in our Discord. In both cases make sure to provide a [[Log Files|log file]]. For a technical reason on why stuck syncs occur and break the syncing loop, see [https://github.com/Neos-Metaverse/NeosPublic/issues/3915 #3915] on the Neos Public GitHub.
 <!--T:17-->
 [[Category:Troubleshooting]]
 </translate>

Difference between revisions of "Stuck Sync"