Skip to content

Commit

Permalink
simplify usage content
Browse files Browse the repository at this point in the history
  • Loading branch information
ka0ula authored Nov 27, 2024
1 parent bcca82a commit 0e90f15
Showing 1 changed file with 17 additions and 47 deletions.
64 changes: 17 additions & 47 deletions docs/getting_started/usage.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 0e90f15

Please sign in to comment.