ACloudGuru/serverless-plugin-aws-alerts

Purpose of normalizing dashes to "dash" in name?

Open

#144 opened on Nov 5, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (150 forks)auto 404
good first issuequestion

Repository metrics

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

Description

This is a (Bug Report / Feature Proposal)

This is more of a question, and not sure if this is intended.

Description

My api name has dashes in it, however because it's named "api-name-v1-this-is-the-function-name", the package updates the name for the cloudwatch alert to replace it as apiDashnameDashv1DashthisDashisDashtheDashfunctionDashname

Is there a way to disable this, or what is the intended reasoning to replace this as we can use dashes in the title as the prefixTemplate option can contain dashes just fine. e.g. prefix-template-dashes-worksapiDashnameDashv1DashthisDashisDashtheDashfunctionDashname assuming prefixTemplate: prefix-template-dashes-work and apiName:api-name-v1-this-is-the-function-name

  • Serverless Framework Version: "serverless": "^1.83.0",

Contributor guide

Research direction
Investigate the plugin's internal function that normalizes dashes in function names to 'Dash' for CloudWatch alarm names. Check if there is a configuration option to disable this normalization, or propose adding one. Look into the `naming.js` or similar file in the plugin source.
Tech stack
javascriptnodejsaws
Domain
clouddevopsbackend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Mostly clear
Prerequisites
Serverless FrameworkAWS CloudWatch
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60