There are several ways to set up Desole services in your AWS account, depending on how much you want to customise the bundled applications. For most people, deploying the main application bundle using the AWS Serverless App Repo should be sufficient. You may also want to deploy additional publishers, for ElasticSearch or AWS Pinpoint support.

Deploying the main application bundle

The main application bundle contains the Collector API and the publishers for S3 and Cloudwatch Alarms. You can easily install it using the Desole App on the AWS Serverless App repo.

Option #1: Deploy using the AWS Serverless App Repo

Click the button below to deploy the standard bundle using the Desole App, then follow the wizard to configure the app settings, such as data retention and encryption.

Deploy

When the deployment is complete, check the CloudFormation template outputs to see your Desole Collector API URL. You will need that to configure the client-side collector.

Option #2: Deploy the standard app bundle using CloudFormation

You can also deploy the standard app bundle directly using CloudFormation. We prepared templates for four common regions:

Region Launch
US East (N.Virginia) Launch
EU Central (Frankfurt) Launch
US West (N. California) Launch
Asia Pacific (Sydney) Launch

When the deployment is complete, check the CloudFormation template outputs to see your Desole Collector API URL. You will need that to configure the client-side collector.

Option #3: Deploy a custom CloudFormation bundle

To deploy to a different region, follow the instructions for deploying a custom CloudFormation bundle.

Additional publishers

Additional Desole publishers allow you to send events to services that have additional start-up costs or require additional setup beyond what CloudFormation supports currently.

ElasticSearch publisher

This publisher submits Desole events to AWS ElasticSearch, where you can query and search them easily.

The standard CloudFormation template deploys a new AWS ElasticSearch domain on a t2.micro instance with a 10GB EBS volume capacity, to keep costs low. This is good for small sites and for demonstration purposes, but it may be inadequate for high-traffic event collection. Check out the custom ElasticSearch publisher CloudFormation bundle for information on how to customise the template for better performance and higher capacity.

Region Launch
US East (N.Virginia) Launch
EU Central (Frankfurt) Launch
US West (N. California) Launch
Asia Pacific (Sydney) Launch

To deploy to a different region, or increase the capacity, follow the instructions for deploying a custom ElasticSearch publisher CloudFormation template.

AWS Pinpoint publisher

This publisher submits Desole events to AWS Pinpoint, where you can use Pinpoint analytics dashboards (formerly AWS Mobile Analytics) to drill down into various dimensions of the events, and create automated customer engagement campaigns based on Desole events – for example, send everyone who received a particular error an e-mail.

To use this publisher, you’ll need a Pinpoint (AWS Mobile Hub) Application ID. Create an app using the AWS Pinpoint Console or using aws pinpoint create-app from your command line. For example:

aws pinpoint create-app --create-application-request '{"Name":"desole"}' --query ApplicationResponse.Id --output text

Enter the application ID into the CloudFormation template configuration when deploying using one of the options below:

Region Launch
US East (N.Virginia) Launch
EU Central (Frankfurt) Launch
US West (N. California) Launch
Asia Pacific (Sydney) Launch

To deploy to a different region, or increase the capacity, follow the instructions for deploying a custom Pinpoint publisher CloudFormation template.