edgeport - v1.0.3
    Preparing search index...

    Interface SyslogConnectOptions

    Options for opening a syslog session.

    Per-message defaults set here (appName, hostnameField, procId) are applied to every SyslogSession.log that does not override them.

    1.0.0

    interface SyslogConnectOptions {
        appName?: string;
        framing?: Framing;
        hostname: string;
        hostnameField?: string;
        port?: number;
        procId?: string;
        timeoutMs?: number;
        tls?: "off" | "starttls" | "implicit";
    }
    Index
    appName? framing? hostname hostnameField? port? procId? timeoutMs? tls?
    appName?: string

    Default APP-NAME field for every message.

    framing?: Framing

    Wire framing; defaults to 'octet-counting'.

    hostname: string

    Collector hostname (also used for TLS certificate validation).

    hostnameField?: string

    Default HOSTNAME field for every message.

    port?: number

    TCP port; defaults to 514.

    procId?: string

    Default PROCID field for every message.

    timeoutMs?: number

    Connect deadline in milliseconds.

    tls?: "off" | "starttls" | "implicit"

    Transport security:

    • 'off' (default): plaintext TCP.
    • 'implicit': TLS from the first byte (RFC 5425).
    • 'starttls': connect in plaintext, then upgrade immediately.

    Settings
    Member Visibility

    On This Page
    Properties