Skip to content
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

📝 update details page images + remediation components metric #597

Merged
merged 1 commit into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 30 additions & 18 deletions crowdsec-docs/unversioned/console/security_engines/details_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Learn how to view the details of a Security Engine in the CrowdSec

This page will reference information about a specific Security Engine. This page is your one-stop resource for understanding everything related to the Security Engine you're interested in.

![Security Engine details page](/img/console/security_engines/details-page.png)
![Security Engine details page](/img/console/security_engines/details-page.jpeg)

## Usage

Expand All @@ -19,21 +19,35 @@ At the top of the page, the essential information regarding the Security Engine

Quick actions are available from the summary to apply changes to your Security Engine.

- [Update name or tags](/console/security_engines/name_and_tags.md)
- [Transfer an Engine](/console/security_engines/transfer_engine.md)
- [Remove an Engine](/console/security_engines/remove_engine.md)
- [Update name or tags](/console/security_engines/name_and_tags.md)
- [Transfer an Engine](/console/security_engines/transfer_engine.md)
- [Remove an Engine](/console/security_engines/remove_engine.md)

![Security Engine details page](/img/console/security_engines/details-page-actions.png)

### Log Processors
### Remediation components

The Log Processors section will only be displayed if the Security Engines have multiple log processors, indicating a Distributed Setup. Here, you can access all essential information regarding the log processors and their current version.
The [remediation component](/bouncers/intro.md) in CrowdSec will apply either the decisions made by CrowdSec, the blocklists or the custom decisions.

:::info
A warning will be displayed if any Security Engine has an outdated version.
:::
![Security Engine details page](/img/console/security_engines/details-page-remediation.png)

![Security Engine details page](/img/console/security_engines/details-page-log-processors.png)
#### Metrics

Starting from version 1.6.3, CrowdSec’s remediation components now display detailed metrics. These metrics provide valuable insights into the number of traffic drops and the volume of traffic processed by each remediation component.

To access a detailed view of these metrics, simply click the **Get More Info** button on any active remediation component card. This will show you the effectiveness of each decision made by the Security Engine, based on the installed blocklists.

![Security Engine details page](/img/console/security_engines/details-page-remediation-metrics.png)

In the same modal, you can view the active decisions. This section provides information about the number of decisions made by each source of decisions.

![Security Engine details page](/img/console/security_engines/details-page-remediation-decisions.png)

#### Inactive remediation components

Remediation components are meant to block attackers. Having inactive remediation component can compromise the security of your Security Engine, as they cannot apply decisions.

![Security Engine details page](/img/console/security_engines/details-page-inactive-bouncer.png)

### Blocklists

Expand All @@ -57,14 +71,12 @@ By clicking on a scenario, you can access essential information about the scenar

![Security Engine details page](/img/console/security_engines/details-page-scenarios-hub.png)

### Remediation components

The [remediation component](/bouncers/intro.md) in CrowdSec will apply either the decisions made by CrowdSec or the custom decisions. The complete list of decisions from the dedicated section is available at the bottom of the page.

![Security Engine details page](/img/console/security_engines/details-page-remediation.png)
### Log Processors

#### Inactive remediation components
The Log Processors section will only be displayed if the Security Engines have multiple log processors, indicating a Distributed Setup. Here, you can access all essential information regarding the log processors and their current version.

Remediation components are meant to block attackers. Having inactive remediation component can compromise the security of your Security Engine, as they cannot apply decisions.
:::info
A warning will be displayed if any Security Engine has an outdated version.
:::

![Security Engine details page](/img/console/security_engines/details-page-inactive-bouncer.png)
![Security Engine details page](/img/console/security_engines/details-page-log-processors.png)
Loading