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.

Sign up for GitHub

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

Metrics: Include app-provided build information #713

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Metrics: Include app-provided build information #713

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
258ec84
Metrics: Include app-provided build information
pahearn73 Jan 14, 2025
68904ca
Metrics: Include app-provided build information: Removed debug
pahearn73 Jan 14, 2025
655debe
Merge branch 'main' into pahearn_RPPL-2872
pahearn73 Jan 28, 2025
38b4cfe
Metrics: Include app-provided build information: Bumped to schema ver…
pahearn73 Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions core/main/src/firebolt/handlers/metrics_rpc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -654,11 +654,17 @@ impl MetricsServer for MetricsImpl {
}
async fn app_info(&self, ctx: CallContext, app_info_params: AppInfoParams) -> RpcResult<()> {
trace!("metrics.app_info: app_info_params={:?}", app_info_params);
self.state
match self
.state
.app_manager_state
.set_app_metrics_version(&ctx.app_id, app_info_params.build);

Ok(())
.set_app_metrics_version(&ctx.app_id, app_info_params.build)
{
Ok(_) => Ok(()),
Err(e) => {
error!("Error setting app metrics version: {:?}", e);
Err(rpc_err("Unable to set app info"))
}
}
}
}

Expand Down
10 changes: 3 additions & 7 deletions core/main/src/processor/metrics_processor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,12 @@ pub async fn update_app_context(
if let Some(app) = ps.app_manager_state.get(&ctx.app_id) {
context.app_session_id = app.loaded_session_id.to_owned();
context.app_user_session_id = app.active_session_id;
context.app_version = ps
context.product_version = ps
.version
.clone()
.unwrap_or(String::from(SEMVER_LIGHTWEIGHT));

// TODO: Meeting 12/11/24 to discuss where version from Metrics.appInfo call should be used.
// If part of BehavioralMetricContext, un/comment below/above and modify send_behavioral
// to NOT populate app_ver using the context, get per above instead.

//context.app_version = app.app_metrics_version.unwrap_or(String::default());
context.app_version = app.app_metrics_version.clone();
}
if let Some(session) = ps.session_state.get_account_session() {
context.partner_id = session.id;
Expand Down Expand Up @@ -141,7 +137,7 @@ pub async fn send_metric_for_app_state_change(
if let Some(app) = ps.app_manager_state.get(app_id) {
context.app_session_id = app.loaded_session_id.to_owned();
context.app_user_session_id = app.active_session_id;
context.app_version = ps
context.product_version = ps
.version
.clone()
.unwrap_or(String::from(SEMVER_LIGHTWEIGHT));
Expand Down
7 changes: 5 additions & 2 deletions core/main/src/service/apps/delegated_launcher_handler.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,11 +344,13 @@ impl AppManagerState {
intents.remove(app_id)
}

pub fn set_app_metrics_version(&self, app_id: &str, version: String) {
pub fn set_app_metrics_version(&self, app_id: &str, version: String) -> Result<(), AppError> {
let mut apps = self.apps.write().unwrap();
if let Some(app) = apps.get_mut(app_id) {
app.app_metrics_version = Some(version);
return Ok(());
}
Err(AppError::NotFound)
}
}

Expand Down Expand Up @@ -559,10 +561,11 @@ impl DelegatedLauncherHandler {

let context = BehavioralMetricContext {
app_id: app_id.to_string(),
app_version: SEMVER_LIGHTWEIGHT.to_string(),
product_version: SEMVER_LIGHTWEIGHT.to_string(),
partner_id: String::from("partner.id.not.set"),
app_session_id: String::from("app_session_id.not.set"),
durable_app_id: app_id.to_string(),
app_version: None,
app_user_session_id: None,
governance_state: None,
};
Expand Down
19 changes: 13 additions & 6 deletions core/sdk/src/api/firebolt/fb_metrics.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ use super::fb_telemetry::{OperationalMetricRequest, TelemetryPayload};
#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
pub struct BehavioralMetricContext {
pub app_id: String,
pub app_version: String,
#[serde(skip_serializing_if = "Option::is_none")]
pub app_version: Option<String>,
pub product_version: String,
pub partner_id: String,
pub app_session_id: String,
pub app_user_session_id: Option<String>,
Expand All @@ -49,10 +51,11 @@ impl From<CallContext> for BehavioralMetricContext {
fn from(call_context: CallContext) -> Self {
BehavioralMetricContext {
app_id: call_context.app_id.clone(),
app_version: String::from("app.version.not.implemented"),
product_version: String::from("product.version.not.implemented"),
partner_id: String::from("partner.id.not.set"),
app_session_id: String::from("app_session_id.not.set"),
durable_app_id: call_context.app_id,
app_version: None,
app_user_session_id: None,
governance_state: None,
}
Expand Down Expand Up @@ -1103,11 +1106,12 @@ mod tests {
fn test_extn_request_behavioral_metric() {
let behavioral_metric_context = BehavioralMetricContext {
app_id: "test_app_id".to_string(),
app_version: "test_app_version".to_string(),
product_version: "test_product_version".to_string(),
partner_id: "test_partner_id".to_string(),
app_session_id: "test_app_session_id".to_string(),
app_user_session_id: Some("test_user_session_id".to_string()),
durable_app_id: "test_durable_app_id".to_string(),
app_version: Some("test_app_version".to_string()),
governance_state: Some(AppDataGovernanceState {
data_tags_to_apply: HashSet::new(),
}),
Expand Down Expand Up @@ -1170,11 +1174,12 @@ mod tests {
let behavior_metric_payload = BehavioralMetricPayload::Ready(Ready {
context: BehavioralMetricContext {
app_id: "test_app_id".to_string(),
app_version: "test_app_version".to_string(),
product_version: "test_product_version".to_string(),
partner_id: "test_partner_id".to_string(),
app_session_id: "test_app_session_id".to_string(),
app_user_session_id: Some("test_user_session_id".to_string()),
durable_app_id: "test_durable_app_id".to_string(),
app_version: Some("test_app_version".to_string()),
governance_state: Some(AppDataGovernanceState {
data_tags_to_apply: HashSet::new(),
}),
Expand Down Expand Up @@ -1251,11 +1256,12 @@ mod tests {
fn test_behavioral_metric_payload() {
let behavioral_metric_context = BehavioralMetricContext {
app_id: "test_app_id".to_string(),
app_version: "test_app_version".to_string(),
product_version: "test_product_version".to_string(),
partner_id: "test_partner_id".to_string(),
app_session_id: "test_app_session_id".to_string(),
app_user_session_id: Some("test_user_session_id".to_string()),
durable_app_id: "test_durable_app_id".to_string(),
app_version: Some("test_app_version".to_string()),
governance_state: Some(AppDataGovernanceState {
data_tags_to_apply: HashSet::new(),
}),
Expand All @@ -1275,11 +1281,12 @@ mod tests {

let new_behavioral_metric_context = BehavioralMetricContext {
app_id: "new_test_app_id".to_string(),
app_version: "new_test_app_version".to_string(),
product_version: "new_test_product_version".to_string(),
partner_id: "new_test_partner_id".to_string(),
app_session_id: "new_test_app_session_id".to_string(),
app_user_session_id: Some("new_test_user_session_id".to_string()),
durable_app_id: "new_test_durable_app_id".to_string(),
app_version: Some("test_app_version".to_string()),
governance_state: Some(AppDataGovernanceState {
data_tags_to_apply: HashSet::new(),
}),
Expand Down