CLI to help automating MCA work
npm linknpm run startnpm run build./dist/bin/mca.jsnpm run lintnpm run lint:fixnpm run testUnit tests should be in the same location as the code with added spec.ts extension. Larger integration tests should be separated to test folder.
Run npm run release to make version bump, add tags and update CHANGELOG automatically.
mca-cli and mca-monitoring are used together to setup monitoring for resources in an AWS environment.
The mca monitoring command searches for resources in an AWS environment. It generates a Node project inside your main project folder and creates a config.yml, which lists all the resources, along with some default alarms.
It is a combination of CloudWatch metrics and CloudWatch alarms.
A metric is a statistic. For example: AWS Lambda has an Invocations metric, which counts the number of times a function is invoked.
An alarm observes a single metric and initiates actions when a specified condition is met. The action could be sending a notification to a SNS topic.
In the root project folder run
npx mca monitoring init -p <aws profile> -r <aws region> -o monitoring
--service -
a space seperated list of service names to include in the search for resources. By default all resources are included:
--include: A list of regex patterns of resource names (or ids) to include in the monitoring By default all resources are included. Resources are identified by:
--exclude: Same as above, but resources are excluded.
--help See all options
In the monitoring folder run npm install
In the monitoring folder run npm run deploy
***it
Read more about CloudWatch concepts
Custom configurations should be listed in config.yml, under custom > default.
cli:
version: 1
services: # mca-cli will search for resources from these services
- lambda
- dynamodb
- apigateway
- cloudfront
- loggroup
includes: [] # Regex patterns (resource names) to include in monitoring. See "Optional flags" in "Setting up default monitoring" section above.
excludes: # Exclude these resources patterns from monitoring.
- '*ee*'
- '*rapsiapp*'
- '*dev*'
- '*marketprice*'
- '*warmup*'
- '*error-handler*'
profile: nc-personal-user # The AWS profile used during searching for resources with mca-cli and when deploying with mca-monitoring.
custom:
default:
lambda: # Config type. See "Config types and metrics" bellow.
Errors: # Metric name
enabled: true # Whether to create an alarm for this metric.
autoresolve: false # Should the alarm automatically enter “OK” state.
alarm:
critical:
comparisonOperator: GREATER_THAN_OR_EQUAL_TO_THRESHOLD # Comparison to use to check if metric is breaching.
threshold: 1 # The value against which the specified statistic is compared.
evaluationPeriods: 1 # The number of periods over which data is compared to the specified threshold.
metric:
period: # The period over which the specified statistic is applied.
minutes: 15
statistic: Minimum # What function to use for aggregating.
cloudfront: # Config type
4XXErrorRate: # Metric name
enabled: false # Monitoring for this metric is disabled.
logGroup:
RuntimeErrors: # Custom metric name
enabled: true
alarm:
critical:
threshold: 1
evaluationPeriods: 1
metric:
period:
minutes: 5
unit: Count
statistic: Sum
filter:
pattern: ERROR -400 -401 -403 -404 -Timeout -DeprecationWarning
snsTopic: # This topic is created by default and is used by all alarms.
critical:
name: Topic for mca monitoring alarms
id: avena-alerts-alarm
endpoints:
- >-
https://events.pagerduty.com/integration/58287e69892c4406aa88db8619721142/enqueue
emails: []
lambdas: # Lambdas to be monitored.
myTestLambda: {}
distributions: # CloudFront distributions to be monitored.
E2K3LH1G46OF18: {}
E3ADB61RBHAPW9: {}
E35IJ0HST9PMZQ: {}
logGroups:
/aws/lambda/avenakauppa-fi-analysis-prod-get-analysis: {}
/aws/lambda/avenakauppa-fi-analysis-prod-post-analysis: {}
This is part of the AWS/DynamoDB namespace
FAQs
CLI application for MCA team
The npm package mca-cli receives a total of 0 weekly downloads. As such, mca-cli popularity was classified as not popular.
We found that mca-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."