Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/amplify-education/serverless-log-forwarding

Serverless plugin for forwarding CloudWatch logs to another Lambda function.
https://github.com/amplify-education/serverless-log-forwarding

cloudwatch forwarding lambda log logging serverless serverless-plugin

Last synced: 6 days ago
JSON representation

Serverless plugin for forwarding CloudWatch logs to another Lambda function.

Host: GitHub
URL: https://github.com/amplify-education/serverless-log-forwarding
Owner: amplify-education
License: mit
Created: 2017-07-11T17:11:46.000Z (over 7 years ago)
Default Branch: main
Last Pushed: 2024-11-27T11:33:39.000Z (about 2 months ago)
Last Synced: 2025-01-09T02:33:03.188Z (13 days ago)
Topics: cloudwatch, forwarding, lambda, log, logging, serverless, serverless-plugin
Language: TypeScript
Size: 509 KB
Stars: 57
Watchers: 24
Forks: 26
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# serverless-log-forwarding

[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/amplify-education/serverless-domain-manager/master/LICENSE)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/bb1e50c048434012bd57eb73225a089e)](https://www.codacy.com/app/CFER/serverless-log-forwarding?utm_source=github.com&utm_medium=referral&utm_content=amplify-education/serverless-log-forwarding&utm_campaign=badger)
[![Build Status](https://travis-ci.org/amplify-education/serverless-log-forwarding.svg?branch=master)](https://travis-ci.org/amplify-education/serverless-log-forwarding)
[![npm version](https://badge.fury.io/js/serverless-log-forwarding.svg)](https://badge.fury.io/js/serverless-log-forwarding)
[![npm downloads](https://img.shields.io/npm/dt/serverless-log-forwarding.svg?style=flat)](https://www.npmjs.com/package/serverless-log-forwarding)

Serverless plugin for forwarding CloudWatch logs to another Lambda function.

# About Amplify

Amplify builds innovative and compelling digital educational products that empower teachers and students across the country. We have a long history as the leading innovator in K-12 education - and have been described as the best tech company in education and the best education company in tech. While others try to shrink the learning experience into the technology, we use technology to expand what is possible in real classrooms with real students and teachers.

# Getting Started

## Prerequisites

Make sure you have the following installed before starting:
* [nodejs](https://nodejs.org/en/download/)
* [npm](https://www.npmjs.com/get-npm)
* [serverless](https://serverless.com/framework/docs/providers/aws/guide/installation/)

## Installing

To install the plugin, run:

```shell
npm install serverless-log-forwarding
```

Then make the following edits to your `serverless.yaml` file:

```yaml
plugins:
- serverless-log-forwarding

custom:
logForwarding:
destinationARN: '[ARN of Lambda Function to forward logs to]'
# optional:
roleArn: '[ARN of the IAM role that grants Cloudwatch Logs permissions]'
filterPattern: '[filter pattern for logs that are sent to Lambda function]'
normalizedFilterID: true # whether to use normalized function name as filter ID
stages:
- '[name of the stage to apply log forwarding]'
- '[another stage name to filter]'
createLambdaPermission: true # whether to create the AWS::Lambda::Permission for the destinationARN (when policy size limits are a concern)

functions:
myFunction:
handler: src/someHandler
# optional properties for per-function configuration:
logForwarding:
# set enabled to false to disable log forwarding for a single given function
enabled: false

```

## Running Tests
To run unit tests:
```
npm run test
```

For running integration tests you will need to log into you AWS account
and set AWS_PROFILE environment variable,
it will be used to create AWS entities for testing purposes
```
export AWS_PROFILE=
export SERVERLESS_LICENSE_KEY=
npx npm run build
npx npm run integration-test
```

All tests should pass. All unit tests should pass before merging.
Integration tests will probably take some time

If there is an error update the node_modules inside the root folder of the directory:
```
npm install
```

## Writing Integration Tests
Unit tests are found in `test/unit-tests`.
Integration tests are found in `test/integration-tests`.

`test/integration-tests` contains configs folder,
for every test there is a folder with `serverless.yml` configuration and `logs_producer.py`.

To add another test create a folder for your test with the folder name that corresponds to test name
and add code to run test to `test/integration-tests/integration-tests.ts`

## Deploying

---------
The plugin will be packaged with the lambda when deployed as normal using Serverless:

```shell
serverless deploy
```

# Responsible Disclosure

If you have any security issue to report, contact project maintainers privately.
You can reach us at

# Contributing

We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you:
1. For any sizable change, first open a GitHub issue to discuss your idea.
2. Create a pull request. Explain why you want to make the change and what it’s for.
We’ll try to answer any PRs promptly.