Skip to content

Commit

Permalink
Updating changelog and package.json for 3.0.0 release. Adding documen…
Browse files Browse the repository at this point in the history
…tation for the formatS3Access handler.
  • Loading branch information
arithmetric committed Aug 6, 2019
1 parent f8fb227 commit e8a9353
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 4 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Change Log for lambda-stash

## 3.0.0 [2019/08/06]

- Adding support for the S3 access log format.
- Dropping support for Node.js v4.

## 2.0.0 [2018/05/23]

- Adding support for ELB Classic Load Balancer (elbv1) and Application Load
Expand Down
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ data sources to data stores, like Elasticsearch.

- Supported input formats: AWS Cloudfront access logs, AWS Cloudtrail API logs,
AWS CloudWatch logs, AWS Config change logs, AWS Elastic Load Balancer access
logs, and other formats by implementing a custom handler.
logs, AWS S3 access logs, and other formats by implementing a custom handler.

- Supported output formats: JSON, plain text key-value pairs.

Expand All @@ -25,7 +25,7 @@ with your configuration. See the example included (under `example/`) and the
configuration documentation below to get started.

2. Use the AWS Management Console to create a Lambda function using the Node.js
6.10 runtime. Upload your package, configure it with event sources as desired
10.x runtime. Upload your package, configure it with event sources as desired
(S3 buckets or CloudWatch logs). Be sure the Lambda function has an IAM role
with any necessary permissions, like getting data from an S3 bucket or accessing
an AWS Elasticsearch domain.
Expand Down Expand Up @@ -209,6 +209,26 @@ contain the log's date time value.

- `config.data` is transformed to an array of objects with log data.

### formatS3Access

Processes parsed data from AWS Simple Storage Service (S3) access logs and
normalizes it in key-value objects.

Raw S3 log files should be processed with `parseSpaces` before using this
format handler.

**Inputs**:

- `config.data` should be an array (one item per log record) of arrays (one item
per record field).

- `config.dateField` (optional) is the key name in the output that should
contain the log's date time value.

**Outputs**:

- `config.data` is transformed to an array of objects with log data.

### getS3Object

Fetches an object from S3.
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "lambda-stash",
"version": "2.0.0",
"version": "3.0.0",
"description": "AWS Lambda script for shipping data from S3 or other cloud data sources to data stores, like Elasticsearch",
"main": "index.js",
"dependencies": {
Expand All @@ -19,7 +19,7 @@
"nyc": "^14.1.1"
},
"engines": {
"node": ">=4.0"
"node": ">=6.0"
},
"scripts": {
"check-coverage": "nyc --check-coverage --statements=100 --reporter=lcov --reporter=text-summary npm run test",
Expand Down

0 comments on commit e8a9353

Please sign in to comment.