Skip to content

Commit ca8902f

Browse files
svenvg93gitbook-bot
svenvg93
authored and
gitbook-bot
committed
GitBook: No commit message
1 parent 9f8703e commit ca8902f

File tree

2 files changed

+136
-22
lines changed

2 files changed

+136
-22
lines changed

‎help/error-messages.md‎

Lines changed: 136 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,92 @@
11
# Error Messages
22

3-
### Speedtest errors
3+
### Troubleshooting
4+
5+
For all below errros there will be more information provided in the container logs. You can check the logs for more details by checking the container logs by running;
6+
7+
`docker logs speedtest-tracker` 
8+
9+
or any other equivalent command for your setup. 
10+
11+
<details>
12+
13+
<summary>Enable Debugging</summary>
14+
15+
By default `APP_DEBUG` is set to `false` in production to prevent verbose error outputs. To debug the issue follow the steps below.
16+
17+
1. Set `APP_DEBUG=true` as a environment variable
18+
2. Restart the container
19+
3. Reproduce the error by visiting the page or performing the action that caused the error
20+
4. View the output in the UI or in the logs to help resolve the issue, if you can not resolve it open an issue in the [GitHub](https://github.com/alexjustesen/speedtest-tracker/issues) repository
21+
5. In the output the line that starts with `[timestamp] production.ERROR:` is the error the server ran into
22+
6. Once the issue is resolved you can remove the `APP_DEBUG` environment variable
23+
24+
</details>
25+
26+
### Application
27+
28+
<details>
29+
30+
<summary>I'm getting a <code>500 | SERVER ERROR</code> error</summary>
31+
32+
The `500 | SERVER ERROR` is caused by either a bug or a misconfiguration. You must e[nable debugging](error-messages.md#enable-debugging) to determine the exact cause of the error.
33+
34+
</details>
35+
36+
<details>
37+
38+
<summary>Unsupported cipher or incorrect key length. Supported ciphers are: <code>aes-128-cbc</code>, <code>aes-256-cbc</code>, <code>aes-128-gcm,</code> <code>aes-256-gcm</code>.</summary>
39+
40+
This error is shown when the `APP_KEY` is not set or not set correctly. Make suer you set the `APP_KEY` as described in the [installation steps](../getting-started/installation/using-docker-compose.md#install-with-docker-compose).
41+
42+
</details>
43+
44+
### Speedtest Process
445

546
<details>
647

7-
<summary>Tests are saying there is no internet while there is.</summary>
48+
<summary>Failed to connected to hostname</summary>
49+
50+
When a speedtest is being [processed](../other/speedtest-process.md) Speedtest Tracker will make a ICMP ping to [icanhazip.com](http://icanhazip.com) to check if there is an internet connection before starting the Speedtest
851

9-
When a speedtest is being processed Speedtest Tracker will make a call to [http://icanhazip.com](http://icanhazip.com) to get your external IP address. This is done to determine if your server has access to the internet and to check if your external IP address (WAN IP) should be skipped.
52+
**Possible reasons**:
1053

11-
Some DNS blocks lists will block this domain, if you're getting errors and your server has access to the internet you'll need to add this to your allow lists.
54+
* There is a docker network problem or no internet connection.
55+
* Some DNS blocks lists will block this domain, if you're getting errors and your server has access to the internet you'll need to add this to your allow lists.
56+
* _Most_ Docker setups can send ICMP requests without needed elevated privileges on the host or in the container. That being said if your Docker user doesn't run with elevated permissions or doesn't belong to the Docker group you can get a failure on this step. To allow the user to send ICMP requests you need to add the permission to the container.
57+
58+
**Configuration options**
59+
60+
* Use available [Environment Variables](../getting-started/environment-variables.md#speed-tests) to change the endpoint to your liking
1261

1362
</details>
1463

15-
### Ookla errors
64+
<details>
65+
66+
<summary>Failed to fetch external IP address</summary>
67+
68+
When the `SPEEDTEST_SKIP_IPS` environment variable is Speedtest Tracker will make a call to [http://icanhazip.com](http://icanhazip.com/) to get your external IP address. This is done check if your external IP address (WAN IP) should be skipped.
69+
70+
**Possible reasons**:
71+
72+
* There is a docker network problem or no internet connection.
73+
* Some DNS blocks lists will block this domain, if you're getting errors and your server has access to the internet you'll need to add this to your allow lists.
74+
75+
**Configuration options**
76+
77+
* Use available [Environment Variables](../getting-started/environment-variables.md#speed-tests) to change the endpoint to your liking. :warning: Whatever service you choose needs to only return an IP address in the body of the response for this to work.
78+
79+
</details>
80+
81+
<details>
82+
83+
<summary>Failed listing Ookla speedtest servers</summary>
84+
85+
86+
87+
</details>
88+
89+
### Ookla Related
1690

1791
<details>
1892

@@ -37,3 +111,60 @@ This usually means the defined server is no longer available. Remove it from you
37111
Not 100% sure what causes this exception yet but it's likely when the CLI can't locate a local server. You should specify a list of servers to see if that addresses the issue.
38112

39113
</details>
114+
115+
<details>
116+
117+
<summary>Unable to retrieve Ookla servers, check internet connection and see logs.</summary>
118+
119+
This errors is shown when we try to retrieve the Ookla server list when selecting an server wehn running an manual speedtest. We get the list from: [https://www.speedtest.net/api/js/servers](https://www.speedtest.net/api/js/servers).&#x20;
120+
121+
This error is useually caused by a docker network problem or no internet connection. You can check the [container logs](error-messages.md#troubleshooting) for more details.&#x20;
122+
123+
</details>
124+
125+
### InfluxDB
126+
127+
<details>
128+
129+
<summary>Failed to bulk write to InfluxDB</summary>
130+
131+
When Speedtest Tracker fails to write data to InfluxDB this error is shown. The [container logs](error-messages.md#troubleshooting) will show more details on why it failed.&#x20;
132+
133+
**Possible reasons:**
134+
135+
* Connectivity problem to InfluxDB
136+
* Problem with authentication
137+
* Specified bucket does not exist in InfluxDB
138+
139+
</details>
140+
141+
<details>
142+
143+
<summary>Failed to write test data to InfluxDB.</summary>
144+
145+
When Speedtest Tracker fails to write data to InfluxDB this error is shown. The [container logs](error-messages.md#troubleshooting) will show more details on why it failed.&#x20;
146+
147+
**Possible reasons:**
148+
149+
* Connectivity problem to influxdb
150+
* Problem with authentication
151+
* Specified bucket does not exist in InfluxDB
152+
153+
</details>
154+
155+
<details>
156+
157+
<summary>Failed to write to InfluxDB.</summary>
158+
159+
When Speedtest Tracker fails to write data to InfluxDB this error is shown. The [container logs](error-messages.md#troubleshooting) will show more details on why it failed.&#x20;
160+
161+
**Possible reasons:**
162+
163+
* Connectivity problem to influxdb
164+
* Problem with authentication
165+
* Specified bucket does not exist in InfluxDB
166+
167+
</details>
168+
169+
170+

‎help/faqs.md‎

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -55,20 +55,3 @@ Once set restart the container.
5555
Starting your cron schedule at an off-peak minute can help reduce network congestion or avoid overloading a speed test server. This [comment](https://github.com/alexjustesen/speedtest-tracker/issues/552#issuecomment-2028532010) on this issue can help you get the formatting right.
5656

5757
</details>
58-
59-
### Other
60-
61-
<details>
62-
63-
<summary>I'm getting a <code>500 | SERVER ERROR</code> error</summary>
64-
65-
By default `APP_DEBUG` is set to `false` in production to prevent verbose error outputs. To debug the issue follow the steps below.
66-
67-
1. Set `APP_DEBUG=true` as a environment variable
68-
2. Restart the container
69-
3. Reproduce the error by visiting the page or performing the action that caused the error
70-
4. View the output in the UI or in the logs to help resolve the issue, if you can not resolve it open an issue in the [GitHub](https://github.com/alexjustesen/speedtest-tracker/issues) repository
71-
5. In the output the line that starts with `[timestamp] production.ERROR:` is the error the server ran into
72-
6. Once the issue is resolved you can remove the `APP_DEBUG` environment variable
73-
74-
</details>

0 commit comments

Comments
 (0)