interface SelfRegistration
Since 0.2.0

What this application advertises about itself.

Properties

readonly
serviceName: string

Logical service name other applications resolve.

readonly
optional
id: string

Instance id, unique within the service. Defaults to <name>-<uuid>.

readonly
address: string

Address other applications should reach this instance on.

readonly
port: number

Port other applications should reach this instance on.

readonly
optional
tags: readonly string[]

Labels to attach to the registration.

readonly
optional
metadata: Readonly<Record<string, string>>

Key/value metadata to attach to the registration.

readonly
optional
check: SelfRegistrationCheck

The mandatory health check (defaults applied by resolveOptions).

readonly
optional
drainDelayMs: number

Milliseconds to keep serving after deregistering, before draining begins.

The point of the delay is propagation: callers that already hold a stale instance list keep sending traffic for a moment after the registry forgets this instance, and this window serves them normally instead of refusing.

Usage

import { type SelfRegistration } from "service-discovery-plugin/src/index.ts";