e1bbcfcfda
* Generate audit logs for activities * Fix config tests * Fix TestGetConfig/IncludeServerConfig * Fix use of AddAttributes in results only * Stream activities asynchronously * Fix index and add logging * Revert change * Documentation fixes
8.6 KiB
Log destinations
This document provides a list of the supported log destinations in Fleet.
Log destinations can be used in Fleet to log:
- Osquery status logs.
- Osquery schedule query result logs.
- Fleet audit logs.
To configure each log destination, you must set the correct logging configuration options in Fleet. Check out the reference documentation for:
- Osquery status logging configuration options.
- Osquery result logging configuration options.
- Activity audit logging configuration options.
Amazon Kinesis Data Firehose
Logs are written to Amazon Kinesis Data Firehose (Firehose).
- Plugin name:
firehose - Flag namespace: firehose
This is a very good method for aggregating osquery logs into Amazon S3.
Note that Firehose logging has limits discussed in the documentation. When Fleet encounters logs that are too big for Firehose, notifications will be output in the Fleet logs and those logs will not be sent to Firehose.
Snowflake
To send logs to Snowflake, you must first configure Fleet to send logs to Amazon Kinesis Data Firehose (Firehose). This is because you'll use the Snowflake Snowpipe integration to direct logs to Snowflake.
If you're using Fleet's terraform reference architecture, Firehose is already configured as your log destination.
With Fleet configured to send logs to Firehose, you then want to load the data from Firehose into a Snowflake database. AWS provides instructions on how to direct logs to a Snowflake database here in the AWS documentation
Snowflake provides instructions on setting up the destination tables and IAM roles required in AWS here in the Snowflake docs.
Splunk
To send logs to Splunk, you must first configure Fleet to send logs to Amazon Kinesis Data Firehose (Firehose). This is because you'll enable Firehose to forward logs directly to Splunk.
With Fleet configured to send logs to Firehose, you then want to load the data from Firehose into Splunk. AWS provides instructions on how to enable Firehose to forward directly to Splunk here in the AWS documentation.
If you're using Fleet's terraform reference architecture, you want to replace the S3 destination with a Splunk destination. Hashicorp provides instructions on how to send Firehose data to Splunk here in the Terraform documentation.
Splunk provides instructions on how to prepare the Splunk platform for Firehose data here in the Splunk documentation.
Amazon Kinesis Data Streams
Logs are written to Amazon Kinesis Data Streams (Kinesis).
- Plugin name:
kinesis - Flag namespace: kinesis
Note that Kinesis logging has limits discussed in the documentation. When Fleet encounters logs that are too big for Kinesis, notifications appear in the Fleet server logs. Those logs will not be sent to Kinesis.
AWS Lambda
Logs are written to AWS Lambda (Lambda).
- Plugin name:
lambda - Flag namespace: lambda
Lambda processes logs from Fleet synchronously, so the Lambda function used must not take enough processing time that the osquery client times out while writing logs. If there is heavy processing to be done, use Lambda to store the logs in another datastore/queue before performing the long-running process.
Note that Lambda logging has limits discussed in the documentation. The maximum size of a log sent to Lambda is 6MB. When Fleet encounters logs that are too big for Lambda, notifications will be output in the Fleet logs and those logs will not be sent to Lambda.
Lambda is executed once per log line. As a result, queries with differential result logging might result in a higher number of Lambda invocations.
Queries are assigned
differentialresult logging by default in Fleet.differentiallogs have two format options, single (event) and batched. Check out the osquery documentation for more information ondifferentiallogs.
Keep this in mind when using Lambda, as you're charged based on the number of requests for your functions and the duration, the time it takes for your code to execute.
Google Cloud Pub/Sub
Logs are written to Google Cloud Pub/Sub (Pub/Sub).
- Plugin name:
pubsub - Flag namespace: pubsub
Messages over 10MB will be dropped, with a notification sent to the Fleet logs, as these can never be processed by Pub/Sub.
Apache Kafka
Logs are written to Apache Kafka (Kafka) using the Kafka REST proxy.
- Plugin name:
kafkarest - Flag namespace: kafka
Note that the REST proxy must be in place in order to send osquery logs to Kafka topics.
Stdout
Logs are written to stdout.
- Plugin name:
stdout - Flag namespace: stdout
With the stdout plugin, logs are written to stdout on the Fleet server. This is typically used for debugging or with a log forwarding setup that will capture and forward stdout logs into a logging pipeline.
Note that if multiple load-balanced Fleet servers are used, the logs will be load-balanced across those servers (not duplicated).
Filesystem
Logs are written to the local Fleet server filesystem.
The default log destination.
- Plugin name:
filesystem - Flag namespace: filesystem
With the filesystem plugin, logs are written to the local filesystem on the Fleet server. This is typically used with a log forwarding agent on the Fleet server that will push the logs into a logging pipeline.
Note that if multiple load-balanced Fleet servers are used, the logs will be load-balanced across those servers (not duplicated).
Sending logs outside of Fleet
Osquery agents are typically configured to send logs to the Fleet server (--logger_plugin=tls). This is not a requirement, and any other logger plugin can be used even when osquery clients are connecting to the Fleet server to retrieve configuration or run live queries.
See the osquery logging documentation for more about configuring logging on the agent.
If --logger_plugin=tls is used with osquery clients, the following configuration can be applied on the Fleet server for handling the incoming logs.