Skip to content

Commit ec0cd86

Browse files
authored
chore: Update Readme with recent changes. (#225)
1 parent b3bb304 commit ec0cd86

File tree

3 files changed

+43
-18
lines changed

3 files changed

+43
-18
lines changed

README.md

Lines changed: 43 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,28 @@ A visualization and debugging tool for Google Maps Platform's Mobility Solutions
66

77
## Using the Demo Site(s)
88

9-
The fastest way to get started is using our GitHub hosted site \
9+
The fastest way to get started is using our GitHub hosted site: \
1010
https://googlemaps.github.io/fleet-debugger/demos/multiple-trips
1111

1212
We also have demo data for:
13-
- [GPS accuracy issues](https://googlemaps.github.io/fleet-debugger/demos/jump/)
1413
- [Scheduled task](https://googlemaps.github.io/fleet-debugger/demos/lmfs/)
1514

1615
### Loading Your Data
1716

18-
1. Export your Fleet Engine logs from Cloud Logging using this filter (customize as needed): \
17+
Click on any empy Dataset buttons `Load Dataset` to get the `Fleet Engine Logs Loading` UI.
18+
19+
![Fleet Engine Logs Loading](docs/screenshots/Fleet_Engine_Logs_Loading.png)
20+
21+
#### Direct Cloud Logging Connection (Recommended)
22+
23+
1. **Configure Parameters:** Configure the Cloud Logging query parameters directly within UI.
24+
25+
2. **Connect to Cloud Logging:** The Fleet Debugger can connect directly to your Google Cloud project's Cloud Logging. Click the `Sign in and Fetch Logs` button and follow the prompts to authenticate and grant access. You'll need appropriate IAM permissions (`roles/logging.viewer` which is also granted via `roles/viewer`) for the Fleet Debugger to read logs.
26+
27+
#### Log Files in JSON Format
28+
29+
1. Export your Fleet Engine logs from Cloud Logging using one of the following filters (customize as needed):
30+
1931
```sql
2032
-- On-demand trips
2133
resource.type="fleetengine.googleapis.com/Fleet"
@@ -47,29 +59,41 @@ AND (
4759
```
4860

4961
2. Download the logs in JSON format and optionally zip them
50-
3. Import the JSON/ZIP file to Fleet Debugger
62+
3. Import the JSON/ZIP file to Fleet Debugger, using the `Load JSON or ZIP file instead` button.
5163

5264
> **Note**: All data processing happens client-side. Your logs remain in your browser's Local Storage and are not uploaded to Google/GitHub.
5365
5466
### Key Features
5567

56-
- Filter & inspect log messages with customizable table views
57-
- View planned navigation routes with traffic conditions as experienced by drivers
58-
- Replay vehicle movement (real time or time lapse)
59-
- See requested vs. actual pickup and dropoff points
60-
- View status changes (vehicle, trip, navigation)
61-
- Analyze GPS data (location, accuracy, heading)
62-
- Visualize multiple trips for one vehicle
63-
- View [GPS accuracy](docs/GPSAccuracy.md), [speed](docs/Speed.md), and [heading](docs/Heading.md)
64-
- Analyze [dwell times](docs/DwellTimes.md)
68+
- **Filter & inspect log messages:** Use customizable table views to easily find and analyze specific log entries.
69+
- **View planned navigation routes:** See the routes with traffic conditions as experienced by drivers (requires [Restricted Use Logs](#restricted-use-logs)).
70+
- **Replay vehicle movement:** Observe vehicle movement in real time or at an accelerated time-lapse.
71+
- **See requested vs. actual pickup and dropoff points:** (requires [Restricted Use Logs](#restricted-use-logs)).
72+
- **View status changes:** Track changes in vehicle, trip, and navigation status.
73+
- **Analyze GPS data:** Examine location, accuracy, and heading information.
74+
- **Visualize multiple trips:** View all trips for a single vehicle.
75+
- **Analyze GPS accuracy, speed, and heading:** Detailed analysis tools for these metrics ([GPS accuracy](docs/GPSAccuracy.md), [speed](docs/Speed.md), [heading](docs/Heading.md)).
76+
- **Analyze dwell times:** Measure time spent at specific locations ([dwell times](docs/DwellTimes.md)).
77+
- **Map and Timeslider Interaction:** Click directly on the map or the timeslider to select the nearest log event.
78+
- **Tracking (Chevron):** Use the tracking button to keep the map centered on the current event during replay.
79+
- **Exporting Logs:** Export loaded dataset to a local file for easy collaboration.
6580

66-
> **Note**: Planned navigation routes and Pickup/DropOff points requires enablement of [Restricted Use Logs](https://developers.google.com/maps/documentation/mobility/operations/cloud-logging/setup#enable_restricted_use_logs)
81+
### Restricted Use Logs
82+
83+
Planned navigation routes and requested Pickup/Dropoff points require enablement of [Restricted Use Logs](https://developers.google.com/maps/documentation/mobility/operations/cloud-logging/setup#enable_restricted_use_logs).
84+
85+
### Managing Datasets
86+
87+
Each dataset (loaded from a file or Cloud Logging) has a dropdown menu:
88+
89+
- **Save (Export):** Save the current dataset as a JSON file.
90+
- **Delete:** Remove the dataset from the Fleet Debugger. This clears the data from your browser's local storage.
6791

6892
### Restoring Demo Data
69-
To restore the original demo data after overwriting it:
70-
1. Long press the "Dataset 1" button
71-
2. When prompted, do NOT upload a file
72-
3. Refresh the page
93+
94+
To reload the original demo data:
95+
1. Select "Delete" from `Dataset 1` dropdown menu.
96+
2. Refresh the page. The demo data will be automatically reloaded into Dataset 1.
7397

7498
## Running Your Own Server
7599

@@ -84,6 +108,7 @@ npm install
84108
```
85109

86110
### Start development server
111+
87112
```bash
88113
npm start
89114
```
29.7 KB
Loading

docs/screenshots/vehiclereplay.gif

2.23 MB
Loading

0 commit comments

Comments
 (0)