Skip to main content

Documentation Index

Fetch the complete documentation index at: https://handbook.fiddler.ai/llms.txt

Use this file to discover all available pages before exploring further.

Initialize the Fiddler client with connection parameters and global configuration. This function establishes a connection to the Fiddler platform and configures the global client state. It handles authentication, server compatibility validation, logging setup, and creates the singleton connection instance used throughout the client library.

Parameters

ParameterTypeRequiredDefaultDescription
urlstrNoneThe base URL to your Fiddler platform instance
tokenstrNoneAuthentication token obtained from the Fiddler UI Credentials tab
proxies`dictNone`None
timeout`floattuple[float, float] | None`None
verifyboolTrueWhether to verify server’s TLS certificate
validateboolTrueWhether to validate server/client version compatibility

Raises

  • ValueError — If url or token parameters are empty
  • IncompatibleClient — If server version is incompatible with client version
  • ConnectionError — If unable to connect to the Fiddler platform Return type: None

Examples

Basic initialization:
import fiddler as fdl

fdl.init(
    url="https://your-instance.fiddler.ai",
    token="your-auth-token"
)
Initialization with custom timeout and proxy:
fdl.init(
    url="https://your-instance.fiddler.ai",
    token="your-auth-token",
    timeout=(10.0, 60.0),  # 10s connect, 60s read timeout
    proxies={"https": "https://proxy.company.com:8080"}
)
Initialization for development with relaxed settings:
fdl.init(
    url="https://your-instance.fiddler.ai",
    token="dev-token",
    verify=False,  # Skip SSL verification
    validate=False,  # Skip version compatibility check
)
The client implements automatic retry strategies for transient failures. Configure retry duration via FIDDLER_CLIENT_RETRY_MAX_DURATION_SECONDS environment variable (default: 300 seconds).
Logging is performed under the ‘fiddler’ namespace at INFO level. If no root logger is configured, a stderr handler is automatically attached unless auto_attach_log_handler=False.