Skip to content

Commit

Permalink
Create usage.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ka0ula authored Nov 19, 2024
1 parent 69c3395 commit 37e3772
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions docs/getting_started/usage.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 37e3772

Please sign in to comment.