# IMQMetricsServerOptions interface · @imqueue/rpc

Source: https://imqueue.org/api/rpc/latest/rpc.imqmetricsserveroptions/
Published: 2026-08-04
Author: @imqueue maintainers (https://github.com/imqueue)
Package: @imqueue/rpc 3.5.3 — generated reference, not hand-written

Options for the built-in metrics server.

**Signature:**

```typescript
export interface IMQMetricsServerOptions 
```

## Properties


| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [enabled?](https://imqueue.org/api/rpc/latest/rpc.imqmetricsserveroptions.enabled/) |  | boolean | _(Optional)_ Start the metrics HTTP listener when true. |
| [port?](https://imqueue.org/api/rpc/latest/rpc.imqmetricsserveroptions.port/) |  | number | _(Optional)_ TCP port to bind on all interfaces. |
| [queueLengthFormatter?](https://imqueue.org/api/rpc/latest/rpc.imqmetricsserveroptions.queuelengthformatter/) |  | (length: number, metricName: string) => string | _(Optional)_ Renders the response body from the current queue length and the metric name, which is always the literal `'queue_length'`. |