metrics

Metrics domain — cross-cutting observability.

setProvider(provider)

Replaces the active metrics provider.

Param	Type
provider	MetricsProvider

publish(namespace, metricName, value, [options]) ⇒ Promise.<void>

Publishes a custom metric.

Param	Type	Default	Description
namespace	string		Metric namespace (e.g. "Beem")
metricName	string		Metric name (e.g. "JobsProcessed")
value	number
[options]	object
[options.unit]	string	""None""	CloudWatch unit
[options.dimensions]	Object.<string, string>		Metric dimensions

Example

const { metrics } = require("@beem/sdk");

await metrics.publish("Beem", "JobsProcessed", 1, {
  unit: "Count",
  dimensions: { service: "document-export", flow: "invoice-gen" },
});

MetricsProvider : object

Properties

Name	Type
publish	function