From 37e3772c753fc23dedc767f7826b486c7382a07b Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Tue, 19 Nov 2024 15:34:57 +0100 Subject: [PATCH 01/14] Create usage.md --- docs/getting_started/usage.md | 68 +++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 docs/getting_started/usage.md diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md new file mode 100644 index 0000000000..f45ee177ee --- /dev/null +++ b/docs/getting_started/usage.md @@ -0,0 +1,68 @@ +# Usage overview + +The Usage page provides users with a comprehensive overview of their data consumption and performance metrics associated with their communities. This feature is essential for understanding resource allocation and ensuring compliance with the fair use policy. Users can access detailed analytics regarding their analyzed bytes by community, as well as all executed playbook actions, facilitating efficient monitoring of usage and prevention of service degradation. +How It Works + +Upon accessing the Usage page, users are presented with a dashboard that displays their data usage for the current month. The dashboard consists of key sections: + +- **Analyzed Bytes**: Visualizes the total data analyzed by the community and indicates whether the usage is within acceptable limits. +- **Executed Playbook Actions**: Summarizes automation actions taken based on user-defined playbooks. + +As a member of a workspace, you can quickly review consumption metrics across all your communities. The summary table includes: +- Community name +- Number of subscribed assets: Total subscribed assets in each community (based on what has been defined in your contract with Sekoia). +- Type of subscription: The subscription plan type. +- Analyzed bytes: The amount of data analyzed, applicable to your plan. + +You can also have a look at your previous consumption by clicking on the date selector in the upper right of the screen. + +## Sections + +### Analyzed Bytes + +In the Analyzed Bytes section, users can view a detailed breakdown of their monthly data usage in relation to the Fair Use Policy. + +- **Current usage**: Displays the total bytes analyzed (e.g., 100 GB) and highlights any excess usage against the predefined fair use limit (e.g., 210 GB). +- **Fair use indicator**: A visual marker shows whether current consumption exceeds the fair use threshold. + +### Fair Use Policy + +The Fair Use Policy ensures equitable access to platform resources for all users. If a user exceeds their allocated usage, they may experience degraded performance or incur additional charges. Key components include: +- **Threshold:** Each user has a set limit on total analyzed bytes allowed within a specified period (e.g., 200 GB per month). +- **Excessive use consequences**: Regularly exceeding the limit may result in: + - Notifications about potential performance degradation. + - Adjusted fees for exceeding the limit. + - Recommendations for upgrading to plans with higher allowances. + +Tracking consumption empowers users to proactively adjust their data usage and consider upgrading their plans if necessary. + +!!!note + If you are on an **Intelligence pla**n only, please note that you will not see any analyzed bytes, as there are none associated with this plan. + +### Playbook Actions + +The Executed Playbook Actions section displays the total number of actions completed within the selected month. This is calculated by: +- **Number of actions**: Each automated task initiated by the user within their playbooks is logged. The total actions executed by the user are aggregated and presented accordingly. +- **Usage patterns**: Users can identify trends in their automation efforts. + +### Definition of an asset + +An asset refers to any equipment that produces logs, including user workstations, servers, and virtual machines. Customers subscribe based on the number of assets they wish to monitor, which directly influences their data usage and associated costs. + +## Plans and Usage + +### Defend CORE and PRIME Plans + +Depending on the plan you are subscribed to, you may have different thresholds for data usage: + +- **Defend CORE**: Fair use threshold is set at **3GB per asset per month**. +- **Defend PRIME**: Higher threshold allowing for **5GB per asset per month**. + +Both plans implement a soft violation policy. If a user exceeds the set thresholds, they will be notified, but no immediate penalties will be enforced. + +### Defend FLOW Plan + +The FLOW plan establishes threshold metrics for data usage based on a maximum of **5GB per asset per month**. + +#### Soft and hard limits +The FLOW plan includes both soft and hard limits for data usage. Soft limits provide flexibility, allowing users to be notified upon exceeding their limits, while hard limits enforce stricter controls. From 01929088f52a16858b3c6b2f13192a4c25f861a9 Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Tue, 19 Nov 2024 15:36:48 +0100 Subject: [PATCH 02/14] Update mkdocs.yml --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index 9c25cb86c7..3216bc25e5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -61,6 +61,7 @@ nav: - Create and manage notifications: getting_started/notifications-Listing_Creation.md - Notification examples: getting_started/notifications-Examples.md - API Keys: getting_started/manage_api_keys.md + - Usage: getting_started/usage.md - Sekoia regions: getting_started/regions.md - Best practices: getting_started/best_practices.md - Troubleshooting tips: getting_started/get_troubleshooting_tips.md From e01b29ea77443b83bf5e2e2a8d14fe75538f139a Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Tue, 19 Nov 2024 15:39:33 +0100 Subject: [PATCH 03/14] Update usage.md --- docs/getting_started/usage.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md index f45ee177ee..8249fdb1fb 100644 --- a/docs/getting_started/usage.md +++ b/docs/getting_started/usage.md @@ -1,33 +1,36 @@ # Usage overview The Usage page provides users with a comprehensive overview of their data consumption and performance metrics associated with their communities. This feature is essential for understanding resource allocation and ensuring compliance with the fair use policy. Users can access detailed analytics regarding their analyzed bytes by community, as well as all executed playbook actions, facilitating efficient monitoring of usage and prevention of service degradation. -How It Works -Upon accessing the Usage page, users are presented with a dashboard that displays their data usage for the current month. The dashboard consists of key sections: +## How it works + +Upon accessing the Usage page, you are presented with a dashboard that displays their data usage for the current month. The dashboard consists of key sections: - **Analyzed Bytes**: Visualizes the total data analyzed by the community and indicates whether the usage is within acceptable limits. - **Executed Playbook Actions**: Summarizes automation actions taken based on user-defined playbooks. As a member of a workspace, you can quickly review consumption metrics across all your communities. The summary table includes: -- Community name -- Number of subscribed assets: Total subscribed assets in each community (based on what has been defined in your contract with Sekoia). -- Type of subscription: The subscription plan type. -- Analyzed bytes: The amount of data analyzed, applicable to your plan. +- **Community name** +- **Number of subscribed assets**: Total subscribed assets in each community (based on what has been defined in your contract with Sekoia). +- **Type of subscription**: The subscription plan type. +- **Analyzed bytes**: The amount of data analyzed, applicable to your plan. You can also have a look at your previous consumption by clicking on the date selector in the upper right of the screen. ## Sections -### Analyzed Bytes +### Analyzed bytes -In the Analyzed Bytes section, users can view a detailed breakdown of their monthly data usage in relation to the Fair Use Policy. +In the Analyzed bytes section, users can view a detailed breakdown of their monthly data usage in relation to the Fair Use Policy. - **Current usage**: Displays the total bytes analyzed (e.g., 100 GB) and highlights any excess usage against the predefined fair use limit (e.g., 210 GB). - **Fair use indicator**: A visual marker shows whether current consumption exceeds the fair use threshold. -### Fair Use Policy +### Fair use policy + +The Fair Use Policy ensures equitable access to platform resources for all users. If a user exceeds their allocated usage, they may experience degraded performance or incur additional charges. -The Fair Use Policy ensures equitable access to platform resources for all users. If a user exceeds their allocated usage, they may experience degraded performance or incur additional charges. Key components include: +Key components include: - **Threshold:** Each user has a set limit on total analyzed bytes allowed within a specified period (e.g., 200 GB per month). - **Excessive use consequences**: Regularly exceeding the limit may result in: - Notifications about potential performance degradation. @@ -49,9 +52,9 @@ The Executed Playbook Actions section displays the total number of actions compl An asset refers to any equipment that produces logs, including user workstations, servers, and virtual machines. Customers subscribe based on the number of assets they wish to monitor, which directly influences their data usage and associated costs. -## Plans and Usage +## Plans and usage -### Defend CORE and PRIME Plans +### Defend CORE and PRIME plans Depending on the plan you are subscribed to, you may have different thresholds for data usage: From cca7313e9fe8f42d61f3da0b4d78ca1cbc244770 Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Tue, 19 Nov 2024 15:50:38 +0100 Subject: [PATCH 04/14] Update usage.md --- docs/getting_started/usage.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md index 8249fdb1fb..95b9a628b7 100644 --- a/docs/getting_started/usage.md +++ b/docs/getting_started/usage.md @@ -31,6 +31,7 @@ In the Analyzed bytes section, users can view a detailed breakdown of their mont The Fair Use Policy ensures equitable access to platform resources for all users. If a user exceeds their allocated usage, they may experience degraded performance or incur additional charges. Key components include: + - **Threshold:** Each user has a set limit on total analyzed bytes allowed within a specified period (e.g., 200 GB per month). - **Excessive use consequences**: Regularly exceeding the limit may result in: - Notifications about potential performance degradation. @@ -39,12 +40,13 @@ Key components include: Tracking consumption empowers users to proactively adjust their data usage and consider upgrading their plans if necessary. -!!!note - If you are on an **Intelligence pla**n only, please note that you will not see any analyzed bytes, as there are none associated with this plan. +!!! note + If you are on an **Intelligence pla**n only, please note that you will not see any analyzed bytes, as there are none associated with this plan. ### Playbook Actions The Executed Playbook Actions section displays the total number of actions completed within the selected month. This is calculated by: + - **Number of actions**: Each automated task initiated by the user within their playbooks is logged. The total actions executed by the user are aggregated and presented accordingly. - **Usage patterns**: Users can identify trends in their automation efforts. From e89a230f2b43457c5f423910f263d7990804eb69 Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Tue, 19 Nov 2024 15:52:08 +0100 Subject: [PATCH 05/14] Update usage.md --- docs/getting_started/usage.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md index 95b9a628b7..f18e878382 100644 --- a/docs/getting_started/usage.md +++ b/docs/getting_started/usage.md @@ -10,6 +10,7 @@ Upon accessing the Usage page, you are presented with a dashboard that displays - **Executed Playbook Actions**: Summarizes automation actions taken based on user-defined playbooks. As a member of a workspace, you can quickly review consumption metrics across all your communities. The summary table includes: + - **Community name** - **Number of subscribed assets**: Total subscribed assets in each community (based on what has been defined in your contract with Sekoia). - **Type of subscription**: The subscription plan type. From e9892e9cc42bb4cadf4ed1a093af0fc6a3642510 Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Tue, 19 Nov 2024 15:57:53 +0100 Subject: [PATCH 06/14] Update usage.md --- docs/getting_started/usage.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md index f18e878382..c2039f8400 100644 --- a/docs/getting_started/usage.md +++ b/docs/getting_started/usage.md @@ -35,6 +35,7 @@ Key components include: - **Threshold:** Each user has a set limit on total analyzed bytes allowed within a specified period (e.g., 200 GB per month). - **Excessive use consequences**: Regularly exceeding the limit may result in: + - Notifications about potential performance degradation. - Adjusted fees for exceeding the limit. - Recommendations for upgrading to plans with higher allowances. From 8506fbd509b3b00238b0c4f305b119f4983ae28e Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Fri, 22 Nov 2024 10:27:44 +0100 Subject: [PATCH 07/14] Update docs/getting_started/usage.md Co-authored-by: Georges Bossert --- docs/getting_started/usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md index c2039f8400..713562f7e7 100644 --- a/docs/getting_started/usage.md +++ b/docs/getting_started/usage.md @@ -1,6 +1,6 @@ # Usage overview -The Usage page provides users with a comprehensive overview of their data consumption and performance metrics associated with their communities. This feature is essential for understanding resource allocation and ensuring compliance with the fair use policy. Users can access detailed analytics regarding their analyzed bytes by community, as well as all executed playbook actions, facilitating efficient monitoring of usage and prevention of service degradation. +The Usage page provides users with a comprehensive overview of their data consumption and performance metrics associated with their communities. This feature is essential for understanding resource allocation and ensuring compliance with the usage policy. Users can access detailed analytics regarding their analyzed bytes by community, as well as all executed playbook actions, facilitating efficient monitoring of usage and prevention of service degradation. ## How it works From 9e182688ba57b98ea4a420be2375353757c73639 Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Fri, 22 Nov 2024 10:27:59 +0100 Subject: [PATCH 08/14] Update docs/getting_started/usage.md Co-authored-by: Georges Bossert --- docs/getting_started/usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md index 713562f7e7..10ea85ccd5 100644 --- a/docs/getting_started/usage.md +++ b/docs/getting_started/usage.md @@ -4,7 +4,7 @@ The Usage page provides users with a comprehensive overview of their data consum ## How it works -Upon accessing the Usage page, you are presented with a dashboard that displays their data usage for the current month. The dashboard consists of key sections: +Upon accessing the Usage page, you are presented with a dashboard that displays current month data usage. The dashboard consists of key sections: - **Analyzed Bytes**: Visualizes the total data analyzed by the community and indicates whether the usage is within acceptable limits. - **Executed Playbook Actions**: Summarizes automation actions taken based on user-defined playbooks. From dec82f4173c37f1b9c4e888ab55610c478a09047 Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Fri, 22 Nov 2024 10:29:39 +0100 Subject: [PATCH 09/14] Update docs/getting_started/usage.md Co-authored-by: Georges Bossert --- docs/getting_started/usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md index 10ea85ccd5..ea9058b0b9 100644 --- a/docs/getting_started/usage.md +++ b/docs/getting_started/usage.md @@ -6,7 +6,7 @@ The Usage page provides users with a comprehensive overview of their data consum Upon accessing the Usage page, you are presented with a dashboard that displays current month data usage. The dashboard consists of key sections: -- **Analyzed Bytes**: Visualizes the total data analyzed by the community and indicates whether the usage is within acceptable limits. +- **Analyzed Bytes**: Visualizes the total data analyzed by the community. - **Executed Playbook Actions**: Summarizes automation actions taken based on user-defined playbooks. As a member of a workspace, you can quickly review consumption metrics across all your communities. The summary table includes: From b3f197a3279715bbee4e2da5ab813cd89526a268 Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Fri, 22 Nov 2024 10:29:52 +0100 Subject: [PATCH 10/14] Update docs/getting_started/usage.md Co-authored-by: Georges Bossert --- docs/getting_started/usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md index ea9058b0b9..dc4464d0c8 100644 --- a/docs/getting_started/usage.md +++ b/docs/getting_started/usage.md @@ -22,7 +22,7 @@ You can also have a look at your previous consumption by clicking on the date se ### Analyzed bytes -In the Analyzed bytes section, users can view a detailed breakdown of their monthly data usage in relation to the Fair Use Policy. +In the Analyzed bytes section, users can view a detailed breakdown of their monthly data usage in relation to their usage policy. - **Current usage**: Displays the total bytes analyzed (e.g., 100 GB) and highlights any excess usage against the predefined fair use limit (e.g., 210 GB). - **Fair use indicator**: A visual marker shows whether current consumption exceeds the fair use threshold. From 5e1907da74145b8311b53e74a6e8f202913968c9 Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Fri, 22 Nov 2024 10:50:07 +0100 Subject: [PATCH 11/14] Apply suggestions from code review Co-authored-by: Georges Bossert --- docs/getting_started/usage.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md index dc4464d0c8..78ef9d8dbd 100644 --- a/docs/getting_started/usage.md +++ b/docs/getting_started/usage.md @@ -24,7 +24,7 @@ You can also have a look at your previous consumption by clicking on the date se In the Analyzed bytes section, users can view a detailed breakdown of their monthly data usage in relation to their usage policy. -- **Current usage**: Displays the total bytes analyzed (e.g., 100 GB) and highlights any excess usage against the predefined fair use limit (e.g., 210 GB). +- **Current usage**: Displays the total bytes analyzed (e.g., 100 GB). - **Fair use indicator**: A visual marker shows whether current consumption exceeds the fair use threshold. ### Fair use policy @@ -43,13 +43,13 @@ Key components include: Tracking consumption empowers users to proactively adjust their data usage and consider upgrading their plans if necessary. !!! note - If you are on an **Intelligence pla**n only, please note that you will not see any analyzed bytes, as there are none associated with this plan. + If you are on an **Intelligence plan** only, please note that you will not see any analyzed bytes, as there are none associated with this plan. ### Playbook Actions The Executed Playbook Actions section displays the total number of actions completed within the selected month. This is calculated by: -- **Number of actions**: Each automated task initiated by the user within their playbooks is logged. The total actions executed by the user are aggregated and presented accordingly. +- **Number of actions**: Each playbook action initiated by the user within their playbooks is logged. The total actions executed by the user are aggregated and presented accordingly. - **Usage patterns**: Users can identify trends in their automation efforts. ### Definition of an asset @@ -63,13 +63,13 @@ An asset refers to any equipment that produces logs, including user workstations Depending on the plan you are subscribed to, you may have different thresholds for data usage: - **Defend CORE**: Fair use threshold is set at **3GB per asset per month**. -- **Defend PRIME**: Higher threshold allowing for **5GB per asset per month**. +- **Defend PRIME**: Faire use threshold is set at **5GB per asset per month**. Both plans implement a soft violation policy. If a user exceeds the set thresholds, they will be notified, but no immediate penalties will be enforced. ### Defend FLOW Plan -The FLOW plan establishes threshold metrics for data usage based on a maximum of **5GB per asset per month**. +The FLOW plan establishes threshold metrics for data usage based on a predefined number of GB per month. #### Soft and hard limits The FLOW plan includes both soft and hard limits for data usage. Soft limits provide flexibility, allowing users to be notified upon exceeding their limits, while hard limits enforce stricter controls. From 68b630eb6c94cd274aed0e24976696574770d263 Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Fri, 22 Nov 2024 10:52:34 +0100 Subject: [PATCH 12/14] remove soft hard limits --- docs/getting_started/usage.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md index 78ef9d8dbd..e56df8f7c8 100644 --- a/docs/getting_started/usage.md +++ b/docs/getting_started/usage.md @@ -71,5 +71,3 @@ Both plans implement a soft violation policy. If a user exceeds the set threshol The FLOW plan establishes threshold metrics for data usage based on a predefined number of GB per month. -#### Soft and hard limits -The FLOW plan includes both soft and hard limits for data usage. Soft limits provide flexibility, allowing users to be notified upon exceeding their limits, while hard limits enforce stricter controls. From bcca82a7958c2ceaa68db2d95abdb87e7d0bb3fb Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Tue, 26 Nov 2024 10:12:05 +0100 Subject: [PATCH 13/14] Update usage.md --- docs/getting_started/usage.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md index e56df8f7c8..2a832eb704 100644 --- a/docs/getting_started/usage.md +++ b/docs/getting_started/usage.md @@ -31,15 +31,6 @@ In the Analyzed bytes section, users can view a detailed breakdown of their mont The Fair Use Policy ensures equitable access to platform resources for all users. If a user exceeds their allocated usage, they may experience degraded performance or incur additional charges. -Key components include: - -- **Threshold:** Each user has a set limit on total analyzed bytes allowed within a specified period (e.g., 200 GB per month). -- **Excessive use consequences**: Regularly exceeding the limit may result in: - - - Notifications about potential performance degradation. - - Adjusted fees for exceeding the limit. - - Recommendations for upgrading to plans with higher allowances. - Tracking consumption empowers users to proactively adjust their data usage and consider upgrading their plans if necessary. !!! note From 0e90f15737fa657296e32acfcf137eb8b392a8f6 Mon Sep 17 00:00:00 2001 From: "Khaoula E." <49680698+ka0ula@users.noreply.github.com> Date: Wed, 27 Nov 2024 14:35:47 +0100 Subject: [PATCH 14/14] simplify usage content --- docs/getting_started/usage.md | 64 ++++++++++------------------------- 1 file changed, 17 insertions(+), 47 deletions(-) diff --git a/docs/getting_started/usage.md b/docs/getting_started/usage.md index 2a832eb704..542ac9dbd5 100644 --- a/docs/getting_started/usage.md +++ b/docs/getting_started/usage.md @@ -1,64 +1,34 @@ # Usage overview -The Usage page provides users with a comprehensive overview of their data consumption and performance metrics associated with their communities. This feature is essential for understanding resource allocation and ensuring compliance with the usage policy. Users can access detailed analytics regarding their analyzed bytes by community, as well as all executed playbook actions, facilitating efficient monitoring of usage and prevention of service degradation. +The Usage page provides users with a comprehensive overview of their data consumption and performance metrics associated with their communities. This feature is essential for understanding resource allocation and ensuring compliance with the usage policy. -## How it works - -Upon accessing the Usage page, you are presented with a dashboard that displays current month data usage. The dashboard consists of key sections: - -- **Analyzed Bytes**: Visualizes the total data analyzed by the community. -- **Executed Playbook Actions**: Summarizes automation actions taken based on user-defined playbooks. - -As a member of a workspace, you can quickly review consumption metrics across all your communities. The summary table includes: - -- **Community name** -- **Number of subscribed assets**: Total subscribed assets in each community (based on what has been defined in your contract with Sekoia). -- **Type of subscription**: The subscription plan type. -- **Analyzed bytes**: The amount of data analyzed, applicable to your plan. - -You can also have a look at your previous consumption by clicking on the date selector in the upper right of the screen. - -## Sections +From this page, users can access detailed analytics regarding their analyzed bytes by community, as well as all executed playbook actions. -### Analyzed bytes - -In the Analyzed bytes section, users can view a detailed breakdown of their monthly data usage in relation to their usage policy. - -- **Current usage**: Displays the total bytes analyzed (e.g., 100 GB). -- **Fair use indicator**: A visual marker shows whether current consumption exceeds the fair use threshold. - -### Fair use policy - -The Fair Use Policy ensures equitable access to platform resources for all users. If a user exceeds their allocated usage, they may experience degraded performance or incur additional charges. - -Tracking consumption empowers users to proactively adjust their data usage and consider upgrading their plans if necessary. - -!!! note - If you are on an **Intelligence plan** only, please note that you will not see any analyzed bytes, as there are none associated with this plan. +## How it works -### Playbook Actions +### Single-tenant communities -The Executed Playbook Actions section displays the total number of actions completed within the selected month. This is calculated by: +The Usage page is accessible from the `Settings` section. On this page, users are presented with a dashboard containing the following widgets: -- **Number of actions**: Each playbook action initiated by the user within their playbooks is logged. The total actions executed by the user are aggregated and presented accordingly. -- **Usage patterns**: Users can identify trends in their automation efforts. +- **Analyzed bytes**: An overview of the analyzed bytes for this community. The progress bar shows the following: + - Current: Actual data usage for this community for the current month. + - Projected: An estimate of the data volume that is anticipated to be transmitted over a month. It is calculated based on analyzing past data usage trends. +- **Executed Playbook actions**: Total number of playbook actions taken based on playbooks in this community. +- **Date selector**: In the top right corner of the page, it allows users to browse and analyze consumption data by month. -### Definition of an asset +For communities with the `Intelligence plan` only, there are no widgets yet, but new ones should be implemented soon. -An asset refers to any equipment that produces logs, including user workstations, servers, and virtual machines. Customers subscribe based on the number of assets they wish to monitor, which directly influences their data usage and associated costs. +### Multi-tenant communities -## Plans and usage +As members of a workspace, users can quickly review consumption metrics across all of their communities. In addition to the previously described widgets, a summary table lists the following information: -### Defend CORE and PRIME plans +- **Community name** +- **Number of subscribed assets**: Total subscribed assets in each community (based on what has been defined in your contract with Sekoia). +- **Type of subscription**: The subscription plan type. +- **Analyzed bytes**: The amount of data analyzed by month, applicable to your plan. -Depending on the plan you are subscribed to, you may have different thresholds for data usage: -- **Defend CORE**: Fair use threshold is set at **3GB per asset per month**. -- **Defend PRIME**: Faire use threshold is set at **5GB per asset per month**. -Both plans implement a soft violation policy. If a user exceeds the set thresholds, they will be notified, but no immediate penalties will be enforced. -### Defend FLOW Plan -The FLOW plan establishes threshold metrics for data usage based on a predefined number of GB per month.