Skip to content

Commit f853d8e

Browse files
committed
Update snort documentation
Update readme sections titles and update changelog.
1 parent aa8712f commit f853d8e

File tree

5 files changed

+17
-25
lines changed

5 files changed

+17
-25
lines changed

packages/snort/_dev/build/docs/README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following log formats are supported:
1818
- Alert Fast output (from logfile or syslog)
1919
- Snort 3 JSON log file
2020

21-
This integration is compatible with Elastic Stack versions `^8.11.0 || ^9.0.0`.
21+
This integration is compatible with Elastic Stack versions 8.11.0 and higher.
2222

2323
### How it works
2424

@@ -56,9 +56,7 @@ The Snort integration collects log messages containing information about network
5656

5757
Elastic Agent must be installed to collect logs and send them to the Elastic Stack. For more details, check the Elastic Agent [installation instructions](docs-content://reference/fleet/install-elastic-agents.md). You can install only one Elastic Agent per host.
5858

59-
### Onboard / configure
60-
61-
#### 1. Configure Snort
59+
### Set up steps in Snort
6260

6361
1. **Install Snort**: If not already installed, download the latest version from the [official website](https://www.snort.org/) and follow the installation instructions for your operating system.
6462
2. **Configure `snort.conf`**: Edit the `snort.conf` file to set network variables, define rule paths, and configure output plugins.
@@ -71,7 +69,7 @@ Elastic Agent must be installed to collect logs and send them to the Elastic Sta
7169
```
7270
5. **Start Snort**: Start Snort to begin monitoring network traffic.
7371
74-
#### 2. Configure the Elastic Integration
72+
### Set up steps in Kibana
7573
7674
1. In Kibana, go to **Management > Integrations**.
7775
2. Search for "Snort" and click on it.
@@ -101,9 +99,7 @@ For help with Elastic ingest tools, check [Common problems](https://www.elastic.
10199
102100
For more information, refer to the official [Snort Documentation](https://www.snort.org/documents).
103101
104-
## Scaling
105-
106-
For high-traffic environments, deploying Snort in a distributed architecture with multiple sensors can help balance the load and improve detection capabilities.
102+
## Performance and scaling
107103
108104
For more information on architectures that can be used for scaling Elastic ingest, check the [Ingest Architectures](https://www.elastic.co/docs/manage-data/ingest/ingest-reference-architectures) documentation.
109105
@@ -124,7 +120,3 @@ The `log` data stream collects all log types from Snort.
124120
### Inputs used
125121
126122
{{ inputDocs }}
127-
128-
### API usage
129-
130-
This integration does not use any external APIs.

packages/snort/changelog.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# newer versions go on top
2+
- version: "1.21.0"
3+
changes:
4+
- description: Update documentation
5+
type: enhancement
6+
link: https://github.com/elastic/integrations/pull/16075
27
- version: "1.20.0"
38
changes:
49
- description: Preserve event.original on pipeline error.

packages/snort/docs/README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following log formats are supported:
1818
- Alert Fast output (from logfile or syslog)
1919
- Snort 3 JSON log file
2020

21-
This integration is compatible with Elastic Stack versions `^8.11.0 || ^9.0.0`.
21+
This integration is compatible with Elastic Stack versions 8.11.0 and higher.
2222

2323
### How it works
2424

@@ -56,9 +56,7 @@ The Snort integration collects log messages containing information about network
5656

5757
Elastic Agent must be installed to collect logs and send them to the Elastic Stack. For more details, check the Elastic Agent [installation instructions](docs-content://reference/fleet/install-elastic-agents.md). You can install only one Elastic Agent per host.
5858

59-
### Onboard / configure
60-
61-
#### 1. Configure Snort
59+
### Set up steps in Snort
6260

6361
1. **Install Snort**: If not already installed, download the latest version from the [official website](https://www.snort.org/) and follow the installation instructions for your operating system.
6462
2. **Configure `snort.conf`**: Edit the `snort.conf` file to set network variables, define rule paths, and configure output plugins.
@@ -71,7 +69,7 @@ Elastic Agent must be installed to collect logs and send them to the Elastic Sta
7169
```
7270
5. **Start Snort**: Start Snort to begin monitoring network traffic.
7371
74-
#### 2. Configure the Elastic Integration
72+
### Set up steps in Kibana
7573
7674
1. In Kibana, go to **Management > Integrations**.
7775
2. Search for "Snort" and click on it.
@@ -101,9 +99,7 @@ For help with Elastic ingest tools, check [Common problems](https://www.elastic.
10199
102100
For more information, refer to the official [Snort Documentation](https://www.snort.org/documents).
103101
104-
## Scaling
105-
106-
For high-traffic environments, deploying Snort in a distributed architecture with multiple sensors can help balance the load and improve detection capabilities.
102+
## Performance and scaling
107103
108104
For more information on architectures that can be used for scaling Elastic ingest, check the [Ingest Architectures](https://www.elastic.co/docs/manage-data/ingest/ingest-reference-architectures) documentation.
109105
@@ -392,7 +388,3 @@ To collect logs via UDP, select **Collect logs via UDP** and configure the follo
392388
- Read Timeout - How long to wait for incoming packets before checking for shutdown
393389
</details>
394390

395-
396-
### API usage
397-
398-
This integration does not use any external APIs.

packages/snort/manifest.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: snort
22
title: Snort
3-
version: "1.20.0"
3+
version: "1.21.0"
44
description: Collect logs from Snort with Elastic Agent.
55
type: integration
66
icons:

packages/snort/validation.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
errors:
22
exclude_checks:
33
- SVR00005 # Kibana version for saved tags.
4+
docs_structure_enforced:
5+
enabled: true
6+
version: 1

0 commit comments

Comments
 (0)