-
Notifications
You must be signed in to change notification settings - Fork 1.5k
[AI-5206] DDS: WatchGuard Firebox Integration v1.0.0 #20030
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
Open
manan-crest
wants to merge
11
commits into
DataDog:master
Choose a base branch
from
bhargavnariyanicrest:watchguard-firebox-v1.0.0
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+12,788
−0
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
08b5fc8
Add: watchguard firebox integration
manan-crest 49f0cd9
Update: fix manifest
manan-crest 6d2f3d2
Update: pipeline CI checks
manan-crest 2b05476
Update: changelog file name
manan-crest a314954
Add: images and Update: pipeline and dashboards
manan-crest c43677b
Update: add pipeline results
manan-crest 8c6e955
Add: watchguard svg logo
manan-crest d01e455
Add: dashboard images
manan-crest 770bd79
Update: CODEOWNERS
manan-crest 5028068
Update: CODEOWNERS tags
manan-crest b7e93e4
Update: address review comments
manan-crest File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# CHANGELOG - WatchGuard Firebox | ||
|
||
<!-- towncrier release notes start --> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,140 @@ | ||
## Overview | ||
|
||
[WatchGuard Firebox][4] is a network security platform offering comprehensive threat protection, including firewall, networking, and other security features, suitable for various network environments, from small offices to large enterprises. | ||
|
||
This integration enriches and ingests the following events: | ||
|
||
- **Firewall Events**: Represents log messages generated by your Firebox for events that occur on the Firebox and for traffic managed by some packet filter policies. In addition to normal traffic, this can include messages related to feature keys, subscription services, server load balancing, and other features configured on your Firebox. | ||
- **Networking Events**: Represents log messages generated for traffic related to the connections through your Firebox. This can include events related to interface activity, dynamic routing, PPPoE connections, and DHCP server requests. | ||
- **Management Events**: Represents log messages generated for activity on your Firebox. This includes when changes are made to the device configuration and Device Management user accounts, for user authentication to the Firebox, and actions related to system settings. | ||
- **VPN Events**: Represents log messages generated for processes related to the all VPNs configured on your Firebox. This includes changes to the VPN configuration, tunnel status, and daemon activity. | ||
- **Proxy Policy Events**: Represents log messages generated for traffic managed by the proxy policies configured on your Firebox. This can include events related to traffic through the proxy, proxy actions, and security services. | ||
|
||
This integration seamlessly collects all the above listed logs, channeling them into Datadog for analysis. Leveraging the built-in logs pipeline, these logs are parsed and enriched, enabling effortless search and analysis. The integration provides insight into firewall, networking, management, VPN, and proxy policy events through the out-of-the-box dashboards. Additionally, it includes ready-to-use Cloud SIEM detection rules for enhanced monitoring and security. | ||
|
||
## Setup | ||
|
||
### Installation | ||
|
||
To install the WatchGuard Firebox integration, run the following Agent installation command and the steps below. For more information, see the [Integration Management][5] documentation. | ||
|
||
**Note**: This step is not necessary for Agent version >= 7.66.0. | ||
|
||
Linux command: | ||
|
||
```shell | ||
sudo -u dd-agent -- datadog-agent integration install datadog-watchguard-firebox==1.0.0 | ||
``` | ||
|
||
### Configuration | ||
|
||
#### Log collection | ||
|
||
1. Collecting logs is disabled by default in the Datadog Agent. Enable it in `datadog.yaml`: | ||
|
||
```yaml | ||
logs_enabled: true | ||
``` | ||
|
||
2. Add this configuration block to your `watchguard-firebox.d/conf.yaml` file to start collecting your WatchGuard Firebox logs. See the sample [watchguard-firebox.d/conf.yaml][6] for available configuration options. | ||
|
||
```yaml | ||
logs: | ||
- type: udp | ||
port: <PORT> | ||
service: watchguard-firebox | ||
source: watchguard-firebox | ||
``` | ||
|
||
Note: | ||
- PORT: Port should be identical to the port provided in **Configure Syslog Message Forwarding from WatchGuard Firebox Server**. | ||
- It is recommended not to change the service and source values, as these parameters are integral to the pipeline's operation. | ||
|
||
3. [Restart the Agent][1]. | ||
|
||
#### Configure Syslog Message Forwarding from WatchGuard Firebox Server | ||
|
||
1. Log in to **Fireware Web UI** with an administrator account. | ||
2. Select **System** > **Logging**. | ||
3. Select the **Syslog Server** tab. | ||
4. Select the **Send log messages to these syslog servers** check box. | ||
5. Click **Add** to open the Syslog Server dialog box. | ||
6. In the **IP Address** text box, enter the IP address of the server on which datadog-agent is installed. | ||
7. In the **Port** text box, enter the port you configured to receive the Firebox logs. | ||
8. From the **Log Format** drop-down list, select **Syslog**. | ||
9. Select **The time stamp** and **The serial number of the device** check boxes. | ||
10. Click **OK**. | ||
|
||
### Validation | ||
|
||
[Run the Agent's status subcommand][2] and look for `watchguard-firebox` under the Checks section. | ||
|
||
## Data Collected | ||
|
||
### Logs | ||
|
||
The WatchGuard Firebox integration collects firewall, networking, management, VPN, and proxy policy Events. | ||
|
||
### Metrics | ||
|
||
The WatchGuard Firebox integration does not include any metrics. | ||
|
||
### Events | ||
|
||
The WatchGuard Firebox integration does not include any events. | ||
|
||
## Troubleshooting | ||
|
||
### WatchGuard Firebox | ||
|
||
**Permission denied while port binding:** | ||
|
||
If you see a **Permission denied** error while port binding in the Agent logs, see the following instructions: | ||
|
||
1. Binding to a port number under 1024 requires elevated permissions. Grant access to the port using the `setcap` command: | ||
|
||
- Grant access to the port using the `setcap` command: | ||
|
||
```shell | ||
sudo setcap CAP_NET_BIND_SERVICE=+ep /opt/datadog-agent/bin/agent/agent | ||
``` | ||
|
||
- Verify the setup is correct by running the `getcap` command: | ||
|
||
```shell | ||
sudo getcap /opt/datadog-agent/bin/agent/agent | ||
``` | ||
|
||
With the expected output: | ||
|
||
```shell | ||
/opt/datadog-agent/bin/agent/agent = cap_net_bind_service+ep | ||
``` | ||
|
||
**Note**: Re-run this `setcap` command every time you upgrade the Agent. | ||
|
||
2. [Restart the Agent][1]. | ||
|
||
**Data is not being collected:** | ||
|
||
Make sure that traffic is bypassed from the configured port if the firewall is enabled. | ||
|
||
**Port already in use:** | ||
|
||
If you see the **Port <PORT_NUMBER> Already in Use** error, see the following instructions. The example below is for a PORT_NUMBER equal to 514: | ||
|
||
On systems using Syslog, if the Agent listens for events on port 514, the following error can appear in the Agent logs: `Can't start UDP forwarder on port 514: listen udp :514: bind: address already in use`. | ||
|
||
This error occurs because by default, Syslog listens on port 514. To resolve this error, take **one** of the following steps: | ||
|
||
- Disable Syslog. | ||
- Configure the Agent to listen on a different, available port. | ||
|
||
For any further assistance, contact [Datadog support][3]. | ||
|
||
[1]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent | ||
[2]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information | ||
[3]: https://docs.datadoghq.com/help/ | ||
[4]: https://www.watchguard.com/wgrd-products/network-security | ||
[5]: https://docs.datadoghq.com/agent/guide/integration-management/?tab=linux#install | ||
[6]: https://github.com/DataDog/integrations-core/blob/master/watchguard-firebox/datadog_checks/watchguard-firebox/data/conf.yaml.example |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
name: WatchGuard Firebox | ||
files: | ||
- name: watchguard_firebox.yaml | ||
options: | ||
- template: logs | ||
example: | ||
- type: udp | ||
port: <PORT> | ||
service: watchguard-firebox | ||
source: watchguard-firebox |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think log integrations review are handled by @DataDog/logs-integrations-reviewers instead of @DataDog/logs-core