Merge pull request #460 from julian-molina/develop
Contribution: Troubleshooting
This commit is contained in:
16 files changed
+1148
No files matched your search
Binary file not shown.
|
After Width: | Height: | Size: 250 KiB |
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 75 KiB |
+226
@@ -0,0 +1,226 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "1",
|
||||
"type": "How to Troubleshoot an Issue",
|
||||
"definition": {
|
||||
"text": "Following these logical steps will help you better understand the system and find solutions to most of the issues you may run into.",
|
||||
"updated": 1611509381460
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "There are several reasons why you may experience issues while using Superalgos. It may be due to a lack of understanding of how the system works, because you may be skipping a step or two in the process you are trying to engage with, or because something may not be working as it should.",
|
||||
"updated": 1611509396717
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Whatever the reason may be, this page provides a step-by-step process that will help you understand what is going on so that your issue may be resolved in the most efficient possible way."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "In other words, following this step-by-step troubleshooting guide will either lead you to discovering what you may be doing wrong so that you may fix your issue and move on, or to gathering all the relevant information required for the Team to investigate the issue."
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "Thoroughly following this troubleshooting guide—step by step—is a requirement for reporting an issue. We can not afford to investigate issues that you may solve on your own, or without the appropriate information. Doing so would rob the project of valuable resources.",
|
||||
"updated": 1611509548445
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Start Here"
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "1. Understand what you are doing and how the feature works"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "If you are following the Download and Set Up guide or the Welcome tutorial, read caferully and make sure you haven’t skipped any steps."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "If you are already using the system, take some time to search the documentation and read the pages related to the matters you are working with. Use the search box on the top-right corner to search for the specific matter (i.e. backtesting, data mining, etc.)",
|
||||
"updated": 1611509580552
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "If you are having trouble with a specific node on the design space, open the menu and click the button. A new tab will open in your browser with the description of the corresponding node in the corresponding hierarchy directory. Read about the node, it’s parent node, and its offspring."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "If you are having trouble operating the charts, make sure you revisit the Welcome tutorial and the interface section of the Charting Space."
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "There is no substitute for knowledge. The more you understand, the less time and effort you will waste with issues related to a lack of understanding, and the more focused your questions will be when asking for help. You may be inclined to take a shortcut and ask the community before doing your research. This may save you some time occasionally and may be appropriate in cases in which you need a little guidance or need to clear a quick doubt, particularly if you are a beginner and are still following the Getting Started Guide. However, the problem with lack of understanding is that it is a persistent condition until you deal with the root cause. The way to deal with the root cause is taking the time to read the documentation. Otherwise, you will find yourself dealing with the same constraints over and over again. Acquiring knowledge while being mindful of the Team’s time is the first step towards becoming a valuable member of the community.",
|
||||
"updated": 1611509589990
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "2. Scan the troubleshooting section"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Chances are someone else has experienced a similar issue as you may be experiencing now. We do our best to compile common issues into specific troubleshooting pages, so make sure you take a look there before moving on."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "3. Is your processor stuck at 100%?"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Open your operating system’s Task Manager application and verify the CPU load while you reproduce the issue you are experiencing. If your CPU is running at 100% for more than 30 to 60 seconds, all sorts of problems may arise, as your hardware is not able to cope with the system requirements."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If this is the case, try closing any other applications that may be demanding CPU time, and follow the guidelines proposed in the My System Gets Slow page to lower the demands on the processor."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you may not reproduce the issue while your CPU is working at less than 100%, then that may have been the cause of the problem."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "4. Does the issue persist when using the latest version of the software?"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Running the latest version of the software is virtually mandatory, as bugs affecting you may have already been solved. Make sure you are running the latest stable software version in the master branch of the Superalgos repository, or the latest software in the develop branch."
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "Making sure means installing the latest version, right now.",
|
||||
"updated": 1611509626109
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "5. Does the issue persist when using one of the official workspaces?"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If the issue may not be reproduced using one of the official workspaces, that likely means that modifications you may have introduced may be playing a role in the issue. In and of itself, this is a crucial piece of information that helps start the process of isolating the issue."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If the issue happens in a modified workspace only, take some time going through the modifications you introduced."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Start over and reproduce the modifications on the official workspace, one at a time, and make a quick test after each mod is applied. This process done right should lead you to the exact node, structure of nodes, configuration, parameter, or—in general—the modification that may be involved in the cause of the issue."
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "This doesn’t necessarily mean that you made a mistake when modifying the official workspace. It simply pinpoints where the problem may be, and it’s a crucial part of the investigation that you should conduct before going any further.",
|
||||
"updated": 1611509652152
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "6. Simplify the context and isolate the issue"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "When you are doing several things at the same time and something goes wrong, it is sometimes hard to identify what is it that may be causing the issue. The next logical step to take is to further isolate the issue. You do this by removing pieces from the context so that you may focus on the core of the matter."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "For example:"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you are having an issue while backtesting a strategy, you do not need your data mining operation to be running. In such a case, stop the data mining operation and everything else you may be doing, and run the backtest only."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "If you are having an issue running one of the Masters indicators, you do not need all indicators to be running at the same time. Make sure the said indicator dependencies are running, and stop the rest of the indicators."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "If you are having an issue with a chart and you have three other charts on the screen at the same time, try zooming-in the chart and see if you still experience the issue. Or turn all layers off and leave on only the layer you may be having difficulties with."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "If you are running multiple live trading sessions and experience an issue with one of them, stop the rest of the sessions and try to reproduce the issue with the first one."
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "The point to take home is that the narrower the scope of the investigation, the easier it is to find the cause of the problem.",
|
||||
"updated": 1611509672765
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "7. May this be an issue with data?"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If your machine shut down unexpectedly or you closed the backend servers running in the console application without first stopping your data mining tasks, chances are some of your data may have been corrupted. If you suspect this may have something to do with your issue, then you should check the integrity of your data."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "8. May this be an issue with the frontend application?"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If your issue happens within the frontend application, then you should either be getting an on-screen error or an error on your browser console application."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The error on-screen or logged at the browser console may give you a hint of what may be going on. If you are a technical person, this may help solve your issue on your own."
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "Make sure you grab the screen showing these errors so that you may report them later.",
|
||||
"updated": 1611509685850
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "Remember that Chrome is the only supported browser. If you are using any other browser and have frontend issues, we may not be able to reproduce the issue. Do not report an issue with the frontend unless you are using Chrome.",
|
||||
"updated": 1611509692825
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "9. May this be an issue with the backend application?"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If there are issues with the backend application, then errors must be logged at the console where you are running the backend. The same errors are logged in the Log-Files folder and the specific sub-folders corresponding to the processes involved in the matter."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": " Note: Make sure you check the logs for the specific processes involved in the matter, and save the corresponding log files with these errors so that you may report them later."
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "If you are a developer, remember that you may easily debug a task to find the root cause of the issue.",
|
||||
"updated": 1611509706433
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "10. May this be an issue related to your particular setup?"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Deploying and running Superalgos in complex or very particular setups augments the probability of issues related to the setup itself, which may be very hard or even impossible for the Team to reproduce. The team will investigate issues that happen while running Superalgos in your local machine, or while running in a classic trading farm setup as described in the documentation. We can not investigate issues unrelated to the software itself."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you have issues with a particular setup, feel free to ask for help from other users in the community, but do not open an issue for the Team to look into."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Has Your Issue Not Been Resolved?"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If following this guide didn’t solve your issue, do not worry… your efforts shall not go in vain!"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Investigating your issue must have taught you a lot about how the system works, and it’s a requisite for reporting an issue so that the Team may investigate it. So, please, go ahead and do just that. Make sure you follow the instructions on How to Report an Issue and provide all the valuable information you have gathered while following this guide.",
|
||||
"updated": 1611509744676
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
+267
@@ -0,0 +1,267 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "2",
|
||||
"type": "How to Report an Issue",
|
||||
"definition": {
|
||||
"text": "Reporting an issue is a process that entails doing some basic research, carefully describing how to reproduce the issue, and gathering crucial information.",
|
||||
"updated": 1611510213732
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Before you consider reporting an issue, make sure you do everything within your reach to investigate the problem. In most cases, you will find that there is no issue at all and that you were making a mistake, skipping a step in the process, or not fulfilling a requirement.",
|
||||
"updated": 1611510227112
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "The How to Troubleshoot an Issue guide takes you through a step-by-step process to investigate your issue and gather all relevant information. Carefully following the guide is a requirement for reporting an issue. If the very act of going through the troubleshooting steps does not solve your issue, then come back here once you have finished gathering the required information, as instructed in the guide. Remember, reporting an issue requires understanding what the issue is about, being able to explain how to reproduce it, and providing all relevant information.",
|
||||
"updated": 1611510328837
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "1. Search for Similar Issues",
|
||||
"updated": 1611511273179
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Go to the Issues page in the Superalgos repository and use the search box to find issues that may be similar to yours."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Search for open and closed issues (remove the is open tag).",
|
||||
"updated": 1611510615215
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Try different keywords you would use to describe the issue."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you find an issue that is similar to yours, read the whole thread. You may find information conducive to solving the issue, proposed workarounds, or reports on the status of the solution to the issue."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you believe you have information relevant to the issue that has not yet been offered by other users, then go ahead and reply to the issue with everything you know about your case."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If there are no issues similar to yours, or your issue happens in a different context not addressed in the issues you’ve found, then go on with the next few steps."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "2. Are you Ready to Report an Issue?",
|
||||
"updated": 1611511264814
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Please, make an honest assessment of the following questions:"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Have you followed the How to Troubleshoot an Issue guide to the best of your abilities?",
|
||||
"updated": 1611510652729
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Have you tested your issue with today’s version of the software?"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Have you verified that none of the troubleshooting pages in the documentation addresses and solves your issue?"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Have you captured and saved the associated errors in the browser console or the Log-Files folder?"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "In case your issue is related to the frontend… are you using Chrome or Safari to test the issue?",
|
||||
"updated": 1611510679400
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you answer no to any of the above, then you are not ready to open an issue. If you may confidently answer yes to all questions, then please proceed."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "3. Consider the Following",
|
||||
"updated": 1611511254512
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If the issue may be reproduced on one of the official workspaces, then report the issue as such. Issues occurring on custom workspaces have a lower priority."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Issues that may not be reproduced have lower priority than those that may be reproduced."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "4. Open a New Issue",
|
||||
"updated": 1611511249720
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Click the New Issue button and select Get Started on the Bug report item. The following form will open:"
|
||||
},
|
||||
{
|
||||
"style": "Png",
|
||||
"text": "PNGs/Superalgos/Docs/third-parties/report-an-issue-01.png",
|
||||
"updated": 1611510882221
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Carefully complete the form following the below guidelines:",
|
||||
"updated": 1611510902570
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Title"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Do your best to describe the issue in a single, short sentence. Take your time. A good practice is describing what happens and in which context. For example: “WHB backtest stops short of finalDatetime”."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Context"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Complete and adjust the contents leaving the information that fits your case and deleting the information that doesn’t."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Operating System: Windows / MacOs / Linux / Other (include the version on either case)"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Software version: today’s master branch / today’s develop branch"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Workspace version: default Workspace.json (Getting Started Guide) / Simple Workspace.json / Workspace - Binance - WHB - BBTB.json / My custom workspace"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Reproducible: the issue may / may not be reproduced."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Explain Your Issue",
|
||||
"updated": 1611511238751
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Explain what the problem seems to be."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Clearly explain what you wish to accomplish."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Explain, step by step, what you’ve done to achieve the goal. The Team will follow these steps to reproduce the issue, so be precise."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Explain what is the result you expect from your actions."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Explain what happens instead of the expected results."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Explain what errors you have found on-screen, on the browser console application, or in the Log-Files folder."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Reproduce the Issue on Video",
|
||||
"updated": 1611511228776
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The most important aspect of investigating an issue is being able to reproduce it. Capturing a video showing the steps that lead to the issue would be of great help."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If the issue happens within the browser, you may use the systems’ video capture feature:"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Hit Ctrl + F8 to capture a static PNG image."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Hit Ctrl + F9 to start capturing a GIF video, and hit the same key combination again to end the capture. Once the capture ends, it takes some time to process the capture and generate the final file."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Hit Ctrl + F10 to start capturing a WEBM video, and hit the same key combination again to end the capture. WEBM videos are processed instantly."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "In all three cases, the browser downloads the resulting file and makes it available in the downloads folder."
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "GIF files tend to grow a lot in long captures, but are more universal, thus more devices can display them properly. WEBM files are a lot more efficient, but do not work in Apple and, potentially, other platforms or devices.",
|
||||
"updated": 1611511119973
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "In case the issue does not happen at the browser, for example, if it happens at the console, LICEcap is a lightweight, simple system that can help you capture GIF videos outside of Superalgos."
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "Bear in mind that GitHub issues accept files 10MB and lighter only.",
|
||||
"updated": 1611511131091
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Attach Relevant Log Files",
|
||||
"updated": 1611511219274
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you have on-screen errors or errors at the browser console, screen captures are fine."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you have errors in the backend, attach the logs you have collected while following the troubleshooting guide."
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "GitHub issues do not allow uploading JSON files. Make a ZIP file with all relevant logs instead.",
|
||||
"updated": 1611511170225
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Custom Workspace?",
|
||||
"updated": 1611511208878
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If the issue happens under specific conditions on a custom workspace, attach a share of the workspace. Do not attach backups as those may contain personal information such as API Keys."
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "Upload your workspace to the issue only if you feel comfortable with sharing it openly. If there are data structures that you prefer not to share, consider removing them so that you may share the non-sensitive bits only. If the issue happens precisely with the sensitive data structures in your workspace, then clearly explain the matter and wait for further instructions.",
|
||||
"updated": 1611511186403
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "5. Enable Github Notifications",
|
||||
"updated": 1611511204195
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Make sure you enable GitHub notifications when someone responds to the issue, as developers may want to ask for more information."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
+145
@@ -0,0 +1,145 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "3",
|
||||
"type": "How to Upgrade Your Existing Installation",
|
||||
"definition": {
|
||||
"text": "Staying up to date with the latest version of the software is highly recommended. Learn how to do it and what precautions to take.",
|
||||
"updated": 1611511361415
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "You should expect new releases of Superalgos to become available every few months. Release announcements are made through the Official Superalgos Telegram Announcements Channel.",
|
||||
"updated": 1611511377439
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "During this beta stage, patches may be released as frequently as several times per week. Due to their high-frequency, minor updates go unannounced. If you ever experience a malfunction, make sure you upgrade your installation to the latest version available in the Superalgos repository before reporting a bug.",
|
||||
"updated": 1611511390486
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "New Releases"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you are upgrading to a new official release, make sure you follow these instructions as well as those under the All Upgrades section."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Read the Announcement Carefully"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Read and understand the announcement explaining the changes and how they may impact your workflow. Most importantly, find out if the new version requires upgrading your workspace."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Check the Getting Started Guide"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "It would be wise to go through the potentially new Getting Started Guide in the documentation, as it may reveal important information."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Back Up Your Personal Work"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If the new version requires upgrading to a new workspace, you must decide which parts of your work you wish to backup so that you may restore them on the upgraded workspace (e.g.: you may want to backup your trading systems, data mines, super scripts, specific settings or configurations such as testing sessions, time machines, and so on)."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If there is no need to upgrade the workspace, that means that the new version of the system should work well with your existing workspace, provided that you are only one version behind."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "All Upgrades"
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Back Up the Workspace"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Always back up your existing workspace before switching versions. You may go back to a working version of the software in case something goes wrong with the new one, by installing the previous version of the system and restoring your old workspace from a backup file if needed."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Put the House in Order"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "1. Stop all tasks that may be running in the network hierarchy, and close your browser. Allow a minute or two until all activity stops before closing the Console/Command Line/Terminal running the servers."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "2. Check if you have any personal files, such as your workspace backups and so on in your Superalgos-master folders. Move them to a different location if you do, or take precautions not to delete them in the next step."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "3. You will keep the Data-Storage and My-Workspaces folders intact and delete all the remaining folders within the Superalgos folder."
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "You do not need to get rid of the historic market data or the workspaces you have been working with every time you upgrade your system. Do not delete your Data-Storage or your My-Workspaces folder.",
|
||||
"updated": 1611511439947
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Install the New Version",
|
||||
"updated": 1611511465990
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Always follow the instructions in the Official Announcements Channel and the official blog post about the new release.",
|
||||
"updated": 1611511529701
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "Always beware of what random people may post in open Telegram groups or forums. Patches and releases will always be made available at the master branch of the Superalgos repository.",
|
||||
"updated": 1611511536779
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Empty Cache and Hard Reload"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Once the system loads in your browser window and before you start working, you need to empty Chrome’s cache and do a hard reload to make sure the browser does use the newly installed files."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "1. Hit F12 to open Chrome’s Developer Tools. You do not need to use the Developers Tools, but opening it allows performing the next task."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "2. Right-click on the refresh icon and select Empty Cache and Hard Reload from the drop-down menu. Once refreshed, you may close Developer Tools with F12."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "F12 to open Developer Tools, then right-click on the refresh icon."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Final Tunning and Testing"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Occasionally, the new version of the system may introduce changes that may require you to update your existing trading systems or some other parts of your workspace. If that is the case, an official announcement should explain how to proceed."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "This is the time to restore any of the work you may have backed up earlier."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Before going deep back to work, it is always recommeended to test the new version a bit and make sure that your existing work performs as you would expect."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you run into any issues, feel free to drop us a line in our Community."
|
||||
}
|
||||
]
|
||||
}
|
||||
+45
@@ -0,0 +1,45 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "4",
|
||||
"type": "Initial Setup - Node is not Recognized as an Internal or External Command",
|
||||
"definition": {
|
||||
"text": "Make sure Node JS is properly installed and that you are running the commando from within the correct folder.",
|
||||
"updated": 1611511701216
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Have You Installed Node JS?",
|
||||
"updated": 1611511729403
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The Download and Set Up guide walks you through the process of installing Node JS, an open-source server environment required to run Superalgos. Make sure you have installed the software correctly. Double-check in case the installation hasn’t finished yet."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Are you running the command from the correct folder?"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Make sure you run the command from within the Superalgos-master folder."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Test if Node JS is installed"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Run the command...",
|
||||
"updated": 1611511888280
|
||||
},
|
||||
{
|
||||
"style": "Javascript",
|
||||
"text": "node --version"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "... to test if Node JS is installed. If Node JS is installed, the system should return a version number. If it doesn’t, please install Node JS again."
|
||||
}
|
||||
]
|
||||
}
|
||||
+46
@@ -0,0 +1,46 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "5",
|
||||
"type": "Initial Setup - Superalgos Failed to Connect Via Websockets",
|
||||
"definition": {
|
||||
"text": "If you are accessing the backend from another computer in the network, you need to configure the Network Node with the appropriate IP Address.",
|
||||
"updated": 1611513085643
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "When you create a trading farm set up by which you intend to access the backend services running on a machine from a remote computer in the network, you must configure the Network Node in the remote computer to use the IP Address of the machine where the backend services are running.",
|
||||
"updated": 1611513097561
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Configuring the Network Node"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Select Configure on the menu to access the configuration."
|
||||
},
|
||||
{
|
||||
"style": "Json",
|
||||
"text": "{\n\"host\": \"localhost\",\n\"webPort\": \"34248\",\n\"webSocketsPort\": \"18041\"\n}",
|
||||
"updated": 1611513108585
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "host is the machine or hardware represented by the network node. The default parameter is localhost, but if you intend to access the backend services of this node from a remote computer, then you must change localhost for the IP Address of the machine on which the node is running, for example, to 147.0.0.1."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "webPort is the port used by the Web Server, at this stage 34248."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "webSocketsPort is the port used by the system to communicate over the local area network, by default set at 18041."
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "After configuring the network node refresh the page with F5 and the GIU should connect with the backend.",
|
||||
"updated": 1611513135633
|
||||
}
|
||||
]
|
||||
}
|
||||
+113
@@ -0,0 +1,113 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "6",
|
||||
"type": "Perception Issues - My System Gets Slow",
|
||||
"definition": {
|
||||
"text": "Understand how the system uses the available hardware so that you may implement workarounds and best practices.",
|
||||
"updated": 1611513348468
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Dynamically rendering all the visual features in the system puts a significant load on the machine’s graphics processing unit (GPU). Running multiple tasks at the same time is demanding on the central processing unit (CPU). Depending on your machine’s capacity, this may result in the system getting slow and sometimes even unresponsive.",
|
||||
"updated": 1611513372759
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you experience such symptoms, there are several actions you may take to mitigate them."
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "Learn about the system requirements to better understand what to expect in terms of the performance of your hardware.",
|
||||
"updated": 1611513387104
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Close The Browser’s Developer Tools"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "You may have opened Developer Tools at some point. Developer Tools may slow animation renderings to a crawl, as slow as one frame per second. In case it is open, make sure you close Developer Tools."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Stop Data Mining Tasks That You May Not Need Running"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Data mining is a CPU-intensive activity. If you are designing a strategy, you probably don’t need to have a live stream of information being processed in realtime. Learn to segment your activities and only start the tasks that you need for the work you are doing."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "You may also consider applying a Time Frames Filter to process the ones you require only.",
|
||||
"updated": 1611513521057
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Open Either the Design Space or the Charting Space"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Leaving the slider halfway up or down the screen causes both the design space and the charting space to consume resources. Make sure the slider is either fully up or down."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Display Less Data on the Charts"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Make sure you set the time scale to manual mode and adjust it so that fewer candles are displayed on the screen. Try switching the time frame box to the higher time frames so that candle density decreases."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "You may also want to switch off the layers you may not be using. Remember, every piece of graphical information you see on the screen represents data your system is reading from your disk and processing to display in a graphical form."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Also turn off the layers in the Trading Engine and Trading System layer managers. Those layers interact with the design space to show information in realtime over the trading engine and trading system hierarchies."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Collapse Unused Hierarchies",
|
||||
"updated": 1611513572645
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The physics that govern nodes in the design space help structures of nodes to self-organize. This comes at a cost in terms of GPU processing power."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Make sure all hierarchies you are not using are collapsed."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "You may also want to close any of the structures of nodes that you may not be using within the hierarchy that you may need to expand."
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "If these workarounds do not solve your problem and you often experience slowness or unresponsiveness when using your computer, you may want to consider upgrading your equipment. You shouldn’t risk your capital with an insufficient trading infrastructure.",
|
||||
"updated": 1611513583937
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "See the Effects of Your Actions"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "There’s a handy built-in tool to meassure the performance of the animation that you may use to see the effects of turning off layers, lowering the density of information and so on."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Click Ctrl + Shift + Alt + F11 and the following performance readings will show up on your screen:"
|
||||
},
|
||||
{
|
||||
"style": "Png",
|
||||
"text": "PNGs/Superalgos/Docs/charts/frames-per-second-tool.png",
|
||||
"updated": 1611513729958
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The frame rate displayed at the bottom should increase the more of the actions suggested here you implement."
|
||||
}
|
||||
]
|
||||
}
|
||||
+114
@@ -0,0 +1,114 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "7",
|
||||
"type": "Perception Issues - There Are No Candles on The Charts",
|
||||
"definition": {
|
||||
"text": "It takes time for your data mining operation to download data from the exchange and process the raw data to build candles. Check the progress of your data mining operation in the network hierarchy.",
|
||||
"updated": 1611513813893
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "There are a few reasons why you may be having issues finding candles on the charts. Please, consider the following…",
|
||||
"updated": 1611513833239
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Check the Progress of the Data Mining Operation"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you are just getting started with Superalgos, still following the getting started guide, bear in mind it takes time for data to be downloaded from the exchange. Depending on the power of your hardware and the speed of your internet connection, it may take anything from half an hour to several hours to see the first few candles, particularly those of the Binance exchange, as the market spans back to September 2017."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Check the data mining operation on the network hierarchy. You will be able to see candles on the screen only after the OHLCV Sensor Bot and the Candles Volumes indicator in the Masters task manager of the corresponding exchange data tasks node and market have both reached 100% progress."
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "If you are not sure what the above paragraph refers to, go back to the Welcome tutorial as a refresher.",
|
||||
"updated": 1611513856516
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Switch Candles Layer Off and Back On and Refresh the Page"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Zoom into the chart until you see the layer manager featuring the candles layer. Turn off the candles layer and turn it back on. This forces to candles layer to reload."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Check the Time, Rate and Time Frame Scales"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "It may happen that you attempted to manipulate the charts and something went wrong in the process."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Try setting the time frame scale to 24 hours, and both the time scale and rate scale to automatic mode. Setting the time scale to automatic mode brings the whole span of the market in focus on the chart. Setting the rate scale to automatic mode sets the scale to fit the entire range of prices in the market. The goal is to make sure that all scales are set in a way in which—if there is any data to show—it will show."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Check the Integrity of Your Data"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Your PC may have been forcefully shut down or you may have closed the console running the Superalgos backend while running a data-mining operation. Such situations may cause some data to become corrupt."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "1. Check the integrity of the sensor bot data"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Go to the Exchange-Raw-Data folder under Data-Storage > Exchange > Market > Masters and keep opening the subfolders to get to the last day available, and open the Data.json file. If the file opens fine, this may mean that the data you downloaded from the exchange is safe."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If the last file in Exchange-Raw-Data does not open properly then delete the whole Data-Storage > Exchange > Market and run the data mining operation. This will have the OHLCV sensor bot download all the data from the exchange again, and all indicators calculated from scratch."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If the sensor data seems fine, then proceed with the next step."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "2. Check the integrity of indicator’s data"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you are having issues with candles you need to check the data of the Candles Volumes indicator of the Masters Data Mine located deep in Multi-Period-Daily and Multi-Period-Market folders under Data-Storage > Exchange > Market > Masters > Candles-Volumes > Output > Candles."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you find any .tmp files or you can’t open some of the latest Data.json files in a regular text editor, or some files are empty, chances are the files have been corrupted."
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "Something similar may have happened with other indicators as well, so make sure you check the data storage folders of indicators that may not be working or that you may be experiencing issues with.",
|
||||
"updated": 1611513920939
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If that is the case, then you will delete the folder for each data mine within Data-Storage > Exchange > Market, but will leave Exchange-Raw-Data intact, and get the data mining operation running afterward. This will regenerate all indicators data products, including Candles Volumes."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "3. Remember that there is a proper way to close the system!"
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Check for Errors at the Browser"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Open Chrome’s DevTools with the F12 key (when the browser is in focus) and click the Console tab. Then go back to Superalgos and reproduce the issue. The console may display network errors and warnings of different sorts. Those are not important and you may safely ignore them."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Do pay attention to other kinds of errors, such as files that can not be loaded, or errors in specific system components."
|
||||
}
|
||||
]
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "8",
|
||||
"type": "Perception Issues - Market Data or Indicators Seem to be Outdated",
|
||||
"definition": {
|
||||
"text": "For data to be up to date, the Masters and Sparta task managers need to be running.",
|
||||
"updated": 1611514061066
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you are running the system for the first time or you stopped running the system for some time, data will not be up to date. Every time you start the system, it will take some time for data to catch up with the present time.",
|
||||
"updated": 1611514064800
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "To update your datasets until the present time you need to Run All Tasks in your Masters and Sparta task managers for the exchanges and markets you wish to work with, and allow enough time for the processes to go through the missing data."
|
||||
}
|
||||
]
|
||||
}
|
||||
+48
@@ -0,0 +1,48 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "9",
|
||||
"type": "Perception Issues - Indicator Data Seems Wrong",
|
||||
"definition": {
|
||||
"text": "Make sure you compare with the actual source of the raw data and research the raw data before reporting an issue.",
|
||||
"updated": 1611514878598
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "You may be comparing one of Superalgos’ indicators with indicators produced by other sources like TradingView, Sierra Chart, or any other provider. You may have found some differences, probably minor, in some of the indicator properties for certain candles, or maybe even throughout the data set.",
|
||||
"updated": 1611514888972
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "One of the most likely reasons for these mostly minor discrepancies is that the raw data exchanges provide is not always consistent. For example, occasionally a one-minute candle may be missing in the data set. Or some candles may not start exactly at the zero-seconds mark."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Our OHLCVs sensor bot fetching data from exchanges works recursively to ensure no data is missed, however, we have no control over the data the exchange delivers at any point."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Furthermore, there is no information as to how third-parties obtain the data they serve, or what measures they may be taking when they detect inconsistencies in the datasets."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "It is reasonable to conclude that minor differences with third-party providers are to be expected."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you worry about the quality of the data of any of the indicators running on Superalgos, the first thing to do is to compare the data with the source, not a third-party—that is, the actual exchange."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you find inconsistencies in some of our data with the data provided by the exchange, then, the second step to investigate what the issue may be is to compare the raw data, that is, one-minute candles. If you find differences in the one-minute candles provided by Superalgos and the one-minute candles provided by the exchange, then we may have a case in which the sensor bot requires some debugging to find out what the problem may be. In such a case, please open an issue pointing us to the specific candles that you found to be wrong."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If one-minute candles seem to be correct and there is an inconsistency in the data provided by a Superalgos indicator, first, make sure that candles are correct throughout the period required to calculate the indicator. For example, in the case of a 50-periods moving average, you need to check the last 50 candles from the point in which you find a discrepancy in the indicator. If such is the case, please open an issue indicating the process you went through to determine that there is something wrong with the said indicator and point us to the specific point in time where the indicator is wrong."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "10",
|
||||
"type": "Investigating Issues - I Think I Broke Something... How Do I Start Over?",
|
||||
"definition": {
|
||||
"text": "If you think you may have accidentally broken something within the workspace, you may easily go back to the original release settings.",
|
||||
"updated": 1611515018864
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Superalgos is a large system and the learning curve may be a little steep. In the beginning, you may feel a bit lost, and in an attempt to make something work, you may accidentally detach nodes from their hierarchies, remove references, delete nodes, or even entire data structures.",
|
||||
"updated": 1611515027037
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If basic things are not working for you as expected and you think the issue may be that you accidentally broke something, do not panic! You can always go back to the original release settings by restoring a workspace the Getting Started plugin workspace by selecting it from the Workspaces Tab on the left-hand side of the screen."
|
||||
}
|
||||
]
|
||||
}
|
||||
+25
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "11",
|
||||
"type": "Investigating Issues - On-Screen Errors and Warnings",
|
||||
"definition": {
|
||||
"text": "When running a task or working on a strategy, errors in the session or the syntax of conditions and formulas are signaled at the offending node.",
|
||||
"updated": 1611515342007
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The frontend application marks errors by drawing a red ring around the offending node and offers a brief description of the error on-screen. At the same time, a page describing the error details is made available on the documentation tab.",
|
||||
"updated": 1611515405270
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "When running a trading session, the session node is usually the one featuring the error notice."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "When working on a strategy, errors in the syntax or logic of conditions and formulas are displayed similarly. In such a context, make sure you turn on the Trading System Errors and Trading System Warnings layers of the corresponding session and look around within your workspace. Hover the mouse pointer over the node with a red ring and you should get a description of what is that is causing the unexpected behavior.",
|
||||
"updated": 1611515450259
|
||||
}
|
||||
]
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "12",
|
||||
"type": "Investigating Issues - Check for Errors at the Browser",
|
||||
"definition": {
|
||||
"text": "When errors occur in the frontend application, you should either get an on-screen error, or an error should be logged in the browser console.",
|
||||
"updated": 1611515570461
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Open Chrome’s DevTools with the F12 key (when the browser is in focus) and click the Console tab. Then go back to Superalgos and reproduce the issue. The console may display network errors and warnings of different sorts. Those are not important and you may safely ignore them.",
|
||||
"updated": 1611515578715
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Do pay attention to other kinds of errors, such as files that can not be loaded, or errors in specific system components."
|
||||
}
|
||||
]
|
||||
}
|
||||
+59
@@ -0,0 +1,59 @@
|
||||
{
|
||||
"topic": "Troubleshooting",
|
||||
"pageNumber": "13",
|
||||
"type": "Investigating Issues - Check the Integrity of Your Data",
|
||||
"definition": {
|
||||
"text": "When data mining processes are not shut down gracefully, your data may get corrupted.",
|
||||
"updated": 1611515660531
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Your PC may have been forcefully shut down or you may have closed the console running the Superalgos backend while running a data-mining operation. Such situations may cause some data to become corrupt.",
|
||||
"updated": 1611515685392
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "1. Check the Integrity of the Sensor Bot Data",
|
||||
"updated": 1611515705862
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Go to the Exchange-Raw-Data folder under Data-Storage > Exchange > Market > Masters and keep opening the subfolders to get to the last day available, and open the Data.json file. If the file opens fine, this may mean that the data you downloaded from the exchange is safe."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If the last file in Exchange-Raw-Data does not open properly then delete the whole Data-Storage > Exchange > Market and run the data mining operation. This will have the OHLCV sensor bot download all the data from the exchange again, and all indicators calculated from scratch."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If the sensor data seems fine, then proceed with the next step."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "2. Check the Integrity of Indicator’s Data",
|
||||
"updated": 1611515724143
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you are having issues with candles you need to check the data of the Candles Volumes indicator of the Masters Data Mine located deep in Multi-Period-Daily and Multi-Period-Market folders under Data-Storage > Exchange > Market > Masters > Candles-Volumes > Output > Candles."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If you find any .tmp files or you can’t open some of the latest Data.json files in a regular text editor, or some files are empty, chances are the files have been corrupted."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": " Note: Something similar may have happened with other indicators as well, so make sure you check the data storage folders of indicators that may not be working or that you may be experiencing issues with."
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "If that is the case, then you will delete the folder for each data mine within Data-Storage > Exchange > Market, but will leave Exchange-Raw-Data intact, and get the data mining operation running afterward. This will regenerate all indicators data products, including Candles Volumes."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "3. Remember There is a Proper Way to Close the System!",
|
||||
"updated": 1611515754787
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in new issue
Block a user