-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add troubleshooting flow chart document (#1688)
* 📝 add troubleshooting flow chart document Signed-off-by: vankichi <kyukawa315@gmail.com> * 🎨 update svg Signed-off-by: vankichi <kyukawa315@gmail.com> * 🎨 update svg Signed-off-by: vankichi <kyukawa315@gmail.com> * 📝 update troubleshooting docs Signed-off-by: vankichi <kyukawa315@gmail.com> * 📝 fix grammar Signed-off-by: vankichi <kyukawa315@gmail.com> * 📝 add troubleshooting README Signed-off-by: vankichi <kyukawa315@gmail.com> * 🎨 update svg Signed-off-by: vankichi <kyukawa315@gmail.com> * 🎨 update svg Signed-off-by: vankichi <kyukawa315@gmail.com> * ♻️ change file name Signed-off-by: vankichi <kyukawa315@gmail.com>
- Loading branch information
Showing
7 changed files
with
96 additions
and
36 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <mxfile host="app.diagrams.net" modified="2022-06-08T07:00:26.881Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.61 Safari/537.36" etag="ag29IlhWKJK49O4gGGTI" version="19.0.1" type="device"><diagram id="C5RBs43oDa-KdzZeNtuy" name="main_chart">7V1bl5rIFv41vc6TvaBQhMe+xMycSbJyJpNk8jQLpVSmEQhgX/LrTxVQorVtLWgsUCoPaSmxLNn17fvedWXcrZ7fx060/Bi62L9Cmvt8ZdxfIYTsISJ/6MhLPqLrppaPLGLPLcbKgS/eL1wMstvWnouTnRvTMPRTL9odnIVBgGfpzpgTx+HT7m3z0N/91shZYDDwZeb4cPS756bLfNRC43L8N+wtlunm99n5OyuH3Vz8kmTpuOHT1pDx7sq4i8MwzV+tnu+wT58eey7ff3/57n94MN//93/JT+fr7R9/ffo2yCebVPnI5ifEOEhrT/1z+uljPPj4HScPTy/u6v7906en4iPao+Ovi+dV/Nb0hT3AOFwHLqaTaFfG7TJd+eSlTl7+i9P0pSC4s05DMhTG6TJchIHjfwjDqLhvHgZpcZtOr3Hg3lDCkuupH84e8qGJ57OJyVVxv0WukjQOHza0Q3SEEYIuyHem2L91Zg+LbKF3oR/G5K0gDDCdyiWbofgt5eLelaO3+NlL/6ZzXY+Kqx9sGeT1/XPxNdnFS3EhSI+Cbkm4jmf4ABF0vdhyqRMvcHrozvw++qu2dndB7/c4XOE0fiE3xNh3Uu9xFwJOgaTF5r7NRz+HHvklSHtm2C0+wkDPIMCmyH9S8alyz5EXW8soh7KdWGFX6mBX3mQf+hy6GVfAV3RBpk8e1e00Jq8W9FW8DgIvWFwZE7iHl+FquiaLv31aein+EjkZQZ4Iz9vd0ztbi27cibPyfPoYfsP+I069mcPtaLohHd9bBORiRvYDjsGezSYmX5kt7t4sr/7KMDIYVt5SjzhO8fPBLVC8O9R2Kcm491PJC3UG+uUWH7S01zfNDrmr0hYB2t45Af2i2QwnCX3HcyBt/7DoW+SRxfQmReEDFN4MtEZiA5D4Hkd++LLCGZPxKCmTdU5vRcotUiKta2gdAlJ+CgHBjgtZ+TrE27SGQidgWsCPHf1gv05AtkL88vf2xdan6GX5seyKfS5fKFvAFTLG727Md2xHvzbOHreoaiisiggqIoagIsI2crE/6+ol7JZwPk/wjsoBdZfxLoYMQ0x3ARPxYNz8CDZR/pDARGRfOi9bt0X0huQUatIIgDMXkzN/nVDWBqRoxnmdR8cj259uH8J7TWdFuWowTaINY1O8mO4bs2u82DxXXtykPVeDMx/msCUnfZ3j1uXtDTNnQ5A5jzrLnDfMuPhquyZvHvGKkibGm5vivGMFxQ4pSSIQbhiKI0EoWmcDRSTo44FYRPX0pKawaAEsfo5xlDuJOH3oVc+mflzB4VWXhe9Q83Vre+5oLTvqEMHf1p58Z04md3f7drU5vrm1JydUanhata/U2IB63xzf/U9GtqUTZ/6CAGqyL2RzZkv0VxlcolB5Eg5prxsCtkZoxhW2KP0DJwcweY4i8ajEPyKuiLS6Nc19rGHzTp14RSl2S0n7Y0fQStFfRYWmXU1oIonOBZ2DlVlTaPITGZIVWH1PiMV1ycBe7qvtYbdKmPI8dqgJ8tjhyXgsUnaJVAbZObtEOJAsGkmWb5gM7aYMk2MWzql5LIyDfU1wPuAOKC8dhBGOnZRuCqW8loQzrc4przAOppTXNyivMnxGbXHWiqExidrrkGeIdbVXfiLp2iuMfDlR5L8UvPVqX3bQygm8OU7or1C5B3uYrq5xPvWNr6g9rgsjXoyuDl1DjOfZqPlzTXMwCXlSmlR6Q78VTRZeulxPr2chMVkmj65Dlkf+ZttjksYY0yU5uV9wkhk75ftG/ofNy7bQxHsubaGt/eTMZmHsUqLR3FaKfcKzs3vILqPpqcWiyfwOm0vZT1upxN3ZcTCwUyprkKds1LciqSnLQFQJiAeVOWEr+XREhhGDKkROl1SHJ8Kagl+R+gCpO4BnGF5Qenu/nM66aNYE4/0dVNx1Psm3duKEyTlXQHbciTV39tAUIOUDsmlgjUWBVTEJQiKwxiMODuOauOInGkpOgkAwntM/z38DiX41/FOtyavupvnpiE8/qCuvjGPZ3KfGFVK46nfSrS6atcC8VZ3EIwejIR+CFs5bMPQjM50akDCoJsMnyIXrkOEFSerQ5fJOwj8LKmeOQDere1P+v73uAmvYNc8QOttyN8XtJRs1qLsVcBafW1a3Ag4AVDavh2G+Vnj9OlrEDo3vDNIlHhAGl3hhADn/1+y2VxI8lAgQ8RibrdeuI1VlV8+71KQIaNdhbImKgO4a4LwIGI7qigDer8VPdGoRAAOyyl/cr8QrYTxWdYi16Gce1vWH8RONDO1a2/qH5KITRtK/5flXN4utXi+qMZNAr5dx66V4SAXLG+W1ZxgsF409oO6G9ECSa13VB0zE8+wTM1f29TvlA3mSIeOuiefimaOqBw6WZbXPWI09xXYcBfe36lGCU6CGvQP0RYC+90SOUc+S5q22EoAPdmJSBH7FKdQBAsOg05c0jDPKaoqU4qS0Wq/kMmCIp2wXgp/JAyT6YEa+gr53V1nKL62CXkeuk9L7ytz/3ntw+RhBBygMowbfcOzNM3WUr93oPf14hJZlQO0RELrglR3aL58fs32O9yGtWMcu0RDlffAmnxIqnHOjHZvp1JaoanfXVlpEw7hCor50BsAOxrZ03WgKWHyvYOnAgv5zZTg25/npgC4KXep/ldmBFIJIczmK914l5U2K9u1/tiBFxjf46dpH41AVyVyIHsPU/uN6DOqsHsM34LU0+9re+mfVU2r4ipkj055Yw2HHxynISYdcV0x5JArVim0/JULVHJ0EqnwxdstQhUEO5XbrWfqHMFa72+RsT4ZcPXSCifja8FPjURUjXYq2ej61Qg1JNt6EtyW3Xh3CGKCSZT2TZaK5jMb5pI1bw0bQCaa120wiH6pwb++xKuzO6XDecTVjrm4T85ZtRBUJ7nl1pHhmRkWoDiRitR+uVxhc7h9WL8eNKpq5wSyvDhqb/XCjqiq61tTZE2Gug9rmiN/zzViGQ/58SE3yyQ6MQ2yjJ8/Zvvv8FWZDJesoCrNjym6+/Y1UNtTBA8zbz+wewQSM27WXFYzz6TPalOXrJ9if08UE9LZ1doCSl+5p0x7DsbKyY3MErPZEVp5tltc5cl8zdLqwQ5BSWi+jj+2ou3oo76qxDzfRqHsQtq5J7pc2UhH8vntSR6LumdGws7ot33jBHjcCT6Db6pKDkuyRq8LEWurrhlztKScwqsw6chBml+n/ygApKch3OCpPMWmPgirW2HcJKVwCN+puXgDfzr328Qr8RGPJOW4jGE8sOCnS3jspfnJeVGucN8jMDnBcVeJ4UgobrRfHjWDAQ6m14gQctl4Wx1aklKLe9tsYiR57YHbXbQD6bdRt/Aj8eAB6J9aKTBgmKdrqfriF4nKjJ2WdyPh3yV9nRRlpME3oH6U3iViqZuuBEBMpptwWU26auXbXkOQjIXr9g/qA6SGbacLgh4oc1o8cnqFnR1iJGVXM62kxNKlrdQEJwh0bhMoCJAx3MN8Or6TchauIbOBgT1qHcva8prSAzo3tO3tMGCBRfXIqZ+G079Ix1SFYl5KF0wdRBxA0lJy1aqpTqho11s5R+RQOK1ZscyOzLorPvClbbb718JSy1aYsSKq4U5NKCt/QoQvKpiq06TvTZSZmc0y32O4D7Xo82tnwZ+mU4yvj4EyvcGGywbOIArstojcke34W6yjBs4dhYcMIeye4D9AijWwNjQoFJoOUXSPdrulIoFOYY5jnZDjVjnTyWhqY6cRa2hhGOpXD6JhwKsu0uqOMjREgpEoCEtem23f5jVX47EJcfqaoJ4Ix3w6KOD6Xp74KzB9gL6wCNybiYBhMmak9M1OFEYmqIbJfRmljiIRRSiXq5GSKNAwslll13JrrrqgDnnKjMZ+7IdnnPlZh4567V5AgHqumRErEI18SVx+PYCbZx8uNYVj692AR44QGumZhMPcWr0TBZmEc41mqYmAHs8THrVekj1WUs0kKgyTm9usAxqq67i0EbB+ibGLl4n5LTmT7QLTU4YE9V26ZEXncjdPd2OEFabcWAoBUjtWeOVaFETmuhkiJjlWbD3XURiScSbL/x1IxxAuJIVbFi0QJZvNyp7mS1bHkCjkLhgYVXnqlUo5FI4PMrOkiIPk6RIOvvqldx2NKbqBrqWMD+65SCiOSOeaUSnlSRMKQYt4Kh3dr33vJLHzE8b7ycr4HjqopFw5x2K0nJlowiKVCHA16yDtAYRjEUh7yyh7yDtARhqqUOXOW5j+TusfNku76CUDCos1vfGGzBAhFyZ5u9ksUsPrqJ7BEW1tZ3Q09lcVlIDhfGZEctpEm2XNnw2CwchT0zFEgCkkbVYNki+cI6GZTBwnoY97lcGpEIoBIZhg6VAGO8TwbNX+uwzQDYxqRld3QhaDJwkuX6+n1LFyRi4f1FMcBTnEySLxFQpdDFufNyCWOHzMHQzEJMzjB+37+7sTZckGoxnZ1nRBW6+WttjpZre/8njGY4yqYeT783uItmdr83pLcOcCGsdN7HPkhfbA8O87Pkp2Hvh8+Zcd17bqDTycnDC9IUsendA0DKDZ+wzHeLyx6794CbsoOyABVNngh7q2qGrlEI9nga/jAiVy1s1ssyQ3Z7T2hO1W5IMrwkNb6uUC26mrad6VX2O9od1fpBe77ce12WWAmyZ0LbBgpVYjsFyJFM97Px+mI6sKx7cNL7T2lmSo3SZpbsBxoTUPS2QoUQ+4tQxbOlWDs4gxYsm43VhVoS2bKugZDsypfsEG7tAtcFwESq4TBqgmDnSCkKhi8FJeqLSgFN/y5g85Xvik9bTtRTwwavK5qSK5k0jVVW9jznMEN0gQw2d2ACKgutJuqLkRIOiZhBFFFRMQ1T6P1Xk66BmNayt7vl71fha12+OBvPs5c2+KHM0m3+FWcsu+grGB+VCyQaDMwUvtcH8SLzqF0VQdGKm8C+lijOJz6eAWdcPh5hiP6G9Jl3oJ26cSqAe3hCMiw9aQ4XVOnMHaA+bZqaKIL4L0g765+V6mj/alOzXuZdb4FyQ+ZT3yFyX8PAdn1ZDHTcJ2WdmfBlq/3BqhFs6P/JT/pOvEJjIoMafIFE7IKd0AuV+vASwmVJgR4MXb/8YJHwr3J9a904E7Rw4sdDgd//mNHKPkWWc9/Pv1KvznWYh58voGZ01/ol6jUaTG7uQNSQlf1ks1IiW5w/A0nP87zGTPqIM/nLVdUm+eDmUDDpZPzfAQAptz9cs406ogJXAGTqCImW+za8YbsQF4MjmT7pXRVNNoB06hdUIoeUIZETaNidw+0a6u9E+pbT+Gtej69rnHcgB1YL8o9uPuvTnI8va7DoP0VGlKjbT3Fs5ROkGc3RaFLfWSDMNfqD+U3aWJmzxbwJtm/o9DnLB4t+3dS79funmMqz7ZVY+6xavgmMw1aNTCey5Nr5q+TFMcDL5hDdewCiWSMRsepZMilEozZ5lRaYn+V8cuIwsj3DkbdL5ZChmG0TiEYwNtHIcd185von13PEx28fnQdJ7kO4wUZyKIHx3Sti6AnkZnXuxQdGmNAUcQq+SRRFIZ/9gsyj51HePmE0u1dMunjcfvIg9GbLymNuwHPge97UYKP08JJouzgyPu590zpB+Np9Il5M8e/Kd5Yea7r7yHIfD5Hs9k+y8A1p+bIPCGp2LkyDFDQf8pcpXLcp2wDbJHpXeD2nEgb22ZjhOzpgNsQnchlHNIIRKnuk4e6/Bi6mN7xfw==</diagram></mxfile> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Troubleshooting | ||
|
|
||
| When you have any problems with the Vald cluster, e.g., deployment, API, etc., this page will help resolve them. | ||
|
|
||
| ## Flow chart | ||
|
|
||
| The [flow chart](../troubleshooting/flow-chart.md) explains the Vald cluster troubleshooting flow for users and operators of the Vald cluster. | ||
|
|
||
| It mainly targets the deployment view, but it will help when users get the error as an API response, and the error is not due to the client-side. | ||
|
|
||
| ## Operation troubleshooting | ||
|
|
||
| The [operation troubleshooting](../troubleshooting/operation-troubleshooting.md) shows the popular troubleshooting for users of the Vald cluster. | ||
|
|
||
| It lists the prevalent troubles when getting a response from the Vald cluster. | ||
| It would be better to refer to the [API status](../api/status.md) page at the same time to understand the meaning of the error code. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| # Client Side Troubleshooting | ||
|
|
||
| This page introduces the popular troubleshooting for client side. | ||
|
|
||
| The [flow chart](../troubleshooting/chart.md) helps you find the root reason for your problem. | ||
|
|
||
| Additionally, if you encounter some errors when using API, the [API status code](../api/status.md) helps you, too. | ||
|
|
||
| ## Insert Operation | ||
|
|
||
| ### Vald Agent NGT crashed at the insert process. | ||
|
|
||
| Please check your container limit of memory at first. | ||
| Vald Agent requires memory for keeping indexing on memory. | ||
|
|
||
| ```bash | ||
| kubectl describe statefulset vald-agent-ngt | ||
| ``` | ||
|
|
||
| If the limit of memory exists, please remove it or update the value to more enormous. | ||
|
|
||
| ## Search Operation | ||
|
|
||
| ### Vald returns no search result. | ||
|
|
||
| There are two possible reasons. | ||
|
|
||
| 1. Indexing has not finished in Vald Agent | ||
|
|
||
| Vald will search the nearest vectors of query from the indexing in Vald Agent. | ||
| If the indexing process is running, Vald Agent returns no search result. | ||
|
|
||
| It will resolve when completed indexing instructions, like `CreateIndex`. | ||
|
|
||
| 1. Too short timeout for searching | ||
|
|
||
| When the search timeout configuration is too short, Vald LB Gateway stops the searching process before getting the search result from Vald Agent. | ||
|
|
||
| In the sense of search operation, you can modify search timeout by [payload config](../api/search.md). | ||
|
|
||
| <div class="notice"> | ||
| It is easy to find out which problem occurs by inspections the log of each Pod, like <a href="https://github.com/wercker/stern">stern</a>. | ||
| </div> | ||
|
|
||
| ## Others | ||
|
|
||
| ### Vald Agent NGT crashed when initContainer. | ||
|
|
||
| Vald Agent NGT requires an AVX2 processor for running. | ||
| Please check your CPU information. | ||
|
|
||
| --- | ||
|
|
||
| ## Related Document | ||
|
|
||
| - [Provisioning Troubleshooting](../troubleshooting/provisioning.md) | ||
| - [API Status](../api/status.md) | ||
| - [FAQ](../support/faq.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Provisioning Troubleshooting | ||
|
|
||
| This page shows the troubleshooting for the provisioning the Vald cluster. | ||
|
|
||
| If you encounter the trouble, please confirm the below chart and try to fix it. | ||
|
|
||
| <img src="../../assets/docs/troubleshooting/provisioning_flow_chart.svg" /> | ||
|
|
||
| If any components output the `INTERNAL` error log, let us know the detail. | ||
|
|
||
| --- | ||
|
|
||
| ## Related Document | ||
|
|
||
| - [Client Side Troubleshooting](../troubleshooting/client-side.md) | ||
|
|
This file was deleted.
Oops, something went wrong.