snowykami/meilisearch
1
0
Fork 0
mirror of https://github.com/meilisearch/meilisearch.git synced 2024-11-30 09:04:59 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge #4074

Browse Source 
4074: Enable analytics in debug builds r=Kerollmops a=irevoire

# Pull Request

## Related issue
Fixes https://github.com/meilisearch/meilisearch/issues/4072

## What does this PR do?
- Stop disabling the analytics if meilisearch has been compiled in debug mode

Co-authored-by: Tamo <tamo@meilisearch.com>
This commit is contained in:
meili-bors[bot] 2023-09-21 15:54:41 +00:00 committed by GitHub
commit bb79bdb3f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 69 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
meilisearch/src/analytics/mod.rs
View File

@ -1,6 +1,5 @@
mod mock_analytics; mod mock_analytics;
// if we are in release mode and the feature analytics was enabled #[cfg(feature = "analytics")]
#[cfg(all(not(debug_assertions), feature = "analytics"))]
mod segment_analytics; mod segment_analytics;
use std::fs; use std::fs;
@ -17,26 +16,25 @@ use serde_json::Value;
use crate::routes::indexes::documents::UpdateDocumentsQuery; use crate::routes::indexes::documents::UpdateDocumentsQuery;
use crate::routes::tasks::TasksFilterQuery; use crate::routes::tasks::TasksFilterQuery;
// if we are in debug mode OR the analytics feature is disabled // if the analytics feature is disabled
// the `SegmentAnalytics` point to the mock instead of the real analytics // the `SegmentAnalytics` point to the mock instead of the real analytics
#[cfg(any(debug_assertions, not(feature = "analytics")))] #[cfg(not(feature = "analytics"))]
pub type SegmentAnalytics = mock_analytics::MockAnalytics; pub type SegmentAnalytics = mock_analytics::MockAnalytics;
#[cfg(any(debug_assertions, not(feature = "analytics")))] #[cfg(not(feature = "analytics"))]
pub type SearchAggregator = mock_analytics::SearchAggregator; pub type SearchAggregator = mock_analytics::SearchAggregator;
#[cfg(any(debug_assertions, not(feature = "analytics")))] #[cfg(not(feature = "analytics"))]
pub type MultiSearchAggregator = mock_analytics::MultiSearchAggregator; pub type MultiSearchAggregator = mock_analytics::MultiSearchAggregator;
#[cfg(any(debug_assertions, not(feature = "analytics")))] #[cfg(not(feature = "analytics"))]
pub type FacetSearchAggregator = mock_analytics::FacetSearchAggregator; pub type FacetSearchAggregator = mock_analytics::FacetSearchAggregator;
// if we are in release mode and the feature analytics was enabled // if the feature analytics is enabled we use the real analytics
// we use the real analytics #[cfg(feature = "analytics")]
#[cfg(all(not(debug_assertions), feature = "analytics"))]
pub type SegmentAnalytics = segment_analytics::SegmentAnalytics; pub type SegmentAnalytics = segment_analytics::SegmentAnalytics;
#[cfg(all(not(debug_assertions), feature = "analytics"))] #[cfg(feature = "analytics")]
pub type SearchAggregator = segment_analytics::SearchAggregator; pub type SearchAggregator = segment_analytics::SearchAggregator;
#[cfg(all(not(debug_assertions), feature = "analytics"))] #[cfg(feature = "analytics")]
pub type MultiSearchAggregator = segment_analytics::MultiSearchAggregator; pub type MultiSearchAggregator = segment_analytics::MultiSearchAggregator;
#[cfg(all(not(debug_assertions), feature = "analytics"))] #[cfg(feature = "analytics")]
pub type FacetSearchAggregator = segment_analytics::FacetSearchAggregator; pub type FacetSearchAggregator = segment_analytics::FacetSearchAggregator;
/// The Meilisearch config dir: /// The Meilisearch config dir:

109
meilisearch/src/analytics/segment_analytics.rs
View File

@ -48,7 +48,7 @@ fn write_user_id(db_path: &Path, user_id: &InstanceUid) {
if let Some((meilisearch_config_path, user_id_path)) = if let Some((meilisearch_config_path, user_id_path)) =
MEILISEARCH_CONFIG_PATH.as_ref().zip(config_user_id_path(db_path)) MEILISEARCH_CONFIG_PATH.as_ref().zip(config_user_id_path(db_path))
{ {
let _ = fs::create_dir_all(&meilisearch_config_path); let _ = fs::create_dir_all(meilisearch_config_path);
let _ = fs::write(user_id_path, user_id.to_string()); let _ = fs::write(user_id_path, user_id.to_string());
} }
} }
@ -60,8 +60,7 @@ pub fn extract_user_agents(request: &HttpRequest) -> Vec<String> {
.headers() .headers()
.get(ANALYTICS_HEADER) .get(ANALYTICS_HEADER)
.or_else(|| request.headers().get(USER_AGENT)) .or_else(|| request.headers().get(USER_AGENT))
.map(|header| header.to_str().ok()) .and_then(|header| header.to_str().ok())
.flatten()
.unwrap_or("unknown") .unwrap_or("unknown")
.split(';') .split(';')
.map(str::trim) .map(str::trim)
@ -91,6 +90,7 @@ pub struct SegmentAnalytics {
} }
impl SegmentAnalytics { impl SegmentAnalytics {
#[allow(clippy::new_ret_no_self)]
pub async fn new( pub async fn new(
opt: &Opt, opt: &Opt,
index_scheduler: Arc<IndexScheduler>, index_scheduler: Arc<IndexScheduler>,
@ -98,7 +98,7 @@ impl SegmentAnalytics {
) -> Arc<dyn Analytics> { ) -> Arc<dyn Analytics> {
let instance_uid = super::find_user_id(&opt.db_path); let instance_uid = super::find_user_id(&opt.db_path);
let first_time_run = instance_uid.is_none(); let first_time_run = instance_uid.is_none();
let instance_uid = instance_uid.unwrap_or_else(|| Uuid::new_v4()); let instance_uid = instance_uid.unwrap_or_else(Uuid::new_v4);
write_user_id(&opt.db_path, &instance_uid); write_user_id(&opt.db_path, &instance_uid);
let client = reqwest::Client::builder().connect_timeout(Duration::from_secs(10)).build(); let client = reqwest::Client::builder().connect_timeout(Duration::from_secs(10)).build();
@ -167,7 +167,7 @@ impl super::Analytics for SegmentAnalytics {
} }
fn publish(&self, event_name: String, mut send: Value, request: Option<&HttpRequest>) { fn publish(&self, event_name: String, mut send: Value, request: Option<&HttpRequest>) {
let user_agent = request.map(|req| extract_user_agents(req)); let user_agent = request.map(extract_user_agents);
send["user-agent"] = json!(user_agent); send["user-agent"] = json!(user_agent);
let event = Track { let event = Track {
@ -176,7 +176,7 @@ impl super::Analytics for SegmentAnalytics {
properties: send, properties: send,
..Default::default() ..Default::default()
}; };
let _ = self.sender.try_send(AnalyticsMsg::BatchMessage(event.into())); let _ = self.sender.try_send(AnalyticsMsg::BatchMessage(event));
} }
fn get_search(&self, aggregate: SearchAggregator) { fn get_search(&self, aggregate: SearchAggregator) {
@ -310,7 +310,7 @@ impl From<Opt> for Infos {
log_level, log_level,
indexer_options, indexer_options,
config_file_path, config_file_path,
#[cfg(all(not(debug_assertions), feature = "analytics"))] #[cfg(feature = "analytics")]
no_analytics: _, no_analytics: _,
} = options; } = options;
@ -379,10 +379,8 @@ impl Segment {
static SYSTEM: Lazy<Value> = Lazy::new(|| { static SYSTEM: Lazy<Value> = Lazy::new(|| {
let mut sys = System::new_all(); let mut sys = System::new_all();
sys.refresh_all(); sys.refresh_all();
let kernel_version = sys let kernel_version =
.kernel_version() sys.kernel_version().and_then(|k| k.split_once('-').map(|(k, _)| k.to_string()));
.map(|k| k.split_once("-").map(|(k, _)| k.to_string()))
.flatten();
json!({ json!({
"distribution": sys.name(), "distribution": sys.name(),
"kernel_version": kernel_version, "kernel_version": kernel_version,
@ -492,54 +490,54 @@ impl Segment {
} = self; } = self;
if let Some(get_search) = if let Some(get_search) =
take(get_search_aggregator).into_event(&user, "Documents Searched GET") take(get_search_aggregator).into_event(user, "Documents Searched GET")
{ {
let _ = self.batcher.push(get_search).await; let _ = self.batcher.push(get_search).await;
} }
if let Some(post_search) = if let Some(post_search) =
take(post_search_aggregator).into_event(&user, "Documents Searched POST") take(post_search_aggregator).into_event(user, "Documents Searched POST")
{ {
let _ = self.batcher.push(post_search).await; let _ = self.batcher.push(post_search).await;
} }
if let Some(post_multi_search) = take(post_multi_search_aggregator) if let Some(post_multi_search) = take(post_multi_search_aggregator)
.into_event(&user, "Documents Searched by Multi-Search POST") .into_event(user, "Documents Searched by Multi-Search POST")
{ {
let _ = self.batcher.push(post_multi_search).await; let _ = self.batcher.push(post_multi_search).await;
} }
if let Some(post_facet_search) = if let Some(post_facet_search) =
take(post_facet_search_aggregator).into_event(&user, "Facet Searched POST") take(post_facet_search_aggregator).into_event(user, "Facet Searched POST")
{ {
let _ = self.batcher.push(post_facet_search).await; let _ = self.batcher.push(post_facet_search).await;
} }
if let Some(add_documents) = if let Some(add_documents) =
take(add_documents_aggregator).into_event(&user, "Documents Added") take(add_documents_aggregator).into_event(user, "Documents Added")
{ {
let _ = self.batcher.push(add_documents).await; let _ = self.batcher.push(add_documents).await;
} }
if let Some(delete_documents) = if let Some(delete_documents) =
take(delete_documents_aggregator).into_event(&user, "Documents Deleted") take(delete_documents_aggregator).into_event(user, "Documents Deleted")
{ {
let _ = self.batcher.push(delete_documents).await; let _ = self.batcher.push(delete_documents).await;
} }
if let Some(update_documents) = if let Some(update_documents) =
take(update_documents_aggregator).into_event(&user, "Documents Updated") take(update_documents_aggregator).into_event(user, "Documents Updated")
{ {
let _ = self.batcher.push(update_documents).await; let _ = self.batcher.push(update_documents).await;
} }
if let Some(get_fetch_documents) = if let Some(get_fetch_documents) =
take(get_fetch_documents_aggregator).into_event(&user, "Documents Fetched GET") take(get_fetch_documents_aggregator).into_event(user, "Documents Fetched GET")
{ {
let _ = self.batcher.push(get_fetch_documents).await; let _ = self.batcher.push(get_fetch_documents).await;
} }
if let Some(post_fetch_documents) = if let Some(post_fetch_documents) =
take(post_fetch_documents_aggregator).into_event(&user, "Documents Fetched POST") take(post_fetch_documents_aggregator).into_event(user, "Documents Fetched POST")
{ {
let _ = self.batcher.push(post_fetch_documents).await; let _ = self.batcher.push(post_fetch_documents).await;
} }
if let Some(get_tasks) = take(get_tasks_aggregator).into_event(&user, "Tasks Seen") { if let Some(get_tasks) = take(get_tasks_aggregator).into_event(user, "Tasks Seen") {
let _ = self.batcher.push(get_tasks).await; let _ = self.batcher.push(get_tasks).await;
} }
if let Some(health) = take(health_aggregator).into_event(&user, "Health Seen") { if let Some(health) = take(health_aggregator).into_event(user, "Health Seen") {
let _ = self.batcher.push(health).await; let _ = self.batcher.push(health).await;
} }
let _ = self.batcher.flush().await; let _ = self.batcher.flush().await;
@ -614,6 +612,7 @@ pub struct SearchAggregator {
} }
impl SearchAggregator { impl SearchAggregator {
#[allow(clippy::field_reassign_with_default)]
pub fn from_query(query: &SearchQuery, request: &HttpRequest) -> Self { pub fn from_query(query: &SearchQuery, request: &HttpRequest) -> Self {
let SearchQuery { let SearchQuery {
q, q,
@ -676,7 +675,7 @@ impl SearchAggregator {
} }
// attributes_to_search_on // attributes_to_search_on
if let Some(_) = attributes_to_search_on { if attributes_to_search_on.is_some() {
ret.attributes_to_search_on_total_number_of_uses = 1; ret.attributes_to_search_on_total_number_of_uses = 1;
} }
@ -943,7 +942,7 @@ impl SearchAggregator {
}); });
Some(Track { Some(Track {
timestamp: timestamp, timestamp,
user: user.clone(), user: user.clone(),
event: event_name.to_string(), event: event_name.to_string(),
properties, properties,
@ -1116,7 +1115,7 @@ impl MultiSearchAggregator {
}); });
Some(Track { Some(Track {
timestamp: timestamp, timestamp,
user: user.clone(), user: user.clone(),
event: event_name.to_string(), event: event_name.to_string(),
properties, properties,
@ -1146,6 +1145,7 @@ pub struct FacetSearchAggregator {
} }
impl FacetSearchAggregator { impl FacetSearchAggregator {
#[allow(clippy::field_reassign_with_default)]
pub fn from_query(query: &FacetSearchQuery, request: &HttpRequest) -> Self { pub fn from_query(query: &FacetSearchQuery, request: &HttpRequest) -> Self {
let FacetSearchQuery { let FacetSearchQuery {
facet_query: _, facet_query: _,
@ -1211,8 +1211,7 @@ impl FacetSearchAggregator {
} }
// additional_search_parameters_provided // additional_search_parameters_provided
self.additional_search_parameters_provided = self.additional_search_parameters_provided |= additional_search_parameters_provided;
self.additional_search_parameters_provided | additional_search_parameters_provided;
} }
pub fn into_event(self, user: &User, event_name: &str) -> Option<Track> { pub fn into_event(self, user: &User, event_name: &str) -> Option<Track> {
@ -1251,7 +1250,7 @@ impl FacetSearchAggregator {
}); });
Some(Track { Some(Track {
timestamp: timestamp, timestamp,
user: user.clone(), user: user.clone(),
event: event_name.to_string(), event: event_name.to_string(),
properties, properties,
@ -1284,25 +1283,28 @@ impl DocumentsAggregator {
) -> Self { ) -> Self {
let UpdateDocumentsQuery { primary_key, csv_delimiter: _ } = documents_query; let UpdateDocumentsQuery { primary_key, csv_delimiter: _ } = documents_query;
let mut ret = Self::default(); let mut primary_keys = HashSet::new();
ret.timestamp = Some(OffsetDateTime::now_utc());
ret.updated = true;
ret.user_agents = extract_user_agents(request).into_iter().collect();
if let Some(primary_key) = primary_key.clone() { if let Some(primary_key) = primary_key.clone() {
ret.primary_keys.insert(primary_key); primary_keys.insert(primary_key);
} }
let mut content_types = HashSet::new();
let content_type = request let content_type = request
.headers() .headers()
.get(CONTENT_TYPE) .get(CONTENT_TYPE)
.and_then(|s| s.to_str().ok()) .and_then(|s| s.to_str().ok())
.unwrap_or("unknown") .unwrap_or("unknown")
.to_string(); .to_string();
ret.content_types.insert(content_type); content_types.insert(content_type);
ret.index_creation = index_creation;
ret Self {
timestamp: Some(OffsetDateTime::now_utc()),
updated: true,
user_agents: extract_user_agents(request).into_iter().collect(),
content_types,
primary_keys,
index_creation,
}
} }
/// Aggregate one [DocumentsAggregator] into another. /// Aggregate one [DocumentsAggregator] into another.
@ -1343,7 +1345,7 @@ impl DocumentsAggregator {
}); });
Some(Track { Some(Track {
timestamp: timestamp, timestamp,
user: user.clone(), user: user.clone(),
event: event_name.to_string(), event: event_name.to_string(),
properties, properties,
@ -1372,19 +1374,15 @@ pub struct DocumentsDeletionAggregator {
impl DocumentsDeletionAggregator { impl DocumentsDeletionAggregator {
pub fn from_query(kind: DocumentDeletionKind, request: &HttpRequest) -> Self { pub fn from_query(kind: DocumentDeletionKind, request: &HttpRequest) -> Self {
let mut ret = Self::default(); Self {
ret.timestamp = Some(OffsetDateTime::now_utc()); timestamp: Some(OffsetDateTime::now_utc()),
user_agents: extract_user_agents(request).into_iter().collect(),
ret.user_agents = extract_user_agents(request).into_iter().collect(); total_received: 1,
ret.total_received = 1; per_document_id: matches!(kind, DocumentDeletionKind::PerDocumentId),
match kind { clear_all: matches!(kind, DocumentDeletionKind::ClearAll),
DocumentDeletionKind::PerDocumentId => ret.per_document_id = true, per_batch: matches!(kind, DocumentDeletionKind::PerBatch),
DocumentDeletionKind::ClearAll => ret.clear_all = true, per_filter: matches!(kind, DocumentDeletionKind::PerFilter),
DocumentDeletionKind::PerBatch => ret.per_batch = true,
DocumentDeletionKind::PerFilter => ret.per_filter = true,
} }
ret
} }
/// Aggregate one [DocumentsAggregator] into another. /// Aggregate one [DocumentsAggregator] into another.
@ -1562,12 +1560,11 @@ pub struct HealthAggregator {
impl HealthAggregator { impl HealthAggregator {
pub fn from_query(request: &HttpRequest) -> Self { pub fn from_query(request: &HttpRequest) -> Self {
let mut ret = Self::default(); Self {
ret.timestamp = Some(OffsetDateTime::now_utc()); timestamp: Some(OffsetDateTime::now_utc()),
user_agents: extract_user_agents(request).into_iter().collect(),
ret.user_agents = extract_user_agents(request).into_iter().collect(); total_received: 1,
ret.total_received = 1; }
ret
} }
/// Aggregate one [HealthAggregator] into another. /// Aggregate one [HealthAggregator] into another.

8
meilisearch/src/option.rs
View File

@ -28,7 +28,7 @@ const MEILI_DB_PATH: &str = "MEILI_DB_PATH";
const MEILI_HTTP_ADDR: &str = "MEILI_HTTP_ADDR"; const MEILI_HTTP_ADDR: &str = "MEILI_HTTP_ADDR";
const MEILI_MASTER_KEY: &str = "MEILI_MASTER_KEY"; const MEILI_MASTER_KEY: &str = "MEILI_MASTER_KEY";
const MEILI_ENV: &str = "MEILI_ENV"; const MEILI_ENV: &str = "MEILI_ENV";
#[cfg(all(not(debug_assertions), feature = "analytics"))] #[cfg(feature = "analytics")]
const MEILI_NO_ANALYTICS: &str = "MEILI_NO_ANALYTICS"; const MEILI_NO_ANALYTICS: &str = "MEILI_NO_ANALYTICS";
const MEILI_HTTP_PAYLOAD_SIZE_LIMIT: &str = "MEILI_HTTP_PAYLOAD_SIZE_LIMIT"; const MEILI_HTTP_PAYLOAD_SIZE_LIMIT: &str = "MEILI_HTTP_PAYLOAD_SIZE_LIMIT";
const MEILI_SSL_CERT_PATH: &str = "MEILI_SSL_CERT_PATH"; const MEILI_SSL_CERT_PATH: &str = "MEILI_SSL_CERT_PATH";
@ -159,7 +159,7 @@ pub struct Opt {
/// Meilisearch automatically collects data from all instances that do not opt out using this flag. /// Meilisearch automatically collects data from all instances that do not opt out using this flag.
/// All gathered data is used solely for the purpose of improving Meilisearch, and can be deleted /// All gathered data is used solely for the purpose of improving Meilisearch, and can be deleted
/// at any time. /// at any time.
#[cfg(all(not(debug_assertions), feature = "analytics"))] #[cfg(feature = "analytics")]
#[serde(default)] // we can't send true #[serde(default)] // we can't send true
#[clap(long, env = MEILI_NO_ANALYTICS)] #[clap(long, env = MEILI_NO_ANALYTICS)]
pub no_analytics: bool, pub no_analytics: bool,
@ -390,7 +390,7 @@ impl Opt {
ignore_missing_dump: _, ignore_missing_dump: _,
ignore_dump_if_db_exists: _, ignore_dump_if_db_exists: _,
config_file_path: _, config_file_path: _,
#[cfg(all(not(debug_assertions), feature = "analytics"))] #[cfg(feature = "analytics")]
no_analytics, no_analytics,
experimental_enable_metrics: enable_metrics_route, experimental_enable_metrics: enable_metrics_route,
experimental_reduce_indexing_memory_usage: reduce_indexing_memory_usage, experimental_reduce_indexing_memory_usage: reduce_indexing_memory_usage,
@ -401,7 +401,7 @@ impl Opt {
export_to_env_if_not_present(MEILI_MASTER_KEY, master_key); export_to_env_if_not_present(MEILI_MASTER_KEY, master_key);
} }
export_to_env_if_not_present(MEILI_ENV, env); export_to_env_if_not_present(MEILI_ENV, env);
#[cfg(all(not(debug_assertions), feature = "analytics"))] #[cfg(feature = "analytics")]
{ {
export_to_env_if_not_present(MEILI_NO_ANALYTICS, no_analytics.to_string()); export_to_env_if_not_present(MEILI_NO_ANALYTICS, no_analytics.to_string());
} }

2
meilisearch/tests/common/server.rs
View File

@ -209,7 +209,7 @@ pub fn default_settings(dir: impl AsRef<Path>) -> Opt {
db_path: dir.as_ref().join("db"), db_path: dir.as_ref().join("db"),
dump_dir: dir.as_ref().join("dumps"), dump_dir: dir.as_ref().join("dumps"),
env: "development".to_owned(), env: "development".to_owned(),
#[cfg(all(not(debug_assertions), feature = "analytics"))] #[cfg(feature = "analytics")]
no_analytics: true, no_analytics: true,
max_index_size: Byte::from_unit(100.0, ByteUnit::MiB).unwrap(), max_index_size: Byte::from_unit(100.0, ByteUnit::MiB).unwrap(),
max_task_db_size: Byte::from_unit(1.0, ByteUnit::GiB).unwrap(), max_task_db_size: Byte::from_unit(1.0, ByteUnit::GiB).unwrap(),