From f7634188e2ead0218d36c53c51226d474c7ce1e4 Mon Sep 17 00:00:00 2001 From: cherryleaf-ellis Date: Wed, 20 Apr 2022 17:29:02 +0100 Subject: [PATCH 1/3] update pfSense documentation updated links in the documentation to the vendor documentation. --- packages/pfsense/_dev/build/docs/README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/packages/pfsense/_dev/build/docs/README.md b/packages/pfsense/_dev/build/docs/README.md index f5f38777548..1eb37e6c5fd 100644 --- a/packages/pfsense/_dev/build/docs/README.md +++ b/packages/pfsense/_dev/build/docs/README.md @@ -1,18 +1,20 @@ # 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. + +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:///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:///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 From 85f5470dc4b1072ae087984a1e00cd577955f7b1 Mon Sep 17 00:00:00 2001 From: cherryleaf-ellis Date: Wed, 20 Apr 2022 17:32:22 +0100 Subject: [PATCH 2/3] update changelog and ran build --- packages/pfsense/changelog.yml | 5 +++++ packages/pfsense/docs/README.md | 16 +++++++++------- packages/pfsense/manifest.yml | 2 +- 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/packages/pfsense/changelog.yml b/packages/pfsense/changelog.yml index 6b04f43312a..ea0a73a3661 100644 --- a/packages/pfsense/changelog.yml +++ b/packages/pfsense/changelog.yml @@ -1,4 +1,9 @@ # newer versions go on top +- version: "0.3.2" + changes: + - description: updated links in the documentation to the vendor documentation + type: enhancement + link: https://github.com/elastic/integrations/pull/3145 - version: "0.3.1" changes: - description: Add documentation for multi-fields diff --git a/packages/pfsense/docs/README.md b/packages/pfsense/docs/README.md index efadc618805..d6d3bf01d8d 100644 --- a/packages/pfsense/docs/README.md +++ b/packages/pfsense/docs/README.md @@ -1,18 +1,20 @@ # 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. + +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:///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:///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 diff --git a/packages/pfsense/manifest.yml b/packages/pfsense/manifest.yml index bd9bee418a1..6d98aa94db3 100644 --- a/packages/pfsense/manifest.yml +++ b/packages/pfsense/manifest.yml @@ -1,6 +1,6 @@ name: pfsense title: pfSense Logs -version: 0.3.1 +version: 0.3.2 release: experimental description: Collect and parse logs from pfSense devices with Elastic Agent. type: integration From 098f969ccfdf2c416a2985e27a89cfb3001eae87 Mon Sep 17 00:00:00 2001 From: cherryleaf-ellis Date: Wed, 4 May 2022 11:29:16 +0100 Subject: [PATCH 3/3] Update readme removed HTML note code --- packages/pfsense/_dev/build/docs/README.md | 5 ++--- packages/pfsense/docs/README.md | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/packages/pfsense/_dev/build/docs/README.md b/packages/pfsense/_dev/build/docs/README.md index 1eb37e6c5fd..12caf3e89db 100644 --- a/packages/pfsense/_dev/build/docs/README.md +++ b/packages/pfsense/_dev/build/docs/README.md @@ -7,9 +7,8 @@ Currently the integration supports parsing the Firewall, Unbound, DHCP Daemon, O 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 use 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. diff --git a/packages/pfsense/docs/README.md b/packages/pfsense/docs/README.md index 8bb4302c425..816df202394 100644 --- a/packages/pfsense/docs/README.md +++ b/packages/pfsense/docs/README.md @@ -7,9 +7,8 @@ Currently the integration supports parsing the Firewall, Unbound, DHCP Daemon, O 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 use 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.