Skip to content

Commit 43b0d47

Browse files
alexjustesengitbook-bot
authored andcommitted
GITBOOK-127: No subject
1 parent bcf3653 commit 43b0d47

File tree

2 files changed

+20
-14
lines changed

2 files changed

+20
-14
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >-
88
# Introduction
99

1010
{% hint style="info" %}
11-
Docs are up-to-date through version: `v1.5.0`
11+
Docs are up-to-date through version: `v1.6.0`
1212
{% endhint %}
1313

1414
<figure><img src=".gitbook/assets/dashboard.png" alt=""><figcaption></figcaption></figure>

other/speedtest-process.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,36 @@
11
# Speedtest Process
22

3-
Speedtest Tracker uses the [Official Ookla CLI](https://www.speedtest.net/apps/cli) client to execute the speedtest. There a couple of stages the Speedtest Tracker goes through, below explains the process.&#x20;
3+
Speedtest Tracker uses the [Official Ookla CLI](https://www.speedtest.net/apps/cli) client to execute the speedtest. There a couple of stages the Speedtest Tracker goes through, below explains the process.
44

55
{% stepper %}
66
{% step %}
7-
### Started
7+
#### Waiting
88

9-
The Speedtest process is started
9+
The speedtest run request was created but has not been started.
1010
{% endstep %}
1111

1212
{% step %}
13-
### Checking
13+
#### Started
14+
15+
The speedtest process has been started by a queue worker.
16+
{% endstep %}
17+
18+
{% step %}
19+
#### Checking
1420

1521
The application checks for an internet connection by calling `https://icanhazip.com`
1622
{% endstep %}
1723

1824
{% step %}
19-
### Skipped \[Optional]
25+
#### Skipped \[Optional]
2026

21-
If you have the `SPEEDTEST_SKIP_IPS` the test will be marked as skipped as the IP returning during `Checking` matches your defined IP.
27+
If you have the `SPEEDTEST_SKIP_IPS` the test will be marked as skipped as the IP returning during `Checking` matches your defined IP.
2228
{% endstep %}
2329

2430
{% step %}
25-
### Running
31+
#### Running
2632

27-
The application runs the speedtest by simply running the speedtest command. This command runs the speedtest like another other speedtest and returns the result in json format so the application an easily process it.&#x20;
33+
The application runs the speedtest by simply running the speedtest command. This command runs the speedtest like another other speedtest and returns the result in json format so the application an easily process it.
2834

2935
```
3036
speedtest -accept-license --accept-gdpr --format=json
@@ -38,20 +44,20 @@ speedtest -accept-license --accept-gdpr --format=json --server-id=YOURSERVERID
3844
{% endstep %}
3945

4046
{% step %}
41-
### Failed
47+
#### Failed
4248

43-
If for various reasons the Ookla CLI returns an error, because the defined server was offline for example the tests is marked as failed. As well when the `Checking` stage fails when there is no internet.&#x20;
49+
If for various reasons the Ookla CLI returns an error, because the defined server was offline for example the tests is marked as failed. As well when the `Checking` stage fails when there is no internet.
4450
{% endstep %}
4551

4652
{% step %}
47-
### Benchmarking
53+
#### Benchmarking
4854

4955
When you have thresholds set this step will evaluate the results against the threshold to determine if the test was healthy or not.
5056
{% endstep %}
5157

5258
{% step %}
53-
### Completed
59+
#### Completed
5460

55-
This is the end stage of the process when every step is completed the test is marked as such.&#x20;
61+
This is the end stage of the process when every step is completed the test is marked as such.
5662
{% endstep %}
5763
{% endstepper %}

0 commit comments

Comments
 (0)