Skip to content

Commit 5d3b20b

Browse files
authored
chore: more documentation update (#206)
1 parent aa25e92 commit 5d3b20b

File tree

5 files changed

+32
-42
lines changed

5 files changed

+32
-42
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@
88
1.
99
1.
1010

11-
## Specifications
11+
## Photo (good) and/or Video (best) file attached that shows the issue
1212

13-
- Version:
14-
- Platform:
13+
url, or attachment
14+
15+
## Zipped file of your cloud logging data that shows the issue.
16+
17+
url, or attachment (search and replace sensitive strings, for instance vehicle ID or trip ID)

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ We also have demo data for:
1515

1616
### Loading Your Data
1717

18-
1. Export your Fleet Engine logs from Cloud Logging using this filter (customize as needed):
18+
1. Export your Fleet Engine logs from Cloud Logging using this filter (customize as needed): \
1919
```sql
20+
-- On-demand trips
2021
resource.type="fleetengine.googleapis.com/Fleet"
2122
AND (labels.vehicle_id="YOUR_VEHICLE_ID" OR
2223
labels.trip_id=("TRIP_ID_1" "TRIP_ID_2"))
@@ -30,6 +31,21 @@ AND (
3031
)
3132
```
3233

34+
```sql
35+
-- Scheduled tasks
36+
resource.type="fleetengine.googleapis.com/DeliveryFleet"
37+
AND (labels.delivery_vehicle_id="YOUR_VEHICLE_ID" OR
38+
labels.task_id=("TASK_ID_1" "TASK_ID_2"))
39+
AND timestamp >= "START_TIME" -- ISO 8601 format (YYYY-MM-DDTHH:MM:SS)
40+
AND timestamp <= "END_TIME" -- ISO 8601 format (YYYY-MM-DDTHH:MM:SS)
41+
AND (
42+
logName:"logs/fleetengine.googleapis.com%2Fcreate_delivery_vehicle" OR
43+
logName:"logs/fleetengine.googleapis.com%2Fupdate_delivery_vehicle" OR
44+
logName:"logs/fleetengine.googleapis.com%2Fcreate_task" OR
45+
logName:"logs/fleetengine.googleapis.com%2Fupdate_task"
46+
)
47+
```
48+
3349
2. Download the logs in JSON format and optionally zip them
3450
3. Import the JSON/ZIP file to Fleet Debugger
3551

docs/PlannedPaths.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
# LMFS Planned Paths
1+
# Planned Paths
22

33
Displays all planned routes for the vehicle.
4+
This data comes directly from Navigation SDK, but requires the enablement of restriced use logs.
5+
6+
We are also working on how we can integrate planned paths that are from server side routing. e.g routes from before navigation SDK guidance started.
47

58
![Screenshot](screenshots/planned_paths.png)

docs/Speed.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# Speed
22

3-
Lorem ...
4-
53
![Screenshot](screenshots/speed.png)

docs/reporting-issues.md

Lines changed: 5 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,6 @@
1-
# Generating Bundle
2-
To generate a support bundle for reporting issues with either debugger or the full ODRD/LMFS solution run the following commands:
1+
# Data file
32

4-
```
5-
# Generate data files for reporting issues
6-
dune-buggy.js historical --apikey nokey --vehicle=my-vehicle-id
7-
# build sharable, static artifact. Any webserver should be able to host this.
8-
npm run build
9-
tar -czf support-dump.tgz build
10-
```
11-
12-
The generated support-dump.tgz file can be included in bug reports & communication with support.
13-
14-
# Viewing Bundle
15-
16-
The view-bundle.sh script starts a simple webserver and attempts to open a browser window with the
17-
correct url (including specifying a valid API key).
18-
19-
```
20-
tar -xzf support-dump.tgz
21-
cd build
22-
./view-bundle.sh
23-
```
24-
25-
Note that any simple http server can be used to serve the index.html file in the build directior. The following
26-
would suffice:
27-
```
28-
python3 -m http.server
29-
```
30-
31-
# Viewing bundle with newer version of the debugger
32-
33-
The data used in the debugger is contained within the data.json file. This file can be copied
34-
out of support bundle and placed in the 'public' directory of a fleet-debugger github repo.
35-
Once copied, 'npm start' in the fleet-debugger repo will let this bundle be viewed with the
36-
newer UI.
3+
Since all the data is in the browsers local storage only, sending deep link url's is not really a feature. This would only center the map.
4+
For this reason, if you experience an issue zip compress your cloud logging json file that reporoduces the issue.
5+
Search and replace sensitive strings, for instance vehicle ID or trip ID before sending this file in a bug report or similar.
6+
S

0 commit comments

Comments
 (0)