feat: telemetry service #1243
Open
feat: telemetry service #1243
Conversation
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
leet4tari
approved these changes
Jan 8, 2025
brianp
reviewed
Jan 10, 2025
src-tauri/src/main.rs
Outdated
Comment on lines
277
to
279
| let telemetry_service = state.telemetry_service.clone(); | ||
| let telemetry_service = telemetry_service.read().await; | ||
| let telemetry_service = telemetry_service.deref(); |
There was a problem hiding this comment.
interesting. We can't just clone it, or borrow it. We have to deref it?
There was a problem hiding this comment.
Yes it's unnecessary, we can just use & to get reference to rw lock guard.
| @@ -265,6 +309,17 @@ async fn setup_inner( | |||
| sleep(Duration::from_secs(1)); | |||
| } | |||
|
|
|||
| drop( | |||
There was a problem hiding this comment.
Why do we have to drop after each call?
There was a problem hiding this comment.
Compiler complains if we ignore result of sending telemetry data. This workaround another possibility could be to write let _ = ...
src-tauri/src/telemetry_service.rs
Outdated
Comment on lines
180
to
191
| let hardware = HardwareStatusMonitor::current(); | ||
| let cpu_name = hardware.get_cpu_devices().await?; | ||
| let cpu_name = match cpu_name.first() { | ||
| Some(cpu) => cpu.public_properties.name.clone(), | ||
| None => "Unknown".to_string(), | ||
| }; | ||
| let gpu_name = hardware.get_gpu_devices().await?; | ||
| let gpu_name = match gpu_name.first() { | ||
| Some(gpu) => gpu.public_properties.name.clone(), | ||
| None => "Unknown".to_string(), | ||
| }; | ||
| let os = PlatformUtils::detect_current_os(); |
There was a problem hiding this comment.
Is it heavy to re-request this data constantly?
Most of this won't change. Could we get it once during initialization and cache it for each request?
There was a problem hiding this comment.
Good point, moved it to initialization.
MCozhusheck
force-pushed
the
feat/telemetry-service
branch
from
fdb9b19 to
7c5994c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Resolves #1186
Add new telemetry service which receives events and immediately sends them.
example event sent:
{ "app_id": "1b%i31CBnblWxHYxSanG", "cpu_name": "11th Gen Intel(R) Core(TM) i5-1135G7 @ 2.40GHz", "created_at": { "nanos_since_epoch": 439482034, "secs_since_epoch": 1734106140 }, "event_name": "checking-latest-version-mmproxy", "event_value": { "percentage": 10, "service": "mmproxy" }, "gpu_name": "Intel(R) Iris(R) Xe Graphics [0x9a49]", "os": "Linux", "user_id": "v3,FZNcifkHKvDUJ9Luwc4xBe5HiGHV,0.8.24,VWE2AdhnnMOqNDd7fcQnqVVEBAeee68KBM2+8K7iznY=", "version": "0.8.24" }Motivation and Context
This should be useful for tracking how many users are stuck during application setup. We saw some users being stuck at 30% with now feedback. This should help in debugging issues like that.
How Has This Been Tested?
Run application and watch for error message coming from telemetry service. If no error are present that means that events were sent correctly. Also check the telemetry dashboard to check if any messages are present on the server.
To verify frontend command I created test button to invoke like this:
And found those event present in the kafka dashboard:
What process can a PR reviewer use to test or verify this change?
Same as above.
Breaking Changes