API Reference
    Preparing search index...

    Type Alias MetricsOptions

    Options to configure the Metrics class.

    import { Metrics } from '@aws-lambda-powertools/metrics';

    const metrics = new Metrics({
      namespace: 'serverlessAirline',
      serviceName: 'orders',
      singleMetric: true,
    });
    type MetricsOptions = {
        customConfigService?: ConfigServiceInterface;
        defaultDimensions?: Dimensions;
        functionName?: string;
        logger?: GenericLogger;
        namespace?: string;
        serviceName?: string;
        singleMetric?: boolean;
    }
    Index

    Properties

    customConfigService? defaultDimensions? functionName? logger? namespace? serviceName? singleMetric?

    Properties

    customConfigService?: ConfigServiceInterface

    A custom configuration service to use for retrieving configuration values.

    undefined
    defaultDimensions?: Dimensions

    The default dimensions to add to all metrics.

    {}

    setDefaultDimensions()

    functionName?: string

    Function name to use as dimension for the ColdStart metric.

    When not provided, the function name is inferred either via:

    • POWERTOOLS_FUNCTION_NAME environment variable
    • AWS Lambda function context, only when using the logMetrics() decorator or the Middy.js middleware
    • functionName parameter in the captureColdStartMetric() method

    If none of the above are available, the ColdStart metric will not include a function name dimension.

    setFunctionName()

    logger?: GenericLogger

    Logger object to be used for emitting debug, warning, and error messages.

    If not provided, debug messages will be suppressed, and warning and error messages will be sent to stdout.

    Note that EMF metrics are always sent directly to stdout, regardless of the logger to avoid compatibility issues with custom loggers.

    namespace?: string

    The namespace to use for all metrics.

    undefined
    serviceName?: string

    The service name to use for all metrics.

    undefined
    singleMetric?: boolean

    Whether to configure the Metrics class to emit a single metric as soon as it is added.

    false

    singleMetric()

    Settings

    Member Visibility

    On This Page

    Properties