Type alias ObservabilityEndpoint

ObservabilityEndpoint: {
    cloudHostname?: undefined;
    observabilityUrl: string;
} | {
    cloudHostname: string;
    observabilityUrl?: undefined;
}

Where the observability exporters send data.

cloudHostname is the pre-1.8 spelling: a bare host that always implied https. It is still accepted so callers compiled against earlier releases keep working, and resolves to exactly the URL they got before. New callers should pass observabilityUrl, which can also carry a scheme, a port, and a base path.

Type declaration

  • Optional cloudHostname?: undefined
  • observabilityUrl: string

    Base URL for LiveKit Cloud observability, without a trailing slash.

Type declaration

  • cloudHostname: string

    Deprecated

    Pass observabilityUrl instead. A bare hostname is assumed to be https.

  • Optional observabilityUrl?: undefined

Settings

Member Visibility

Theme