|
| 1 | +use std::{ |
| 2 | + sync::Arc, |
| 3 | + time::{Duration, SystemTime, UNIX_EPOCH}, |
| 4 | +}; |
| 5 | + |
| 6 | +use async_trait::async_trait; |
| 7 | +use graphql_parser::schema::Document; |
| 8 | +use hive_console_sdk::agent::{AgentError, ExecutionReport, UsageAgent, UsageAgentExt}; |
| 9 | +use hive_router_config::usage_reporting::UsageReportingConfig; |
| 10 | +use hive_router_plan_executor::execution::{ |
| 11 | + client_request_details::ClientRequestDetails, plan::PlanExecutionOutput, |
| 12 | +}; |
| 13 | +use ntex::web::HttpRequest; |
| 14 | +use rand::Rng; |
| 15 | +use tokio_util::sync::CancellationToken; |
| 16 | + |
| 17 | +use crate::{ |
| 18 | + background_tasks::{BackgroundTask, BackgroundTasksManager}, |
| 19 | + consts::ROUTER_VERSION, |
| 20 | +}; |
| 21 | + |
| 22 | +#[derive(Debug, thiserror::Error)] |
| 23 | +pub enum UsageReportingError { |
| 24 | + #[error("Usage Reporting - Access token is missing. Please provide it via 'HIVE_ACCESS_TOKEN' environment variable or under 'usage_reporting.access_token' in the configuration.")] |
| 25 | + MissingAccessToken, |
| 26 | + #[error("Usage Reporting - Failed to initialize usage agent: {0}")] |
| 27 | + AgentCreationError(#[from] AgentError), |
| 28 | +} |
| 29 | + |
| 30 | +pub fn init_hive_user_agent( |
| 31 | + bg_tasks_manager: &mut BackgroundTasksManager, |
| 32 | + usage_config: &UsageReportingConfig, |
| 33 | +) -> Result<Arc<UsageAgent>, UsageReportingError> { |
| 34 | + let user_agent = format!("hive-router/{}", ROUTER_VERSION); |
| 35 | + let access_token = usage_config |
| 36 | + .access_token |
| 37 | + .as_deref() |
| 38 | + .ok_or(UsageReportingError::MissingAccessToken)?; |
| 39 | + |
| 40 | + let hive_user_agent = UsageAgent::try_new( |
| 41 | + access_token, |
| 42 | + usage_config.endpoint.clone(), |
| 43 | + usage_config.target_id.clone(), |
| 44 | + usage_config.buffer_size, |
| 45 | + usage_config.connect_timeout, |
| 46 | + usage_config.request_timeout, |
| 47 | + usage_config.accept_invalid_certs, |
| 48 | + usage_config.flush_interval, |
| 49 | + user_agent, |
| 50 | + )?; |
| 51 | + bg_tasks_manager.register_task(hive_user_agent.clone()); |
| 52 | + Ok(hive_user_agent) |
| 53 | +} |
| 54 | + |
| 55 | +#[inline] |
| 56 | +pub fn collect_usage_report( |
| 57 | + schema: Arc<Document<'static, String>>, |
| 58 | + duration: Duration, |
| 59 | + req: &HttpRequest, |
| 60 | + client_request_details: &ClientRequestDetails, |
| 61 | + hive_usage_agent: &Arc<UsageAgent>, |
| 62 | + usage_config: &UsageReportingConfig, |
| 63 | + execution_result: &PlanExecutionOutput, |
| 64 | +) { |
| 65 | + let sample_rate = usage_config.sample_rate.as_f64(); |
| 66 | + if sample_rate < 1.0 && !rand::rng().random_bool(sample_rate) { |
| 67 | + return; |
| 68 | + } |
| 69 | + if client_request_details |
| 70 | + .operation |
| 71 | + .name |
| 72 | + .is_some_and(|op_name| usage_config.exclude.iter().any(|s| s == op_name)) |
| 73 | + { |
| 74 | + return; |
| 75 | + } |
| 76 | + let client_name = get_header_value(req, &usage_config.client_name_header); |
| 77 | + let client_version = get_header_value(req, &usage_config.client_version_header); |
| 78 | + let timestamp = SystemTime::now() |
| 79 | + .duration_since(UNIX_EPOCH) |
| 80 | + .unwrap() |
| 81 | + .as_millis() as u64; |
| 82 | + let execution_report = ExecutionReport { |
| 83 | + schema, |
| 84 | + client_name: client_name.map(|s| s.to_owned()), |
| 85 | + client_version: client_version.map(|s| s.to_owned()), |
| 86 | + timestamp, |
| 87 | + duration, |
| 88 | + ok: execution_result.error_count == 0, |
| 89 | + errors: execution_result.error_count, |
| 90 | + operation_body: client_request_details.operation.query.to_owned(), |
| 91 | + operation_name: client_request_details |
| 92 | + .operation |
| 93 | + .name |
| 94 | + .map(|op_name| op_name.to_owned()), |
| 95 | + persisted_document_hash: None, |
| 96 | + }; |
| 97 | + |
| 98 | + if let Err(err) = hive_usage_agent.add_report(execution_report) { |
| 99 | + tracing::error!("Failed to send usage report: {}", err); |
| 100 | + } |
| 101 | +} |
| 102 | + |
| 103 | +#[inline] |
| 104 | +fn get_header_value<'req>(req: &'req HttpRequest, header_name: &str) -> Option<&'req str> { |
| 105 | + req.headers().get(header_name).and_then(|v| v.to_str().ok()) |
| 106 | +} |
| 107 | + |
| 108 | +#[async_trait] |
| 109 | +impl BackgroundTask for UsageAgent { |
| 110 | + fn id(&self) -> &str { |
| 111 | + "hive_console_usage_report_task" |
| 112 | + } |
| 113 | + |
| 114 | + async fn run(&self, token: CancellationToken) { |
| 115 | + self.start_flush_interval(Some(token)).await |
| 116 | + } |
| 117 | +} |
0 commit comments