CloudWatchCounters

Performance counters that periodically dump counters to AWS Cloud Watch Metrics.

Implements: IConfigurable, IReferenceable

Extends: CachedCounters

Description

The CloudWatchCounters class allows you to create performance counters that periodically dump counters to AWS Cloud Watch Metrics.

Configuration parameters

  • connections:
    • discovery_key: (optional) key to retrieve the connection from IDiscovery
    • region: (optional) AWS region
  • credentials:
    • store_key: (optional) key to retrieve the credentials from ICredentialStore
    • access_id: AWS access/client id
    • access_key: AWS access/client key
  • options:
    • interval: interval in milliseconds to save current counters measurements (default: 5 mins)
    • reset_timeout: timeout in milliseconds to reset the counters. 0 disables the reset (default: 0)

References

  • *:context-info:*:*:1.0 - (optional) ContextInfo to detect the context id and specify the counters' source
  • *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connections
  • *:credential-store:*:*:1.0 - (optional) credential stores to resolve credentials requests

Constructors

Creates a new instance of this counters.

CloudWatchCounters()

Instance methods

close

Closes component and frees used resources.

@override

Future close(IContext context)

  • context: IContext - (optional) a context to trace execution through a call chain.

configure

Configures a component by passing its configuration parameters.

@override

void configure(ConfigParams config)

  • config: ConfigParams - configuration parameters to be set.

isOpen

Checks if the component is open.

@override

bool isOpen()

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

open

Opens the component.

@override

Future open(IContext context)

  • context: IContext - (optional) a context to trace execution through a call chain.

save

Saves the current counters' measurements.

@override

Future save(List<Counter> counters)

  • counters: List<Counter> - current counters' measurements to be saved.

setReferences

Sets references to dependent components.

@override

void setReferences(IReferences references)

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

Examples

var counters = new CloudWatchCounters();
counters.config(ConfigParams.fromTuples([
    'connection.region', 'us-east-1',
    'connection.access_id', 'XXXXXXXXXXX',
    'connection.access_key', 'XXXXXXXXXXX'
]));

counters.setReferences(References.fromTuples([
    Descriptor('pip-services', 'logger', 'console', 'default', '1.0'),
    ConsoleLogger()
]));

await counters.open('123');
    ...
counters.increment('mycomponent.mymethod.calls');
var counter_timing = counters.beginTiming('mycomponent.mymethod.exec_time');
try {
    ...
} finally {
    counter_timing.endTiming();
}
counters.dump();

See also