Switch branches/tags
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src
tests
README.md
package-lock.json
package.json
template.yaml

README.md

Desole 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

To link existing Pinpoint users to Desole events, just make sure to supply the corresponding device ID in the collector client.

Deploy the Pinpoint Publisher using CloudFormation

Region Launch
US East (N.Virginia) Pinpoint publisher in us-east-1
EU Central (Frankfurt) Pinpoint publisher in eu-central-1
US West (N. California) Pinpoint publisher in us-west-1
Asia Pacific (Sydney) Pinpoint publisher in ap-southeast-2

Deploy a custom bundle

Prerequisites

  • NPM
  • An S3 Bucket for Deployment, in the same region where you would like to deploy Desole
  • AWS CLI (command line tools), configured to use your account

Deployment process

  1. Install the dependencies
npm install
  1. Prepare and pack your code
npm run prepackage
  1. Package the template
aws cloudformation package --template-file template.yaml --output-template-file output.yaml
  1. Deploy the packaged template
aws cloudformation deploy --template-file output.yaml --capabilities CAPABILITY_IAM --stack-name <STACK NAME> --parameter-overrides PinpointApplicationId=<APP ID> CollectorSNSTopic=<SNS TOPIC ARN>

For a detailed list of supported parameters, check out template.yaml