Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

analytics: streamlining host vs. recorder python/rust versions #1380

Merged
merged 6 commits into from
Feb 23, 2023

Conversation

teh-cmc
Copy link
Member

@teh-cmc teh-cmc commented Feb 22, 2023

We can actually avoid this issue entirely: the python version that corresponds to the machine the user is running on (i.e. the machine that hosts the viewer) should never be included in events, it should only be part of the user profile (along with the rust version that's already there) i.e. update_metadata.

The viewer_started event then only keeps track of the app environment, while the open_recording event always keeps track of the python_version that corresponds to the machine doing the recording, never the host. We can also put the rust version of the machine doing the recording in there, for consistency.

That way everything becomes consistent and relatively straightforward to reason about:

* The python & rust versions seen in user profiles (`update_metadata`) are those of the host machine (the one hosting the viewer).

* The python & rust versions seen in events correspond to the machine doing the recording.

@teh-cmc teh-cmc added 🐍 Python API Python logging API 🦀 Rust API Rust logging API labels Feb 22, 2023
Copy link
Member

@emilk emilk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks god, except I don't see the point of passing CARGO_PKG_RUST_VERSION via AppEnvironment::RustSdk

crates/re_log_types/src/lib.rs Outdated Show resolved Hide resolved
crates/re_log_types/src/lib.rs Outdated Show resolved Hide resolved
crates/re_viewer/src/lib.rs Outdated Show resolved Hide resolved
Comment on lines 92 to 101
// The Python/Rust versions appearing in user profiles always apply to the host
// environment, _not_ the environment in which the data logging is taking place!
if let AppEnvironment::RustSdk(version) = &app_env {
event = event.with_prop("rust_version".into(), version.clone());
} else {
event = event.with_prop(
"rust_version".into(),
env!("CARGO_PKG_RUST_VERSION").to_owned(),
);
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are in the re_viewer crate here - how could the version in AppEnvironment::RustSdk ever differ from CARGO_PKG_RUST_VERSION? Seems like it is the same thing, just with a lot more steps?

Copy link
Member Author

@teh-cmc teh-cmc Feb 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can't differ, I just wanted the code to be perfectly symmetric on both sides to reflect that the versions that appear in AppEnvironment vs. RecordingSource are in fact two sides of the same coin basically.

I still think the symmetry in code is nice for comprehension, though I agree this if/else statement is quite fugly... The only reason it is there is because RerunCli doesn't carry its version around right now, but it should I think.

Comment on lines 156 to 157
self.register("rust_version", version.to_string());
self.deregister("python_version"); // can't be both!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we should call these recording_rust/python_version for clarity, and the other for viewer_rust/python_version?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hesitated about doing so but in my experience this always turns out to be a mistake that make even the simplest queries become awful to write.

E.g. you want everything with a rust_version, and now you have to do weird things; and soon it won't be 1 field that has these annoying quirks, it'll be 10, then 100 of them...

@teh-cmc teh-cmc merged commit 92c8ef3 into main Feb 23, 2023
@teh-cmc teh-cmc deleted the cmc/analytics/host_vs_recording branch February 23, 2023 16:23
@emilk emilk added the 📊 analytics telemetry analytics label Feb 28, 2023
emilk pushed a commit that referenced this pull request Mar 2, 2023
* streamline host vs recording python/rust versions

* can't have it all

* just format

* no anonymous strings

* the Rerun CLI does carry a Rust version too

* fmt
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📊 analytics telemetry analytics 🐍 Python API Python logging API 🦀 Rust API Rust logging API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants