@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.
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.