API Reference
    Preparing search index...

    Type Alias ExtraOptions

    Options to customize the behavior of the logMetrics() decorator or Middy.js middleware.

    type ExtraOptions = {
        captureColdStartMetric?: boolean;
        defaultDimensions?: Dimensions;
        throwOnEmptyMetrics?: boolean;
    }
    Index

    Properties

    captureColdStartMetric? defaultDimensions? throwOnEmptyMetrics?

    Properties

    captureColdStartMetric?: boolean

    Whether to capture a ColdStart metric.

    false

    captureColdStartMetric()

    defaultDimensions?: Dimensions

    Default dimensions to add to all metrics.

    {}

    setDefaultDimensions()

    throwOnEmptyMetrics?: boolean

    Whether to throw an error if no metrics are emitted.

    false

    publishStoredMetrics()

    Settings

    Member Visibility

    On This Page

    Properties