@loopback/docs/site/apidocs/metrics.md

Documentation files rendered at [https://loopback.io](https://loopback.io)

---
lang: en
title: 'API docs: metrics'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/metrics
permalink: /doc/en/lb4/apidocs.metrics.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/metrics](./metrics.md)

## metrics package

A component that reports metrics of Node.js, the LoopBack framework, and your application to Prometheus.

## Classes

|  Class | Description |
|  --- | --- |
|  [MetricsComponent](./metrics.metricscomponent.md) | A component providing metrics for Prometheus |

## Interfaces

|  Interface | Description |
|  --- | --- |
|  [MetricsOptions](./metrics.metricsoptions.md) | Options for metrics component |

## Namespaces

|  Namespace | Description |
|  --- | --- |
|  [MetricsBindings](./metrics.metricsbindings.md) | Binding keys used by this component. |

## Variables

|  Variable | Description |
|  --- | --- |
|  [DEFAULT\_METRICS\_OPTIONS](./metrics.default_metrics_options.md) |  |

## Type Aliases

|  Type Alias | Description |
|  --- | --- |
|  [MetricsConfig](./metrics.metricsconfig.md) | Configuration for metrics component with optional properties |