Skip to content

Commit ed4ccb9

Browse files
author
jdv
committed
fkin docusaurus limitations :D we'll beautify it with react then
1 parent 206d5bc commit ed4ccb9

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

crowdsec-docs/unversioned/getting_started/healthcheck.mdx

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The HTTP collection and the Linux collection contain **dummy scenarios** allowin
2727
:::
2828

2929
<details>
30-
<summary>Test **HTTP** detection</summary>
30+
<summary>Test HTTP detection</summary>
3131
Let's trigger the `crowdsecurity/http-generic-test` dummy scenario by calling a *probe path* on your web server.
3232

3333
1️⃣ Request your service URL with the following path: `/crowdsec-test-NtktlJHV4TfBSK3wvlhiOBnl`
@@ -41,7 +41,7 @@ Note that this scenario has a delay of 5 minutes before it can re-trigger _(blac
4141
</details>
4242

4343
<details>
44-
<summary>☑️ Test **SSH** detection</summary>
44+
<summary>Test SSH detection</summary>
4545
Let's trigger the `crowdsecurity/ssh-generic-test` dummy scenario by logging in to your server via SSH with a specific user.
4646

4747
1️⃣ Try to authenticate to your server via SSH using the following user: `crowdsec-test-NtktlJHV4TfBSK3wvlhiOBnl`.
@@ -55,7 +55,7 @@ Note that this scenario has a delay of 5 minute before it can re-trigger _(black
5555
</details>
5656

5757
<details>
58-
<summary>☑️ Test CrowdSec WAF with an AppSec detection</summary>
58+
<summary>Test CrowdSec WAF with an AppSec detection</summary>
5959
If you are using an AppSec-capable bouncer and have configured CrowdSec WAF, you can test the detection of an AppSec scenario.
6060
It's similar to the HTTP detection test, but it will trigger `crowdsecurity/appsec-generic-test`.
6161

@@ -84,22 +84,23 @@ If not, check the troubleshooting section below
8484
<summary>🚨 Detection Troubleshooting</summary>
8585

8686
*No alerts triggered? Let's investigate: Here are some tests to identify where the issue might be.*
87-
If you installed CrowdSec Security Engine on the same host as the service you want to protect, the install wizards should have automatically detected the service and installed the appropriate parsers and scenarios.
87+
88+
If you installed **CrowdSec Security Engine** on the same **Host** as the service you want to protect, the install wizards should have automatically detected the service and installed the appropriate parsers and scenarios.
89+
8890
If you have non-default paths or format for your logs, or if you chose other installation methods (docker, kubernetes..), you may need to manually install the parsers and scenarios.
8991

9092
**This troubleshooting section will help you identify the issue and guide you through the necessary steps to fix it.**
9193

9294
<details>
9395
<summary>Acquisition metrics check: are your logs read and parsed?</summary>
9496

95-
The acquisition and parsing aspect of CrowdSec is crucial, as it tells The Security Engine which logs to read and how to parse them.
96-
You can setup multiple datasources (files, syslog, etc.), for more details you can refer to the [datasources documentation](https://doc.crowdsec.net/docs/next/log_processor/data_sources/intro).
97+
The acquisition and parsing aspect of CrowdSec is crucial, as it tells The Security Engine which logs to read and how to parse them. You can setup multiple datasources (files, syslog, etc.), for more details you can refer to the [datasources documentation](https://doc.crowdsec.net/docs/next/log_processor/data_sources/intro).
9798

9899
Let's do a Top Down check using the `cscli metrics` command to see if your logs are being read and parsed correctly.
99100

100101
<CodeBlock className="language-bash">sudo cscli metrics show acquisition parsers</CodeBlock>
101102

102-
- You should see the names of the log files/stream configured in the acquisition files, and the number of lines parsed for each of them.
103+
- You should see the **names of the log files/stream** configured in the acquisition files, and the number of lines parsed for each of them.
103104
- The number of "Lines parsed" should be non-zero for each of the files you configured in the acquisition section.
104105
- The parsers metrics show you what parsers were successfully used. Look for the name of the parsers installed for the logs you're reading
105106

@@ -118,11 +119,13 @@ If not, check the troubleshooting section below
118119
<details>
119120
<summary>Acquisition Troubleshooting: are your logs properly declared as datasources</summary>
120121

121-
Your acquisition configuration is located in `/etc/crowdsec/acquis.yaml` or in `/etc/crowdsec/acquis.d/anyName.yaml`.
122+
Your acquisition configuration is located in the `crowdsec` directory under `acquis.yaml` or `acquis.d/anyName.yaml`.
123+
The crowdsec directory changes depending on your OS and installation method, for example, on Debian like OS it is usually located in `/etc/crowdsec/`.
124+
125+
You may want to check your current acquisition configuration or [add a new acquisition file](https://doc.crowdsec.net/u/getting_started/post_installation/acquisition_new).
122126
- Check that the datasource is properly setup: file path or correct port for syslog server...
123127
- Ensure that the type declared matches the parser expected to be used: nginx, apache, syslog, etc.
124128
- for more information, check the [documentation for the various datasources](https://doc.crowdsec.net/docs/next/log_processor/data_sources/intro)
125-
126129
</details>
127130

128131
<details>

0 commit comments

Comments
 (0)