Skip to main content

AWS Observability Automatic Installation Script

Sumo Logic provides POSIX and powershell scripts to trigger the Cloud Formation 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, please fall back to Terraform or CloudFormation installation steps.

Prerequisite

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

Input Parameters

The script takes two inputs:

  1. SUMO ACCESS ID - Provide the Sumo Access Id from your respective Sumo Logic Account where you want to install AWS Observability Solution. See Create an access key in the Access Keys topic for more information.
  2. SUMO ACCESS KEY - Provide the Sumo Access Key from your respective Sumo Logic Account where you want to install AWS Observability Solution. See Create an access key in the Access Keys topic 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.

Cloud Formation Parameters

The script above will take only two inputs - Sumo access Id and Sumo Access Key. And internally it will trigger a cloud formation template. This cloud formation 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 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

.\DeployAWSOWin.ps1 <SUMO_ACCESS_ID> <SUMO_ACCESS_KEY>

Posix Script Command Execution

Below is an example to run posix script with required parameters

sh DeployAWSOPosix.sh <SUMO_ACCESS_ID> <SUMO_ACCESS_KEY>

Appendix I

ParameterDefault Value
Sumo Logic Deployment NameThis will be evaluated when the script is executed
Sumo Logic Access IDWill be given by the User
Sumo Logic Access KeyWill be given by the user
Sumo Logic Organization IDThis will be evaluated when the script is executed.
Delete Sumo Logic Resources when stack is deletedTrue
Alias for your AWS accountThis will be the respective AWS Account Id
S3 URL of a CSV file that maps AWS Account IDs to an Account Aliasempty
Install AWS Observability apps and alertsYes
Select the kind of Metrics Source to createKinesis Firehose Metrics Source
Sumo Logic AWS Metrics NamespacesAWS/ApplicationELB, AWS/ApiGateway, AWS/DynamoDB, AWS/Lambda, AWS/RDS, AWS/ECS, AWS/ElastiCache, AWS/ELB, AWS/NetworkELB, AWS/SQS, AWS/SNS.
Existing Sumo Logic Metrics Source API URLempty
Enable ALB Access loggingBoth
Create Sumo Logic ALB Logs SourceYes
Existing Sumo Logic ALB Logs Source API URLempty
AWS S3 Bucket Nameempty
Path Expression for the Existing ALB logs*AWSLogs/*/elasticloadbalancing/*
Create Sumo Logic CloudTrail Logs SourceYes
Existing Sumo Logic CloudTrail Logs Source API URLempty
AWS S3 Bucket Nameempty
Path Expression to the Existing CloudTrail logsAWSLogs/*/CloudTrail/*
Select the Sumo Logic CloudWatch Logs SourcesKinesis Firehose Log Source
Existing Sumo Logic Lambda CloudWatch Logs Source API URLempty
Subscribe log groups to Sumo Logic Lambda ForwarderBoth
Regex for AWS Lambda Log Groupslambda
Select the Sumo Logic Root Cause Explorer SourceBoth
Enable ELB Classic Access loggingBoth
Create Sumo Logic ELB Logs SourceYes
Existing Sumo Logic ELB Classic Logs Source API URLempty
AWS S3 Bucket Nameempty
Path Expression for the Existing ELB Classic logsclassicloadbalancing/AWSLogs/*/elasticloadbalancing/*
Location where you want the App to be InstalledPersonal Folder
Do you want to share App with whole organizationTrue
Sumo Logic YouTubeSumo Logic Twitter
Legal
Privacy Statement
Terms of Use

Copyright © 2022 by Sumo Logic, Inc.