Interface CarbonClientOptions

[[CarbonClient]] options.

interface CarbonClientOptions {
    address: string;
    autoConnect?: boolean;
    family?: 4 | 6;
    port?: number;
    prefix?: string;
    retryOnError?: number;
    retryTimeout?: number;
    sendBufferSize?: number;
    sendInterval?: number;
    tlsCA?:
        | null
        | string
        | string[]
        | Buffer<ArrayBufferLike>
        | Buffer<ArrayBufferLike>[];
    tlsCert?:
        | null
        | string
        | string[]
        | Buffer<ArrayBufferLike>
        | Buffer<ArrayBufferLike>[];
    tlsKey?:
        | null
        | string
        | string[]
        | Buffer<ArrayBufferLike>
        | Buffer<ArrayBufferLike>[];
    transport?: Transport;
    udpSendBufferSize?: number;
}

Properties

address autoConnect? family? port? prefix? retryOnError? retryTimeout? sendBufferSize? sendInterval? tlsCA? tlsCert? tlsKey? transport? udpSendBufferSize?

Properties

address

address: string

For TCP and UDP the hostname or IP address of the server, for IPC the file name of the Unix domain socket.

OptionalautoConnect

autoConnect?: boolean

Automatically connect on write if not connected. Defaults to false.

See

[[CarbonClient.autoConnect]]

Optionalfamily

family?: 4 | 6

For TCP and UDP the IP address family to use.

See

[[CarbonClient.family]]

Optionalport

port?: number

Server port to connect to. Defaults to [[DEFAULT_PORT]].

Optionalprefix

prefix?: string

Prefix added to all metric paths.

OptionalretryOnError

retryOnError?: number

Number of automatic retries on network error. Defaults to 0.

See

[[CarbonClient.retryOnError]]

OptionalretryTimeout

retryTimeout?: number

Time to wait before retrying after error. Defaults to [[DEFAULT_RETRY_TIMEOUT]].

See

[[CarbonClient.retryTimeout]]

OptionalsendBufferSize

sendBufferSize?: number

Size of send buffer. If set to 0 metrics are sent immediately. Defaults to [[DEFAULT_SEND_BUFFER_SIZE]].

OptionalsendInterval

sendInterval?: number

Buffer wait time. If set to 0 metrics are sent immediately. Defaults to [[DEFAULT_SEND_INTERVAL]].

OptionaltlsCA

tlsCA?:
    | null
    | string
    | string[]
    | Buffer<ArrayBufferLike>
    | Buffer<ArrayBufferLike>[]

Override the trusted CA certificates.

OptionaltlsCert

tlsCert?:
    | null
    | string
    | string[]
    | Buffer<ArrayBufferLike>
    | Buffer<ArrayBufferLike>[]

PEM encoded TLS certificate if [[CarbonClientOptions.transport]] is 'TLS'.

OptionaltlsKey

tlsKey?:
    | null
    | string
    | string[]
    | Buffer<ArrayBufferLike>
    | Buffer<ArrayBufferLike>[]

PEM encoded TLS private key if [[CarbonClientOptions.transport]] is 'TLS'.

Optionaltransport

transport?: Transport

Transport layer protocol to use. Defaults to [[DEFAULT_TRANSPORT]].

OptionaludpSendBufferSize

udpSendBufferSize?: number

If [[CarbonClient.transport]] is "UDP" the dgram.SocketOptions.sendBufferSize of UDP sockets.

Settings

Member Visibility

On This Page

Properties