Panther Log Forwarder (Beta)
Forward logs from your on-premises devices to Panther using the Panther Log Forwarder
Overview
Panther Log Forwarder is a lightweight tool that collects logs from files or syslog and sends them to Panther. The easiest way to get started is to create a Log Forwarder source in the Panther Console, which provisions a Panther-managed S3 bucket and generates a ready-to-use configuration for you. Alternatively, you can send logs to your own S3 bucket.
Download
Download the latest release for your platform:
To pin to a specific version for reproducible installs or controlled upgrades, replace latest in the download URL with a released version tag. The latest/ path always resolves to the newest release, while versioned paths follow this pattern:
https://panther-community-us-east-1.s3.us-east-1.amazonaws.com/log-forwarder/<version>/panther-log-forwarder_linux_<arch>.tar.gz<version>— a released version tag, e.g.,v0.1.3(the current latest release)<arch>—amd64(x86_64) orarm64(ARM64)
Each version directory also contains the matching .tar.gz.sha256 checksum file. For example, to download v0.1.3 for Linux (x86_64):
wget https://panther-community-us-east-1.s3.us-east-1.amazonaws.com/log-forwarder/v0.1.3/panther-log-forwarder_linux_amd64.tar.gz
wget https://panther-community-us-east-1.s3.us-east-1.amazonaws.com/log-forwarder/v0.1.3/panther-log-forwarder_linux_amd64.tar.gz.sha256Get Started
Recommended: Create a Log Forwarder source in the Panther Console. It automatically provisions a Panther-managed S3 bucket to send logs to and generates a ready-to-use YAML configuration for your PLF agent, no additional infrastructure required.
Follow these steps to install the log forwarder and start sending logs in minutes. This example sends logs from a file to a Panther-managed S3 bucket using a Log Forwarder source. To send logs to your own S3 bucket, or for more configuration options, see below.
Prerequisites
Linux with systemd (Ubuntu 20.04+, Debian 11+, RHEL 8+, Rocky Linux 8+)
Sudo/root access
A Log Forwarder source created in the Panther Console — this provisions the S3 bucket and generates the YAML configuration you'll use below. (To send logs to your own S3 bucket instead, see S3 Output.)
Step 1: Install
Step 2: Configure a Forwarder
Save the YAML configuration generated by your Log Forwarder source to a file in /etc/panther-log-forwarder/forwarders.d/. It already contains the S3 bucket, region, and credentials for your Panther-managed bucket, so no edits are needed.
The generated configuration looks like this:
The generated configuration file contains AWS credentials, so store it securely.
Step 3: Validate and Start
Logs should appear in Panther's Data Explorer within a few minutes.
Commands
panther-log-forwarder validate
Validate configuration syntax
panther-log-forwarder check-connectivity
Test connectivity to all destinations
panther-log-forwarder check-connectivity --forwarder NAME
Test a specific forwarder
panther-log-forwarder start
Run in foreground (for debugging)
panther-log-forwarder status
Show health, metrics, and per-forwarder stats
panther-log-forwarder --version
Show version
For production, use systemd: sudo systemctl start panther-log-forwarder
Configuration Reference
The log forwarder uses two types of configuration files:
Global settings in
/etc/panther-log-forwarder/panther.conf— created automatically during installation with sensible defaultsForwarder definitions in
/etc/panther-log-forwarder/forwarders.d/*.yaml— you create these to define what logs to collect and where to send them
Global Configuration
The installer creates /etc/panther-log-forwarder/panther.conf with default values. Edit it only if you need to change defaults:
Forwarder Configuration
Each forwarder is added with a unique name in under forwarders and has an input (what to collect) and output (where to send) section.
Forwarder names must start with a letter, contain only alphanumeric characters, underscores, or hyphens, and be 1-64 characters long.
You can organize forwarders across multiple files or put them all in one, any .yaml file in forwarders.d/ is loaded.
Input Types
File Input
Tail log files using glob patterns:
type
Yes
-
Must be file
path
Yes
-
File path or glob pattern
excludes
No
-
Array of glob patterns to exclude
read_from
No
end
end = new lines only; beginning = read existing content
format
No
-
Content format hint. Set to syslog when tailing syslog-formatted files (use with parse: json, see below)
parse
No
-
Set to json to parse syslog lines into structured JSON (requires format: syslog)
Using read_from: beginning will send all existing log lines in the file. For large files, this may take considerable time and disk buffer space.
Notes:
Only newline-delimited logs are supported (one log entry per line)
Multi-line logs are not currently supported
On startup, the log forwarder validates that file paths are accessible and reports permission errors before starting
Syslog Input
Receive syslog messages over the network:
type
Yes
Must be syslog
mode
Yes
tcp or udp
address
Yes
Host and port to listen on
parse
No
Set to json to parse syslog messages into structured JSON
Notes:
Messages will be sent in raw format to Panther. If your messages adhere to RFC 3164 or RFC 5424 format, you can use the built in corresponding syslog schema in Panther (
Syslog.RFC5424/Syslog.RFC3164) for proper parsing and classification.Use
parse: jsonto send the message parsed as json to your Panther source. Parsing is best effort and covers most common syslog formats, additionally to RFC compliant ones.
S3 Output
The log forwarder sends logs to an Amazon S3 bucket. When you create a Log Forwarder source in the Panther Console, Panther provisions the bucket and generates this configuration for you. To send logs to your own S3 bucket, use either of two authentication paths:
Inline static credentials - set
auth.access_key_idandauth.secret_access_key. This is what a Log Forwarder source generates for you, and it's also useful when the forwarder runs outside AWS or you prefer keeping credentials in theyamlfile rather than providing them to the systemd unit.AWS default credential chain (on EC2 / ECS / EKS) - omit the
authblock. The AWS SDK resolves credentials from the instance profile / task role or environment variables (AWS_ACCESS_KEY_ID,AWS_SECRET_ACCESS_KEY) automatically. File-based credentials (~/.aws/credentials) are not supported by default, unless you explicitly grant access to thepanther-log-forwarderuser to read those files.
type
Yes
-
Must be s3
bucket
Yes
-
S3 bucket name
region
Yes
-
AWS region (e.g., us-east-1)
key_prefix
No
logs/{forwarder_name}/%Y/%m/%d/
S3 key prefix (supports strftime tokens, must end with /)
buffer_size
No
3GB
Per-forwarder disk buffer size override
Minimum IAM permissions:
The IAM identity used must have s3:PutObject and s3:ListBucket permissions on the target bucket. If the bucket uses SSE-KMS with a customer-managed key, also grant kms:GenerateDataKey on that key ARN. Here's how an example policy looks like
Notes:
Logs are gzip-compressed before upload
Batching: 10MB or 60 seconds (whichever comes first)
Credential Management
S3 Output - AWS Credentials
Forwarder files are secured with 0640 permissions and root:panther-log-forwarder ownership - only root can write, only the agent service can read.
S3 output defaults to the AWS credential chain (instance profile, environment variables) - no auth block needed. To supply explicit credentials, add an auth block:
Field
Required (if auth set)
Description
access_key_id
Yes
AWS access key ID
secret_access_key
Yes
AWS secret access key
Both fields accept either plaintext values or ${ENV_VAR} references that are resolved when the agent starts.
For env vars, provide the values via the systemd unit (Environment= inline or, EnvironmentFile= pointing at a chmod 600 file)
Disk Buffering
Each forwarder has its own disk buffer (default: 3GB) to prevent data loss during network outages. Logs are stored on disk until they can be forwarded.
When the buffer fills:
File inputs - the forwarder blocks and stops reading until buffer space frees up (no data loss, but log files may grow)
Syslog inputs - the forwarder drops newest incoming messages (prevents memory issues, but some logs may be lost)
Configure buffer size globally in panther.conf or per-forwarder with buffer_size in the output section.
The default 3GB is sufficient for most deployments. Consider increasing the buffer size for high-volume sources to ensure no data loss.
Syslog Parsing
By default, syslog messages are forwarded as raw text. Adding parse: json to the input parses syslog messages into structured JSON with fields like timestamp, hostname, appname, severity, and message.
This works with both input types:
Network syslog (
type: syslog+parse: json) — uses built-in syslog parsingFile syslog (
type: file+format: syslog+parse: json) — parses each line as a syslog message
Network syslog with parsing
File syslog with parsing
Use format: syslog and parse: json on the input to indicate the file contains syslog-formatted lines that should be parsed:
When parse: json is enabled, parsing is best-effort, however it covers most common syslog formats including RFC 3164 / RFC 5424. Lines that fail to parse are dropped.
More Examples
Syslog Server
Multiple Files with Exclusions
Multiple Forwarders in One File
Syslog to S3 with JSON Parsing
S3 Output
Forwarder running in AWS environment, or with env vars provided to the systemd unit (no auth block needed):
S3 Output with Inline AWS Credentials
Forwarder running outside AWS, with explicit credentials defined:
Troubleshooting
Checking Logs
There are two log files to check when troubleshooting:
/var/log/panther-log-forwarder/log-forwarder.log- Check this for issues with the forwarder service itself, such as startup failures, configuration errors, and connectivity problems./var/log/panther-log-forwarder/vector.log- Check this for issues with the data pipeline, such as log ingestion problems, parsing errors, and delivery failures.
Log Forwarder Won't Start
Common causes:
Configuration errors - Run
sudo panther-log-forwarder validatePermission issues - Verify
/etc/panther-log-forwarder/forwarders.d/has0750permissionsFile access errors - The log forwarder checks file paths on startup. Verify paths exist and are readable by the
panther-log-forwarderuserPort conflicts - For syslog inputs, ensure the listening port is available
No Logs Appearing in Panther
Common causes:
Invalid credentials - Verify the AWS credentials in your configuration are valid. If you're using a Log Forwarder source, confirm the credentials match the generated ones from the Panther Console.
Incorrect bucket or region - Double-check the
bucketandregionvalues in your configuration.Network issues - Test connectivity from the host to S3
File path issues - Verify paths exist and are readable
S3 permissions - For S3 output, verify IAM permissions allow
s3:PutObjectands3:ListBucket(used by HeadBucket). Addkms:GenerateDataKeyif the bucket uses SSE-KMS with a customer-managed key.
Configuration Errors
Common issues:
YAML syntax errors (indentation, quotes)
Missing required fields (
typein input;bucketandregion)Invalid input type (must be
fileorsyslog)Invalid output type (must be
s3)Invalid forwarder name (must start with a letter, alphanumeric/underscore/hyphen only)
Operations
Adding New Forwarders
Create a new Log Forwarder source in the Panther Console (or configure an S3 output to your own bucket).
Add a new YAML file in
/etc/panther-log-forwarder/forwarders.d/.Validate:
sudo panther-log-forwarder validateRestart:
sudo systemctl restart panther-log-forwarder
Updating Configuration
Edit files in
/etc/panther-log-forwarder/.Validate:
sudo panther-log-forwarder validateRestart:
sudo systemctl restart panther-log-forwarder
Upgrading
Download the new release tarball and checksum for your platform (see Download).
Verify the checksum, extract, and run the installer:
The installer automatically restarts the service if it was running. Verify the upgrade:
Configuration files in /etc/panther-log-forwarder/ are preserved during upgrades.
Uninstalling
File Locations
/etc/panther-log-forwarder/panther.conf
Global settings
/etc/panther-log-forwarder/forwarders.d/*.yaml
Forwarder configs
/var/log/panther-log-forwarder/log-forwarder.log
Log forwarder logs
/var/log/panther-log-forwarder/vector.log
Vector logs
Last updated
Was this helpful?

