Skip to content

Latest commit

 

History

History
 
 

loggroup-lambda-connector

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
sam
sam
 
 
src
src
 
 
test
test
 
 
LICENSE
LICENSE
 
 
Readme.md
Readme.md
 
 
package.json
package.json
 
 

Readme.md

SumoLogic LogGroup Connector

This is used to automatically subscribe newly created and existing Cloudwatch LogGroups to a Lambda function.

Made with ❤️ by Sumo Logic. Available on the AWS Serverless Application Repository

Deploying the SAM Application

1. Open a browser window and enter the following URL: https://serverlessrepo.aws.amazon.com/applications
2. In the Serverless Application Repository, search for sumologic.
3. Select Show apps that create custom IAM roles or resource policies check box.
4. Click the sumologic-loggroup-connector,link, and then click Deploy.
5. In the Configure application parameters panel,
    DestinationArnType: Lambda - When the destination ARN for subscription filter is an AWS Lambda Function.
                     Kinesis - When the destination ARN for subscription filter is an Kinesis or Amazon Kinesis data firehose stream.
    DestinationArnValue: "Enter Destination ARN like Lambda function, Kinesis stream. For more information, visit - https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/SubscriptionFilters.html
    LogGroupPattern: "Enter regex for matching logGroups"
    UseExistingLogs: "Select true for subscribing existing logs"
    LogGroupTags: "Enter comma separated keyvalue pairs for filtering logGroups using tags. Ex KeyName1=string,KeyName2=string. Supported only when UseExistingLogs is set to false.
    RoleArn: Enter AWS IAM Role arn in case the destination is Kinesis Firehose stream."
6. Click Deploy.

Configuring Lambda

It has two environment variables

LOG_GROUP_PATTERN: This is a javascript regex to filter out loggroups. Only loggroups which match this pattern will be subscribed to the lambda function.Do not use '/' while writing the pattern and it is case insensitive.

    Test - will match testlogroup, logtestgroup and LogGroupTest

DESTINATION_ARN: This specifies ARN of the Destination to Subscribe the log group.

Lambda Destination ARN :- This specifies ARN of the Lambda function. Also you have to specify FunctionName attribute in your lambda function so that AWS does not generate random function name. This is to avoid making changes to the lambda function configuration in case your lambda function gets created again.

    {
        "Fn::Join": [
            "",
            [
              "arn:aws:lambda:",
              { "Ref" : "AWS::Region" },
              ":",
              { "Ref" : "AWS::AccountId" },
              ":function:<Your Lambda Function Name>"
            ]
        ]
    }

Kinesis Destination ARN :- This specifies the ARN of the kinesis Stream.

LOG_GROUP_TAGS: This is used for filtering out loggroups based on tags.Only loggroups which match any one of the key value pairs will be subscribed to the lambda function. This works only for new loggroups not existing loggroups.

ROLE_ARN : This is used when subscription destination ARN is kinesis firehose stream.

For Developers

Installing Dependencies. Test cases requires SAM CLI, BOTO3, CFN FLIP and Requests python packages.

Running the test cases

  python test_loggroup_lambda_connector.py

License

Apache License 2.0 (Apache-2.0)

Support

Requests & issues should be filed on GitHub: https://github.com/SumoLogic/sumologic-aws-lambda/issues