From 50fef81a4735905acde5c307632d1da607b7ed5f Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Thu, 8 May 2025 17:59:24 +0200 Subject: [PATCH 01/12] feature/ODM-12551 Write documentation on telemetry metrics --- docs/home/other/telemetry.md | 35 +++++++++++++++++++++++++++++++++++ mkdocs.yml | 2 ++ 2 files changed, 37 insertions(+) create mode 100644 docs/home/other/telemetry.md diff --git a/docs/home/other/telemetry.md b/docs/home/other/telemetry.md new file mode 100644 index 00000000..e870e4a8 --- /dev/null +++ b/docs/home/other/telemetry.md @@ -0,0 +1,35 @@ +# Telemetry + +Our company collects telemetry data to improve service quality, ensure stability, and enhance security. We analyze technical parameters such as resource utilization, and anonymized feature usage data. + +Telemetry helps us to: + +- detect and resolve issues more efficiently + +- optimize system performance and scalability + +- make informed decisions about product improvements + +- enhance reliability and user experience. + +We do not collect personal information without user consent and fully comply with applicable data protection laws and standards. + +In addition to technical metrics, we collect anonymized product usage data to better understand how our services are used and to guide product development decisions. These metrics help us identify what brings value to users and where improvements are needed. + +- `product_number_of_active_users` - Number of registered unique users with “Active” status + +- `product_number_of_attached_files` - Number of attachments by Data class + +- `product_number_of_signal_groups` - Number of signal groups + +- `product_number_of_slp` - Number of Samples, Libraries, and Preparations + +- `product_number_of_slp_groups` - Number of signal groups by Data class + +- `product_number_of_studies` - Number of studies + +- `product_number_of_logged_in_users` - Number of logged in users + +- `product_rest_api_requests_total` - Number of API calls grouped by application, path and method + +- `product_user_session_duration` - Displays quantiles of ODM usage time. diff --git a/mkdocs.yml b/mkdocs.yml index 69073736..8213710d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,6 +28,8 @@ nav: - Azure SSO: home/troubleshooting/azure-sso.md - Azure SCIM: home/troubleshooting/azure-scim.md - Sanity check: home/troubleshooting/sanity-check.md + - Other: + - Telemetry: home/other/telemetry.md - Release Notes: - v1.60 - v1.69: home/release-notes/v1.60-v1.69.md - v1.50 - v1.59: home/release-notes/v1.50-v1.59.md From 9626f9358aa8614e1ce3594b049bed53b75aaed0 Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Thu, 8 May 2025 18:02:17 +0200 Subject: [PATCH 02/12] ODM-12551 Corrected the wording --- docs/home/other/telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/other/telemetry.md b/docs/home/other/telemetry.md index e870e4a8..5e562c56 100644 --- a/docs/home/other/telemetry.md +++ b/docs/home/other/telemetry.md @@ -32,4 +32,4 @@ In addition to technical metrics, we collect anonymized product usage data to be - `product_rest_api_requests_total` - Number of API calls grouped by application, path and method -- `product_user_session_duration` - Displays quantiles of ODM usage time. +- `product_user_session_duration` - User session duration From 20a6210890af057e59295a7e43858f382226e24d Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Fri, 9 May 2025 11:29:21 +0200 Subject: [PATCH 03/12] Update docs/home/other/telemetry.md Co-authored-by: Mikhail Smazhevsky --- docs/home/other/telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/other/telemetry.md b/docs/home/other/telemetry.md index 5e562c56..02d53792 100644 --- a/docs/home/other/telemetry.md +++ b/docs/home/other/telemetry.md @@ -1,6 +1,6 @@ # Telemetry -Our company collects telemetry data to improve service quality, ensure stability, and enhance security. We analyze technical parameters such as resource utilization, and anonymized feature usage data. +Genestack collects telemetry data to improve service quality, ensure stability, and enhance security. Analysis of both technical parameters such as resource utilization, and product metrics like anonymized feature usage data helps to improve ODM trustworthy for the most crucial aspects of it's work. Telemetry helps us to: From 6a82a687ed44ef93d51b5417934af489c1aed9b2 Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Fri, 9 May 2025 11:29:26 +0200 Subject: [PATCH 04/12] Update docs/home/other/telemetry.md Co-authored-by: Mikhail Smazhevsky --- docs/home/other/telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/other/telemetry.md b/docs/home/other/telemetry.md index 02d53792..9c07b488 100644 --- a/docs/home/other/telemetry.md +++ b/docs/home/other/telemetry.md @@ -2,7 +2,7 @@ Genestack collects telemetry data to improve service quality, ensure stability, and enhance security. Analysis of both technical parameters such as resource utilization, and product metrics like anonymized feature usage data helps to improve ODM trustworthy for the most crucial aspects of it's work. -Telemetry helps us to: +More specifically, telemetry helps to: - detect and resolve issues more efficiently From a5f034c5648a0bb3f7c862e90223bdb3f64876a8 Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Fri, 9 May 2025 11:29:32 +0200 Subject: [PATCH 05/12] Update docs/home/other/telemetry.md Co-authored-by: Mikhail Smazhevsky --- docs/home/other/telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/other/telemetry.md b/docs/home/other/telemetry.md index 9c07b488..9f53bbc6 100644 --- a/docs/home/other/telemetry.md +++ b/docs/home/other/telemetry.md @@ -12,7 +12,7 @@ More specifically, telemetry helps to: - enhance reliability and user experience. -We do not collect personal information without user consent and fully comply with applicable data protection laws and standards. +Genestack doesn't collect any personal information without user consent, complying with data protection regulations; refer to security documents if you need more information in this regard. In addition to technical metrics, we collect anonymized product usage data to better understand how our services are used and to guide product development decisions. These metrics help us identify what brings value to users and where improvements are needed. From 8b161e3a31baccdf3d6c2daf86dc5c551bc991ff Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Fri, 9 May 2025 11:29:39 +0200 Subject: [PATCH 06/12] Update docs/home/other/telemetry.md Co-authored-by: Mikhail Smazhevsky --- docs/home/other/telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/other/telemetry.md b/docs/home/other/telemetry.md index 9f53bbc6..9663e3a6 100644 --- a/docs/home/other/telemetry.md +++ b/docs/home/other/telemetry.md @@ -14,7 +14,7 @@ More specifically, telemetry helps to: Genestack doesn't collect any personal information without user consent, complying with data protection regulations; refer to security documents if you need more information in this regard. -In addition to technical metrics, we collect anonymized product usage data to better understand how our services are used and to guide product development decisions. These metrics help us identify what brings value to users and where improvements are needed. +In addition to technical metrics, anonymized product usage data is being collected. It helps to understand better which features are used and to guide product development decisions. These metrics help us identify what brings value to users and where improvements are needed. The list of collected metrics includes but not limited to: - `product_number_of_active_users` - Number of registered unique users with “Active” status From 571d2cbb07319adf0b85ec4593355b2076ff4d27 Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Fri, 9 May 2025 11:29:45 +0200 Subject: [PATCH 07/12] Update docs/home/other/telemetry.md Co-authored-by: Mikhail Smazhevsky --- docs/home/other/telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/other/telemetry.md b/docs/home/other/telemetry.md index 9663e3a6..0c712798 100644 --- a/docs/home/other/telemetry.md +++ b/docs/home/other/telemetry.md @@ -16,7 +16,7 @@ Genestack doesn't collect any personal information without user consent, complyi In addition to technical metrics, anonymized product usage data is being collected. It helps to understand better which features are used and to guide product development decisions. These metrics help us identify what brings value to users and where improvements are needed. The list of collected metrics includes but not limited to: -- `product_number_of_active_users` - Number of registered unique users with “Active” status +- `product_number_of_active_users` - Number of registered unique not-disabled users - `product_number_of_attached_files` - Number of attachments by Data class From a086a92d2db65d805420d7c7615d403799cbf260 Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Fri, 9 May 2025 11:29:51 +0200 Subject: [PATCH 08/12] Update docs/home/other/telemetry.md Co-authored-by: Mikhail Smazhevsky --- docs/home/other/telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/other/telemetry.md b/docs/home/other/telemetry.md index 0c712798..3305daba 100644 --- a/docs/home/other/telemetry.md +++ b/docs/home/other/telemetry.md @@ -18,7 +18,7 @@ In addition to technical metrics, anonymized product usage data is being collect - `product_number_of_active_users` - Number of registered unique not-disabled users -- `product_number_of_attached_files` - Number of attachments by Data class +- `product_number_of_attached_files` - Number of Study File attachments by Data class - `product_number_of_signal_groups` - Number of signal groups From 407109de17651caef2296d2c9615bc7fdf4b281d Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Fri, 9 May 2025 11:29:55 +0200 Subject: [PATCH 09/12] Update docs/home/other/telemetry.md Co-authored-by: Mikhail Smazhevsky --- docs/home/other/telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/other/telemetry.md b/docs/home/other/telemetry.md index 3305daba..30759ee8 100644 --- a/docs/home/other/telemetry.md +++ b/docs/home/other/telemetry.md @@ -20,7 +20,7 @@ In addition to technical metrics, anonymized product usage data is being collect - `product_number_of_attached_files` - Number of Study File attachments by Data class -- `product_number_of_signal_groups` - Number of signal groups +- `product_number_of_signal_groups` - Number of Tabular, Variants and Flow Cytometry groups - `product_number_of_slp` - Number of Samples, Libraries, and Preparations From 836f6096719a577ae758c3162c5ea2921594c3a0 Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Fri, 9 May 2025 11:30:00 +0200 Subject: [PATCH 10/12] Update docs/home/other/telemetry.md Co-authored-by: Mikhail Smazhevsky --- docs/home/other/telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/other/telemetry.md b/docs/home/other/telemetry.md index 30759ee8..d85f8ed4 100644 --- a/docs/home/other/telemetry.md +++ b/docs/home/other/telemetry.md @@ -24,7 +24,7 @@ In addition to technical metrics, anonymized product usage data is being collect - `product_number_of_slp` - Number of Samples, Libraries, and Preparations -- `product_number_of_slp_groups` - Number of signal groups by Data class +- `product_number_of_slp_groups` - Number of Sample, Library, and Preparation groups by Data class - `product_number_of_studies` - Number of studies From bcd500ba6d2225a55f92c22e64a105d778c40f99 Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Fri, 9 May 2025 11:30:04 +0200 Subject: [PATCH 11/12] Update docs/home/other/telemetry.md Co-authored-by: Mikhail Smazhevsky --- docs/home/other/telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/home/other/telemetry.md b/docs/home/other/telemetry.md index d85f8ed4..c495d1e0 100644 --- a/docs/home/other/telemetry.md +++ b/docs/home/other/telemetry.md @@ -26,7 +26,7 @@ In addition to technical metrics, anonymized product usage data is being collect - `product_number_of_slp_groups` - Number of Sample, Library, and Preparation groups by Data class -- `product_number_of_studies` - Number of studies +- `product_number_of_studies` - Number of Studies - `product_number_of_logged_in_users` - Number of logged in users From 7afe9e27cf6eba6c2f0c07c9531f4f8e89658ac9 Mon Sep 17 00:00:00 2001 From: Vladislav Tropnikov Date: Fri, 9 May 2025 12:55:17 +0200 Subject: [PATCH 12/12] ODM-12551 add examples of tech metrics --- docs/home/other/telemetry.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/home/other/telemetry.md b/docs/home/other/telemetry.md index c495d1e0..3e69d7f1 100644 --- a/docs/home/other/telemetry.md +++ b/docs/home/other/telemetry.md @@ -14,6 +14,30 @@ More specifically, telemetry helps to: Genestack doesn't collect any personal information without user consent, complying with data protection regulations; refer to security documents if you need more information in this regard. +Technical metrics includes groups of metrics to control: + +- Hardware parameters, such as CPU and memory consumption, etc. For example: + + - `system_cpu_count` - The number of processors available to the Java virtual machine + + - `system_load_average_1m` - The sum of the number of runnable entities queued to available processors and the number of runnable entities running on the available processors averaged over a period of time + + - `process_cpu_usage` - The "recent cpu usage" for the Java Virtual Machine process + + - `process_uptime_seconds` - The uptime of the Java virtual machine + +- Programming language-specific metrics to track JVM behaviour controlling heap size and other parameters. For example: + + - `jvm_memory_used_bytes` - The amount of used memory + + - `jvm_memory_max_bytes` - The maximum amount of memory in bytes that can be used for memory management + + - `jvm_threads_states_threads` - The current number of threads + + - `hikaricp_connections` - Total connections + + - `jdbc_connections_active` - Current number of active connections that have been allocated from the data source. + In addition to technical metrics, anonymized product usage data is being collected. It helps to understand better which features are used and to guide product development decisions. These metrics help us identify what brings value to users and where improvements are needed. The list of collected metrics includes but not limited to: - `product_number_of_active_users` - Number of registered unique not-disabled users