@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');
new Logger({ [asyncOperationId], [executions], [granules], [parentArn], [sender], [stackName], [version] })Type: string
An optional async operation id associated with a workflow.
Type: string
An optional description of the executions.
type: string
An optional granules string. Generally a stringified array of granule objects.
type: string
An optional stepfunction ARN of the parent workflow that triggered the current execution.
Type: string
The sender of the log event. Typically a Lambda Function Name or ECS Task Name. Defaults to "unknown".
type: string
Cumulus stack name.
Type: string
An optional version.
log.debug([...messageArgs])Writes a log event to stdout with level set to "debug".
Type: ...any
See console.log().
log.error([...messageArgs][, error])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:
log.fatal([...messageArgs])Writes a log event to stdout with level set to "fatal".
Type: ...any
See console.log().
log.info([...messageArgs])Writes a log event to stdout with level set to "info".
Type: ...any
See console.log().
log.infoWithAdditionalKeys(additionalKeys, ...messageArgs)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().
log.trace([...messageArgs])Writes a log event to stdout with level set to "trace".
Type: ...any
See console.log().
log.warn([...messageArgs])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.
To make a contribution, please see our contributing guidelines.
[v14.1.0] 2023-02-27
From this release forward Core will be tested against PostgreSQL 11 Existing release compatibility testing was done for release 11.1.8/14.0.0+. Users should migrate their datastores to Aurora PostgreSQL 11.13+ compatible data stores as soon as possible.
Users utilizing the cumulus-rds-tf module will have upgraded/had their
database clusters forcibly upgraded at the next maintenance window after 31 Jan
2023. Our guidance to mitigate this issue is to do a manual (outside of
terraform) upgrade. This will result in the cluster being upgraded with a
manually set parameter group not managed by terraform.
If you manually upgraded and the cluster is now on version 11.13, to continue
using the cumulus-rds-tf module once upgraded update following module
configuration values if set, or allow their defaults to be utilized:
parameter_group_family = "aurora-postgresql11"
engine_version = 11.13
When you apply this update, the original PostgreSQL v10 parameter group will be removed, and recreated using PG11 defaults/configured terraform values and update the database cluster to use the new configuration.
PUT
endpoint. In future releases the PUT endpoint will be replaced with valid PUT logic
behavior (complete overwrite) in a future release. The existing PUT
implementation is deprecated and users should move all existing usage of
PUT to PATCH before upgrading to a release with CUMULUS-3072.CUMULUS-3033
granuleEsQuery to properly terminate if body.hit.total.value is 0.The getLambdaAliases function has been removed from the @cumulus/integration-tests package
The getLambdaVersions function has been removed from the @cumulus/integration-tests package
CUMULUS-3117
@cumulus/es-client/indexer.js to properly handle framework write
constraints for queued granules. Queued writes will now be properly
dropped from elasticsearch writes along with the primary datastore(s) when
write constraints applyCUMULUS-3134
CUMULUS-3148:
CUMULUS-3149
/granules/bulkDelete endpoint to take the
following configuration keys for the bulkDelete:
concurrency, and generally should not be
changed unless troubleshooting performance concerns.CUMULUS-3142
CUMULUS-3181
sqsMessageRemover lambda to correctly retrieve ENABLED sqs rules.CUMULUS-3189
cumulus-process and cumulus-message-adapter-python versions to
support pip 23.0CUMULUS-3196
createServer initialization outside the s3-credentials-endpoint lambda
handler to reduce file descriptor usageREADME shell snippets better support copying
CUMULUS-3111
{ version: 2 }2@cumulus/api-client packages to use PATCH protocol for existing
granule PUT calls, this change should not require user updates for
api-client users.
@cumulus/api-client/granules.updateGranule@cumulus/api-client/granules.moveGranule@cumulus/api-client/granules.updateGranule@cumulus/api-client/granules.reingestGranule@cumulus/api-client/granules.removeFromCMR@cumulus/api-client/granules.applyWorkflow@cumulus/cmr-client package's token from Echo-Token to Earthdata Login (EDL) token in updateToken methodFAQs
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.