-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add content to usage page #2095
Merged
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
37e3772
Create usage.md
ka0ula 0192908
Update mkdocs.yml
ka0ula e01b29e
Update usage.md
ka0ula cca7313
Update usage.md
ka0ula e89a230
Update usage.md
ka0ula e9892e9
Update usage.md
ka0ula 8506fbd
Update docs/getting_started/usage.md
ka0ula 9e18268
Update docs/getting_started/usage.md
ka0ula dec82f4
Update docs/getting_started/usage.md
ka0ula b3f197a
Update docs/getting_started/usage.md
ka0ula 5e1907d
Apply suggestions from code review
ka0ula 68b630e
remove soft hard limits
ka0ula bcca82a
Update usage.md
ka0ula 0e90f15
simplify usage content
ka0ula File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# 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. | ||
|
||
## 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 | ||
|
||
### 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. | ||
|
||
### 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 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 | ||
|
||
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**: 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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure we should document our usage policies in this document. It should be in the contract.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gbossert you recommend removing the whole section? I think we need to explain what we mean by fair use and how it is calculated