@cumulus/logger
Advanced tools
A logging library for use on the Cumulus project.
The @cumulus/logger library exports a Logger class, which generates
JSON-formated log events.
Log events always have the following keys:
Log events may have the following options keys:
Log events may also contain user-specified keys.
Example log event:
{
"level": "info",
"message": "hello world",
"sender": "greetingFunction",
"timestamp": "2018-10-19T19:12:47.501Z"
}
$ npm install @cumulus/logger
const Logger = require('@cumulus/logger');
const log = new Logger({ sender: 'example' });
log.info('hello, world');
Type: string
The sender of the log event. Typically a Lambda Function Name or ECS Task Name. Defaults to "unknown".
Type: string
An optional description of the executions.
Type: string
An optional version.
Writes a log event to stdout with level set to "debug".
Type: ...any
See console.log().
Writes a log event to stderr with level set to "error".
Type: ...any
See console.log().
Type: Error
If the last argument is an Error then the following additional properties will be set on the log event:
Writes a log event to stdout with level set to "fatal".
Type: ...any
See console.log().
Writes a log event to stdout with level set to "info".
Type: ...any
See console.log().
Writes a log event to stdout with level set to "info". In addition to the standard keys, additional keys will be added to the event. If an additional key is specified with the same name as a standard key, the value standard key will be displayed.
Type: Object
Additional key/value pairs to be added to the event.
Type: ...any
See console.log().
Writes a log event to stdout with level set to "trace".
Type: ...any
See console.log().
Writes a log event to stdout with level set to "debug".
Type: ...any
See console.log().
Cumulus is a cloud-based data ingest, archive, distribution and management prototype for NASA's future Earth science data streams.
See Cumulus README
[v1.13.0] - 2019-5-20
CUMULUS-802 added some additional IAM permissions to support ECS autoscaling, so you will have to redeploy your IAM stack. As a result of the changes for CUMULUS-1193, CUMULUS-1264, and CUMULUS-1310, you must delete your existing stacks (except IAM) before deploying this version of Cumulus. If running Cumulus within a VPC and extended downtime is acceptable, we recommend doing this at the end of the day to allow AWS backend resources and network interfaces to be cleaned up overnight.
CUMULUS-1228
ecs.amiid property in your config. Instructions for finding
the most recent NGAP AMI can be found using
these instructions.CUMULUS-1310
db stack.
Migrations for this version will need to be user-managed. (e.g. elasticsearch and dynamoDB).
Order of stack deployment is iam -> db -> app.config.yml file, i.e.: kes cf deploy --kes-folder app --template node_modules/@cumulus/deployment/[iam|db|app] [...]
Backwards-compatible. For development, please re-run npm run bootstrap to build new kes overrides.
Deployment docs have been updated to show how to deploy a single-config Cumulus instance.params have been moved: Nest params fields under app, db or iam to override all Parameters for a particular stack's cloudformation template. Backwards-compatible with multi-config setups.stackName and stackNameNoDash have been retired. Use prefix and prefixNoDash instead.iams section in app/config.yml IAM roles has been deprecated as a user-facing parameter,
unless your IAM role ARNs do not match the convention shown in @cumulus/deployment/app/config.ymlvpc.securityGroup will need to be set with a pre-existing security group ID to use Cumulus in a VPC. Must allow inbound HTTP(S) (Port 443).CUMULUS-1212
@cumulus/post-to-cmr will now fail if any granules being processed are missing a metadata file. You can set the new config option skipMetaCheck to true to pass post-to-cmr without a metadata file.CUMULUS-1232
@cumulus/sync-granule will no longer silently pass if no checksum data is provided. It will use input
from the granule object to:
checksumType and checksumValue are in the file record OR a checksum file is provided
(throws InvalidChecksum on fail), else log warning that no checksum is available.file.size is in the file record (throws UnexpectedFileSize on fail),
else log warning that no file size is available.CUMULUS-1264
CumulusApiDefault nested stack resource has been renamed to CumulusApiDistributionCumulusApiV1 nested stack resource has been renamed to CumulusApiBackendurs: true config option for when defining your lambdas (e.g. in lambdas.yml) has been deprecated. There are two new options to replace it:
urs_redirect: 'token': This will expose a TOKEN_REDIRECT_ENDPOINT environment variable to your lambda that references the /token endpoint on the Cumulus backend APIurs_redirect: 'distribution': This will expose a DISTRIBUTION_REDIRECT_ENDPOINT environment variable to your lambda that references the /redirect endpoint on the Cumulus distribution APICUMULUS-1193
aws iam create-service-linked-role --aws-service-name es.amazonaws.comCUMULUS-802
maxInstances must be greater than minInstances. If you use defaults, no change is required.CUMULUS-1269
fileType field to typefileSize field to sizechecksumValue field to checksum where not already done.ancillary and linkage type support to file objects.CUMULUS-799
CUMULUS-1242 - Added sqs2sfThrottle lambda. The lambda reads SQS messages for queued executions and uses semaphores to only start new executions if the maximum number of executions defined for the priority key (cumulus_meta.priorityKey) has not been reached. Any SQS messages that are read but not used to start executions remain in the queue.
CUMULUS-1240
sfSemaphoreDown lambda. This lambda receives SNS messages and for each message it decrements the semaphore used to track the number of running executions if:
cumulus_meta.priorityKey)sfSemaphoreDown lambda as a subscriber to the sfTracker SNS topicCUMULUS-1265
apiConfigs configuration option to configure API Gateway to be privateNoVpc lambdas from documentation and example folder.CUMULUS-802
Updated @cumulus/ingest/http/httpMixin.list() to trim trailing spaces on discovered filenames
CUMULUS-1310
db stack.
This will enable future updates to avoid affecting database resources or requiring migrations.
Migrations for this version will need to be user-managed.
(e.g. elasticsearch and dynamoDB).
Order of stack deployment is iam -> db -> app.config.yml file, i.e.: kes cf deploy --kes-folder app --template node_modules/@cumulus/deployment/[iam|db|app] [...]
Backwards-compatible. Please re-run npm run bootstrap to build new kes overrides.
Deployment docs have been updated to show how to deploy a single-config Cumulus instance.params fields should now be nested under the stack key (i.e. app, db or iam) to provide Parameters for a particular stack's cloudformation template,
for use with single-config instances. Keys must match the name of the deployment package folder (app, db, or iam).
Backwards-compatible with multi-config setups.stackName and stackNameNoDash have been retired as user-facing config parameters. Use prefix and prefixNoDash instead.
This will be used to create stack names for all stacks in a single-config use case.
stackName may still be used as an override in multi-config usage, although this is discouraged.
Warning: overriding the db stack's stackName will require you to set dbStackName in your app/config.yml.
This parameter is required to fetch outputs from the db stack to reference in the app stack.iams section in app/config.yml IAM roles has been retired as a user-facing parameter,
unless your IAM role ARNs do not match the convention shown in @cumulus/deployment/app/config.yml
In that case, overriding iams in your own config is recommended.iam and db cloudformation.yml file names will have respective prefixes (e.g iam.cloudformation.yml).private, public and protected types.vpc.securityGroup in config.yml.
This security group must allow inbound HTTP(S) traffic (Port 443). SSH traffic (Port 22) must be permitted for SSH access to ECS instances.CUMULUS-1236
CUMULUS-1223
CUMULUS-1232
ingest/granule.handleDuplicateFile for maintainability.ingest/granule.ingestFile and move-granules/index.moveFileRequest to use new function.ingest/granule.moveGranuleFileWithVersioningingest/granule.verifyFile now also tests file.size for verification if it is in the file record and throws
UnexpectedFileSize error for file size not matching input.ingest/granule.verifyFile logs warnings if checksum and/or file size are not available.CUMULUS-1193
CUMULUS-1207
Updated Lerna publish script so that published Cumulus packages will pin their dependencies on other Cumulus packages to exact versions (e.g. 1.12.1 instead of ^1.12.1)
CUMULUS-1203
CUMULUS-1268
FAQs
A log library for use on Cumulus
The npm package @cumulus/logger receives a total of 167 weekly downloads. As such, @cumulus/logger popularity was classified as not popular.
We found that @cumulus/logger demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers 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
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.