DataDogLogger

Extends: CachedCounters

Implements: IReferenceable, IReferenceable

Description

The DataDogLogger class allows you to create loggers that dump execution logs to a DataDog service.

Configuration parameters

• level: maximum log level to capture
• source: source (context) name
• connection:
  • discovery_key: (optional) key to retrieve the connection from IDiscovery
  • protocol: (optional) connection protocol: http or https (default: https)
  • host: (optional) host name or IP address (default: http-intake.logs.datadoghq.com)
  • port: (optional) port number (default: 443)
  • uri: (optional) resource URI or connection string with all parameters in it
• credential:
  • access_key: DataDog client api key
• options:
  • interval: interval in milliseconds to save log messages (default: 10 seconds)
  • max_cache_size: maximum number of messages stored in this cache (default: 100)
  • reconnect: reconnect timeout in milliseconds (default: 60 sec)
  • timeout: invocation timeout in milliseconds (default: 30 sec)
  • max_retries: maximum number of retries (default: 3)

References

• *:context-info:*:*:1.0 - (optional) ContextInfo to detect the context id and specify counters source
• *:counters:*:*:1.0 - (optional) ICounters components to pass collected measurements
• *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve a connection

Constructors

Creates a new instance of the logger.

public constructor()

Instance methods

close

Closes a component and frees used resources.

public close(correlationId: string): Promise<void>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.

configure

Configures component by passing configuration parameters.

public configure(config: ConfigParams): void

• config: ConfigParams - (optional) transaction id used to trace execution through the call chain.

isOpen

Checks if the component is open.

public isOpen(): boolean

• returns: boolean - true if the component is open and false otherwise.

open

Opens the component.

public open(correlationId: string): Promise<void>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.

save

Saves log messages from the cache.

protected save(counters: LogMessage[]): void

• counters: LogMessage[] - current counters measurements to be saved.

setReferences

Sets references to dependent components.

public setReferences(references: IReferences): void

• references: IReferences - references to locate the component’s dependencies.

Examples

let logger = new DataDogLogger();
logger.configure(ConfigParams.fromTuples(
    "credential.access_key", "827349874395872349875493"
));

await logger.open("123");
   
logger.error("123", ex, "Error occured: %s", ex.message);
logger.debug("123", "Everything is OK.");