AWS Observability Automatic Installation Script

Sumo Logic provides POSIX and PowerShell scripts to trigger the CloudFormation template for creating a stack to deploy AWS Observability Solution.

This is a simplified method of deploying AWS Observability using default parameters with just one quick command. Use it for a quick start or when you are happy with the defaults (see table below). For more advanced use cases, when any of the default needs to be adjusted, fall back to Terraform or CloudFormation installation steps.

Multi-account and region

If you need to add support for multiple AWS accounts or multiple regions, refer to the Sumo Logic documentation for CloudFormation or Terraform.

Prerequisites

AWS CLI should be pre-installed on the system where the script is supposed to be executed.

Set up the AWS CLI.
Configure AWS CLI to use AWS profiles.
Select/change the enabled AWS region where you want to deploy the solution. For example, if you wanted to change your default AWS region to us-west-1:
```
aws configure set region us-west-1
```

Input parameters

The script takes two inputs:

Sumo Logic Access ID - Provide the Sumo Logic Access ID from your respective Sumo Logic Account where you want to install AWS Observability Solution. See Access Keys for more information.
Sumo Logic Access key - Provide the Sumo Logic Access Key from your respective Sumo Logic Account where you want to install AWS Observability Solution. See Access Keys for more information.

AWS_PROFILE can be set as an environment variable from the command line before executing the script. If it is not set, the “default” aws profile will be used.

CloudFormation parameters

The script above will take only two inputs, the Sumo Logic access ID and Access Key. And internally it will trigger a CloudFormation template. This CloudFormation template requires some additional parameters. But all of these parameters will take the default value. When using this script one cannot override these values. Refer to the table in Appendix I for all the parameters and the respective default values which will be used as part of this installation. Learn details about each parameter in detail here.

PowerShell script command execution

Below is an example to run the PowerShell script with the required parameters.

$uri="https://github.com/SumoLogic/sumologic-solution-templates/tree/master-v3x/cloudformation-sumologic-aws-observability/scripts/AWSOAutoSetupScript/DeployAWSOWin.ps1";$path=".\DeployAWSOWin.ps1";(New-Object System.Net.WebClient).DownloadFile($uri, $path);
.\DeployAWSOWin.ps1 <SUMO_ACCESS_ID> <SUMO_ACCESS_KEY>

Posix script command execution

Below is an example to run posix script with required parameters.

wget "https://raw.githubusercontent.com/SumoLogic/sumologic-solution-templates/master-v3x/cloudformation-sumologic-aws-observability/scripts/AWSOAutoSetupScript/DeployAWSOPosix.sh"

chmod +x DeployAWSOPosix.sh

./DeployAWSOPosix.sh <SUMO_ACCESS_ID> <SUMO_ACCESS_KEY>

Appendix I

Section 1: Sumo Logic Access Configuration

Parameter	Default Value
Sumo Logic Deployment	Evaluated when the script is executed
Sumo Logic Access ID	Provided by the user
Sumo Logic Access Key	Provided by the user
Sumo Logic Organization ID	Evaluated when the script is executed
Delete Sumo Logic Resources when stack is deleted	true
Send telemetry to Sumo Logic	true

Section 2: AWS Account Configuration

Parameter	Default Value
AWS Account Alias	Respective AWS Account ID
S3 URL of a CSV file that maps AWS Account IDs to an Account Alias	empty

Section 3: Sumo Logic AWS Observability Apps

Parameter	Default Value
Install AWS Observability Apps and Alerts	Yes

Section 4: Sumo Logic AWS CloudWatch Metrics Sources

Parameter	Default Value
Select the kind of Metrics Source to create	Kinesis Firehose Metrics Source
Sumo Logic AWS Metrics Namespaces	AWS/ApplicationELB, AWS/ApiGateway, AWS/DynamoDB, AWS/Lambda, AWS/RDS, AWS/ECS, AWS/ElastiCache, AWS/ELB, AWS/NetworkELB, AWS/SQS, AWS/SNS, AWS/EC2, ECS/ContainerInsights
Existing Sumo Logic Metrics Source API URL	empty
Sumo Logic AWS Metrics Tag Filters

Section 5: Sumo Logic AWS ALB Log Source

Parameter	Default Value
Enable ALB Access logging	Both
Create Sumo Logic ALB Logs Source	Yes
Existing Sumo Logic ALB Logs Source API URL	empty
AWS S3 Bucket Name	empty
Path Expression for existing ALB logs	`AWSLogs//elasticloadbalancing/*`

Section 6: Sumo Logic AWS CloudTrail Log Source

Parameter	Default Value
Create Sumo Logic CloudTrail Logs Source	Yes
Existing Sumo Logic CloudTrail Logs Source API URL	empty
AWS S3 Bucket Name	empty
Path Expression for existing CloudTrail logs	`AWSLogs//CloudTrail/`

Section 7: Sumo Logic AWS CloudWatch Log Source

Parameter	Default Value
Select the Sumo Logic CloudWatch Logs Sources	Kinesis Firehose Log Source
Existing Sumo Logic CloudWatch Logs Source API URL	empty
Auto Subscribe Log Groups	Both
Auto Subscribe Log Group Pattern	`\/aws\/(lambda\|apigateway\|rds)`
Auto Subscribe Log Group By Tags	empty

Section 8: Sumo Logic AWS ELB Classic Log Source

Parameter	Default Value
Enable ELB Classic Access logging	Both
Create Sumo Logic ELB Logs Source	Yes
Existing Sumo Logic ELB Classic Logs Source API URL	empty
AWS S3 Bucket Name	empty
Path Expression for existing ELB Classic logs	`classicloadbalancing/AWSLogs//elasticloadbalancing/`

Prerequisites​

Input parameters​

CloudFormation parameters​

PowerShell script command execution​

Posix script command execution​

Appendix I​

Section 1: Sumo Logic Access Configuration​

Section 2: AWS Account Configuration​

Section 3: Sumo Logic AWS Observability Apps​

Section 4: Sumo Logic AWS CloudWatch Metrics Sources​

Section 5: Sumo Logic AWS ALB Log Source​

Section 6: Sumo Logic AWS CloudTrail Log Source​

Section 7: Sumo Logic AWS CloudWatch Log Source​

Section 8: Sumo Logic AWS ELB Classic Log Source​