cdklabs/cdk-monitoring-constructs

[aws-pinpoint] Add monitoring class and factory for AWS Pinpoint

Open

#199 opened on Jul 20, 2022

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)TypeScript (86 forks)auto 404
effort: mediumfeature-requestgood first issue

Repository metrics

Stars
 (552 stars)
PR merge metrics
 (PR metrics pending)

Description

Feature scope

pinpoint

Describe your suggested feature

AWS Pinpoint is a managed marketing service https://aws.amazon.com/pinpoint/ commonly used for things like email and push notifications.

Pinpoint has the list of metrics which they publish here: https://docs.aws.amazon.com/pinpoint/latest/userguide/monitoring-metrics.html

Proposal:

  • Create a sub package aws-pinpoint with files PinpointMonitoring.ts and PinpointMetricFactory.ts -- following a similar pattern to existing 1P services
    • Input would be pinpoint applicationId
  • Add widgets for some of the metrics in the documentation above my recommendation for initial scope
    • "Metrics related to message delivery"
      • Metrics should be dimensioned by channel from Pinpoint (e.g., PUSH, EMAIL)
    • "Metrics related to endpoints"
    • "Metrics related to events"

Contributor guide

Research direction
Look at existing monitoring implementations (e.g., aws sns, aws sqs) in the repository to understand the pattern. Then create the PinpointMonitoring and PinpointMetricFactory classes following that pattern. Refer to AWS Pinpoint monitoring documentation for metrics and dimensions.
Tech stack
typescriptaws
Domain
backendcloud
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
AWS CDKTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50