Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 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
13 changes: 7 additions & 6 deletions packages/pfsense/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# pfSense Integration

This is an integration to parse certain logs from the PFsense firewall. It parses logs
received over the network via syslog (UDP). Currently the integration supports parsing the
Firewall, Unbound, DHCP Daemon, OpenVPN, IPsec, and HAProxy logs. All other events will be dropped.
This is an integration to parse certain logs from the [pfSense firewall](https://docs.netgate.com/pfsense/en/latest/). It parses logs
received over the network via syslog (UDP).

Currently the integration supports parsing the Firewall, Unbound, DHCP Daemon, OpenVPN, IPsec, and HAProxy logs. All other events will be dropped.
The firewall, VPN, DHCP, and DNS logs are able to be individually selected via the "Remote Logging Options"
section within the pfSense settings page. In order to collect HAProxy or other "package" logs, the "Everything" option
must be selected. The module is by default configured to run with the `udp` input on port `9001`.

*The HAProxy logs are setup to be compatible with the dashboards from the HAProxy integration. Install the HAPrxoy integration assets to utilize them.
> Note: The HAProxy logs are setup to be compatible with the dashboards from the HAProxy integration. Install the HAPrxoy integration assets to use them.

**Important**
The pfSense integration supports both the BSD logging format and the Syslog format.
However the syslog format is recommended. It will provide the firewall hostname and timestamps with timezone information.
When using the BSD format, the `Timezone Offset` config must be set when deploying the agent or else the timezone will default to the timezone of the agent. See `https://<pfsense url>/status_logs_settings.php` and https://docs.netgate.com/pfsense/en/latest/monitoring/logs/settings.html for more information.
However, the syslog format is recommended. It will provide the firewall hostname and timestamps with timezone information.
When using the BSD format, the `Timezone Offset` config must be set when deploying the agent or else the timezone will default to the timezone of the agent. See `https://<pfsense url>/status_logs_settings.php` and [Log Settings in the pfSense documentation]( https://docs.netgate.com/pfsense/en/latest/monitoring/logs/settings.html) for more information.


## Logs
Expand Down
5 changes: 5 additions & 0 deletions packages/pfsense/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "0.4.1"
changes:
- description: updated links in the documentation to the vendor documentation
type: enhancement
link: https://github.com/elastic/integrations/pull/3145
- version: "0.4.0"
changes:
- description: Update to ECS 8.2
Expand Down
13 changes: 7 additions & 6 deletions packages/pfsense/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# pfSense Integration

This is an integration to parse certain logs from the PFsense firewall. It parses logs
received over the network via syslog (UDP). Currently the integration supports parsing the
Firewall, Unbound, DHCP Daemon, OpenVPN, IPsec, and HAProxy logs. All other events will be dropped.
This is an integration to parse certain logs from the [pfSense firewall](https://docs.netgate.com/pfsense/en/latest/). It parses logs
received over the network via syslog (UDP).

Currently the integration supports parsing the Firewall, Unbound, DHCP Daemon, OpenVPN, IPsec, and HAProxy logs. All other events will be dropped.
The firewall, VPN, DHCP, and DNS logs are able to be individually selected via the "Remote Logging Options"
section within the pfSense settings page. In order to collect HAProxy or other "package" logs, the "Everything" option
must be selected. The module is by default configured to run with the `udp` input on port `9001`.

*The HAProxy logs are setup to be compatible with the dashboards from the HAProxy integration. Install the HAPrxoy integration assets to utilize them.
> Note: The HAProxy logs are setup to be compatible with the dashboards from the HAProxy integration. Install the HAPrxoy integration assets to use them.

**Important**
The pfSense integration supports both the BSD logging format and the Syslog format.
However the syslog format is recommended. It will provide the firewall hostname and timestamps with timezone information.
When using the BSD format, the `Timezone Offset` config must be set when deploying the agent or else the timezone will default to the timezone of the agent. See `https://<pfsense url>/status_logs_settings.php` and https://docs.netgate.com/pfsense/en/latest/monitoring/logs/settings.html for more information.
However, the syslog format is recommended. It will provide the firewall hostname and timestamps with timezone information.
When using the BSD format, the `Timezone Offset` config must be set when deploying the agent or else the timezone will default to the timezone of the agent. See `https://<pfsense url>/status_logs_settings.php` and [Log Settings in the pfSense documentation]( https://docs.netgate.com/pfsense/en/latest/monitoring/logs/settings.html) for more information.


## Logs
Expand Down
2 changes: 1 addition & 1 deletion packages/pfsense/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: pfsense
title: pfSense Logs
version: 0.4.0
version: 0.4.1
release: experimental
description: Collect and parse logs from pfSense devices with Elastic Agent.
type: integration
Expand Down