Amazon FSx (Preview)

Amazon FSx for Windows File Server provides a fully managed native Microsoft Windows file system to enable sysadmins to efficiently move Windows-based applications that require file storage to AWS. This package allows you to ingest FSx logs in XML format directly from your S3 bucket into a LogScale repository to improve process security and safely store logs for auditing.

The parser normalizes data to a common schema based on an OpenTelemetry standard. This schema allows you to search the data without knowing the data specifically, and just knowing the common schema instead. It also allows you to combine the data more easily with other data sources which conform to the same schema.

Preview Status

Note that this package is considered a PREVIEW. This means we are seeking feedback on the package, and may make breaking changes to the parser in the future. It means also it may not include all documentation which usually we publish for packages.

Given the preview status of this package there are some limitations to what the parser is able to do. Please check out the package on Marketplace to see the most recent list of limitations.

Installing the Package in LogScale

Find the repository where you want to send the Amazon FSx (Preview) events, or Creating a Repository or View.

  1. Navigate to your repository in the LogScale interface, click Settings and then Packages on the left.

  2. Click Marketplace and install the LogScale package for Amazon FSx (Preview) (i.e. amazon/fsx).

Configurations and Sending the Logs to LogScale

  1. To get logs from Amazon FSx into LogScale, configure Kinesis Data Firehose to stream audit events to an S3 bucket.

  2. Then you need to configure LogScale to collect data from AWS S3 buckets using the fsx-xml See the documentation for cloud: Ingesting Data from AWS S3 and self-hosted Ingesting Data from AWS S3 deployments to send logs directly from S3 bucket into LogScale repository.

Verify Data is Arriving in LogScale

Once you have completed the above steps the Amazon FSx (Preview) data should be arriving in your LogScale repository.

You can verify this by doing a simple search for the events:

logscale
#Vendor = "amazon" 
| Product="fsx"

Package Contents Explained

This package parses incoming data, and normalizing the data as part of that parsing. The parser normalizes the data to a subset of this schema based on OpenTelemetry standards, while still preserving the original data.

If you want to search using the original field names and values, you can access those in the fields whose names are prefixed with the word Vendor. Fields which are not prefixed with Vendor are standard fields which are either based on the schema (e.g. source.ip) or on LogScale conventions (e.g. @rawstring).

The fields which the parser currently maps the data to, are chosen based on what seems the most relevant, and will potentially be expanded in the future. But the parser won't necessarily normalize every field that has potential to be normalized.

Event Categorisation

As part of the schema, events are categorized by fields:

  • event.kind

  • event.category

  • event.type

event.category is an array so needs to be searched using the following syntax:

logscale
array:contains("event.category[]", value="file")

For example, the following will find events where some event.type[n] field contains the value network, regardless of what n is.

Note that not all events will be categorized to this level of detail.

Normalized Fields

Here are some of the normalized fields which are being set by this parser:

  • event.* (e.g. event.type, event.kind, event.id, event.category, event.action )

  • user.* (e.g. user.ip, user.id, user.domain )

  • related.* (e.g. realted.ip, related.user )

  • process.* (e.g. process.pid, process.thread.id )

  • client.* (e.g. client.ip )

  • file.* (e.g. file.type, file.path, file.name, file.extension )