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:
- level (string) - the priority level of the message
- message (string) - the message itself
- sender (string) - the resource that created the message
- timestamp (string) - an ISO-8601 timestamp
Log events may have the following options keys:
- executions (string)
- granules (string [stringified array of objects])
- parentArn (string)
- stackName (string)
- version (string)
- asyncOperationId (string)
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.
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:
-
error (Object)
- name (string)
- message (string)
- stack (Array<string>) - the lines of the stack trace
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.
To make a contribution, please see our contributing guidelines.