Adding a LogForwarder

Prev Next

The LogForwarder collects, groups, and securely distributes audit logs within an enterprise environment. This section describes how to configure a LogForwarder in an AppGate system.


Before adding a LogForwarder

Before configuring a LogForwarder, ensure that appliance-to-appliance communication is set up correctly:

  • AppGate ZTNA uses single packed authorization (SPA) for appliance-to-appliance communications. SPA con conflict with firewalls configured to allow all TLS traffic. For this reason, it is strongly recommended to allow TCP 443 between appliances.

  • The LogForwarder accepts incoming traffic from peer appliances. Other members of the Collective connect to the LogForwarder to send audit logs and metrics. A static IP address or resolvable hostname must be configured in System Settings.  For more information about log data, see Audit logs.


Configuring a LogForwarder

To configure a LogForwarder:

  1. In the Add/Edit Appliance page, select the LogForwarder checkbox in the Functions tab.

  2. Complete the following configuration fields:  

Site Settings

  • Appliance Site. Select the Site from the dropdown list.

System TLS Connection (using SPA)

These settings are used for peer‑to‑peer traffic:

  • TLS Port. The inbound TLS connection port to the appliance.

  • Allowed Sources. Select +Add to add one or more allowed sources by adding the Address, Netmask Length, and the Network Interface. The requesting IP address must match at least one allowed source.

  • SPA Mode. Allows the SPA mode to be changed for a specific appliance. Select one of the following:

    • No override

    • Check TCP SPA key before allowing connections

    • Check UDP (and TCP) SPA key before allowing connections

  • Enable proxy protocol. When enabled, the appliance accepts only packets that include a proxy protocol header. AppGate ZTNA supports proxy protocol versions 1 and 2.

NOTE

When traffic originates from a known source, add that source to Allowed Sources. Failure to do so introduces a security risk.

External Log Settings

  • Log Collection Source. Select the Sites that send logs to the LogForwarder. Select from the following:

    • Collect Logs from all appliances.

    • Collect Logs from appliances in specific Sites.

Next, you will configure your output from the following:

AWS Kinesis

Use AWS Kinesis to stream log data. Complete the following fields to configure AWS Kinesis forwarding:

  • Type. Select either the real-time data streaming service or the Firehose data capture service.

  • Stream Name. Enter the name of the Kinesis stream.

  • Batch Size. Enter the number of records sent per batch (maximum 10,000).

  • Number of Partition Keys. Add one or more partition keys to determine which shards process the data.

  • Filter. Optional. Filter log records using a boolean expression written in JMESPath. See LogForwarder filtering for details.

  • AWS Access Method. Select the AWS API access method. If you use an instance IAM role, ensure that a valid access policy is configured.

    • Access Key ID. Enter the AWS Access Key ID for the IAM Role.

    • Secret Access Key. Enter the AWS Secret Access Key.

    • Region. Enter the region code for the Elasticsearch cluster location.

Azure Monitor

Forward logs to Azure Monitor using a Data Collection Endpoint (DCE) and Data Collection Rule (DCR).

AppGate ZTNA supports sends logs to the DCE, while the DCR defines how logs are inserted into the target table. The table schema does not need to match the JSON log structure, as the DCR can transform the data. A sample log is available here.

If you are unsure which log fields to use, the following example shows a basic DCR transformation:

source
| extend event_type = log.event_type
| extend TimeGenerated = todatetime(timestamp)
| project-away ['date']

Configure the following fields to configure Azure Monitor forwarding:

  • Application ID. Enter the application ID from your Azure app registration. Example: 9528e71d-b05b-4608-aa6d-fb726b24121e

  • Client Secret. Enter the client secret generated in the Azure app registration portal. Example: GkG8Q~qWer3Yd6D04HCur-ZjNDyRyJoyPlIAtaB1

  • Token Request URL. The OAuth token endpoint URL, including the tenant ID. Example: https://login.microsoftonline.com/$tenantId/oauth2/v2.0/token. Where $tenantId should be replaced with the tenant id for your app registration.

  • Endpoint URL. The DCE Endpoint URI for Azure Monitor used for log ingestion. See Logs Ingestion API in Azure Monitor.

Format:

$DceURI/dataCollectionRules/$DcrImmutableId/streams/Custom-$Table"+"?api-version=2023-01-01.

  • Replace $DceURI with the Data Collection Endpoint URI.

  • Replace $DcrImmutableId with the DCR immutable ID.

  • Replace $Table with the table name.

Try newer API versions if you experience issues. See Logs Ingestion API in Azure Monitor and Tutorial: Send data to Azure Monitor Logs by using the Logs ingestion API (Azure portal) for more information.

  • Scope. The bearer token permissions requested by the LogForwarder. The default value is sufficient for most use cases unless you use GovCloud.

Example: https://monitor.azure.com//.default

Coralogix

Forward logs to a Coralogix HTTPS endpoint. Complete the following fields to configure Coralogix forwarding:

  • URL. Enter the Coralogix HTTPS URL.

  • Private Key. Enter the Coralogix Private Key.

  • UUID. Enter the UUID.

  • Application Name. Enter the application name.

  • Subsystem. Enter the subsystem name.

Datadog

Forward logs to a Datadog HTTPS source. Complete the following fields to configure Datadog forwarding:

  • Site. Enter the Datadog site.

  • API Key. Enter the Datadog API key.

  • Source. Identifies the log source for Datadog processing.

  • Tags. Enter comma-separated values applied as log tags.

Elasticsearch/OpenSearch

Use an Elasticsearch instance as the log destination. Complete the following fields to configure Elasticsearch forwarding:

  • URL. Enter the Elasticsearch instance URL.

  • Version. Select the API version that matches the Elasticsearch version.

  • Log Retention. Configure how long audit logs are retained.

    • Retention Period. Enter the number of days audit logs are kept in the database.

  • Access Method. Select the AWS API access method. If you use an instance IAM role, ensure that a valid access policy is configured.

    • Access Key ID. Enter the AWS Access Key ID.

    • Secret Access Key. Enter the AWS Secret Access Key.

    • Region. Enter the AWS region code for the location of the Elasticsearch cluster.

NOTE

The API key service is required when using Elastic Cloud Serverless.

NOTE

For Basic Authentication, the Secret should be the base64-encoded as USERNAME:PASSWORD. For API Key Service, the Secret must be base64-encoded as API key ID:API key.

Falcon LogScale

Forward logs to a Falcon LogScale instance. See Falcon LogScale Documentation for more information. Compete the following fields to configure Falcon LogScale forwarding:

  • Event Collector URL. The HTTP Event Collector (HEC) URL.

  • Token. Paste the ingest token.

  • Index. Optional.The ingest repository name. In public-facing API's this must be the same as in the ingest token.

  • Source Type. Optional. Mapped to #type in LogScale.

  • Source. Optional. Mapped to the @source field in LogScale.

Kafka

Forward logs to Kafka brokers. Complete the following fields to configure Kafka forwarding:

  • Bootstrap Servers. Enter a comma-separated list of Kafka bootstrap servers.

  • Authentication. Select to use SASL/SCRAM authentication with the Kafka broker.

    • Username. Enter the username for the Kafka broker.

    • Password. Enter the password for the Kafka broker.

  • Use TLS. Select to use TLS.

  • Topic. Enter the name of the Kafka topic for the logs.

  • Compression. Select the compression algorithm to use when sending logs.

Splunk

Forward logs in RAW format to a Splunk HTTP Event Collector (HEC). Complete the following fields to configure Splunk forwarding:

  • Token. The Splunk HEC authentication token.

  • URL. Enter the Splunk HEC URL. Use HTTPS if enabled.

Sumo Logic

Forward logs to a Sumo Logic HTTPS source. Complete the following fields to configure Sumo Logic forwarding:

  • URL. Enter the HTTPS source URL copied from Sumo Logic.

TCP

Use TCP to forward logs to an external destination. Complete the following fields to configure TCP forwarding:

  • Name. Enter a name for the TCP client.

  • Hostname or IP Address. The external log server hostname or IP address.

  • Port. The destination port.

  • Format. Select the log format.

  • Encryption Method. Select TLS to send logs securely.

NOTE

TLS forwarding requires the appropriate certificate to be uploaded in System > Trusted Certificates.

  • Filter. Optional. Filter log records using a boolean expression written in JMESPath. See LogForward filtering for details.

After completing the LogForwarder configuration, continue to the Miscellaneous tab.