search

opensearch-project / OpenSearch-Dashboards

📊 Open source visualization dashboards for OpenSearch.
https://opensearch.org/docs/latest/dashboards/index/
Apache License 2.0
1.68k stars 885 forks source link

TroubleShooting Guide for students, later to transfer for DEVELOPER Guide.md as single source of truth #3759

Open Aigerim-ai opened 1 year ago

Aigerim-ai commented 1 year ago

Dear Fellow Developers and Mentors, Here I have collected all of the issues which appeared from current students at our program Please add comments on this issue, if you had troubles with installing application and managed to solve the issue. We follow specific format - Error(with screenshots), Description, Solution

1. Error: There appears to be trouble with your network connection. Retrying... Description: This error is because you have low speed network connection. Try with —network-timeout 1000000: Solution: yarn osd bootstrap —network-timeout 1000000 Author: Alexei Karikov @Nicksqain

2. Error: max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144] Description: This error is because there is not enough memory so more memory must be allowed to be used Solution: sudo sysctl -w vm.max_map_count=262144 For Windows:

  1. wsl -d docker-desktop

  2. sysctl -w vm.max_map_count=262144 Author: Alexei Karikov @Nicksqain

  3. Error: Execution failed for task 'server:compileJava'. Description: This error can be caused by JDK 14. Solved by changing runtime to JDK 11 or JDK 17. Solution: Change the RUNTIME_JAVA_HOME in /etc/environment by sudo nano /etc/environment Set the value pointing to JDK 11 or JDK 17 home directory Example: RUNTIME_JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64 Author: Saadat Nursultan @nurSaadat

  4. Error: server crashed Description: Server crashes when we run yarn start:docker, after opening localhost server crashes Solution: yarn osd clean, yarn osd bootstrap in your second terminal where docker container was opened, then run yarn opensearch snapshot Solution 2: clearing cache helps Author: Aigerim Suleimenova @Aigerim-ai

joshuarrrr commented 1 year ago

@Aigerim-ai Thanks for compiling!

I added numbers to make it easier to reference them.

  1. Interesting finding - wasn't aware of this, and think it should be added to the developer guide
  2. Yep, this is a known limitation and should definitely be in the developer guide. The additional docker/windows details are a nice tip
  3. Definitely a good tip - one consideration in this one is whether it makes more sense to add this tip to the Opensearch repo instead of OpenSearch Dashboards
  4. It seems like this one has a root cause we may be able to fix in the docker setup itself

So 1. and 2. are definitely good candidates for PRs to the developer guide. For the others let's see if we can think of any solutions that strike closer to the root.

Aigerim-ai commented 1 year ago

Hi! thank you for your reference numbers and your guidance, let me create one for Opensearch repo? Can I have this issue open, in case there will be problems specifically for OpenSearch-Dashboards Developers guide.