metric.md

id	title
metric	Monitoring Metric

Metric Object

:::info TypeScript Support

A monitoring metric object has an associated TypeScript type:

• Type Name - MonitoringMetric
• Package - @resolve-js/core

:::

A monitoring metric object contains information about a particular metric collected during application execution. Metrics are stored and processed internally by monitoring adapters and can be accessed through a monitoring object's getMetrics method:

const metrics = monitoring.getMetrics('default')

A metric object has the following structure:

{
  metricName, // The name of a metric.
  dimensions, // An array of monitoring dimensions.
  timestamp,  // The time at which the metric was last updated.
  values,     // An array of the metric's values.
  counts,     // An array of the metric's counts.
  unit,       // The name of the measurment unit.
}

Custom Metric Object

:::info TypeScript Support

A custom metric object has an associated TypeScript type:

• Type Name - MonitoringCustomMetric
• Package - @resolve-js/core

:::

A custom metric object is used to pass metric data to the metrics.custom() method. This object has the following structure:

{
  metricName, // The name of a metric.
  dimensions, // An array of monitoring dimensions.
  value,      // The metric's values.
  count,      // The metric's count.
  unit,       // The name of the measurment unit.
}