yr.Config

Contents

yr.Config#

class yr.Config(function_id: str = '', cpp_function_id: str = '', server_address: str = '', ds_address: str = '', is_driver: bool = True, log_level: str | int = 'WARNING', invoke_timeout: int = 900, local_mode: bool = False, code_dir: str = '', connection_nums: int = 100, recycle_time: int = 2, job_id: str = '', tls_config: ~yr.config.UserTLSConfig | None = None, auto: bool = False, deployment_config: ~yr.config.DeploymentConfig | None = None, rt_server_address: str = '', log_dir: str = './', log_file_size_max: int = 0, log_file_num_max: int = 0, log_flush_interval: int = 5, runtime_id: str = 'driver', max_task_instance_num: int = -1, load_paths: list = <factory>, rpc_timeout: int = 1800, enable_mtls: bool = False, private_key_path: str = '', certificate_file_path: str = '', verify_file_path: str = '', server_name: str = '', ns: str = '', enable_metrics: bool = False, custom_envs: ~typing.Dict[str, str] = <factory>, master_addr_list: list = <factory>, working_dir: str = '', enable_ds_encrypt: bool = False, ds_public_key_path: str = '', runtime_public_key_path: str = '', runtime_private_key_path: str = '')#

基类:object

init 接口使用的配置参数。

属性

auto

yr.init 时自动启动分布式执行器,并在 yr.finalize 时自动停止分布式执行器。

certificate_file_path

客户端证书文件路径。

code_dir

需要在 runtime 初始化时设置的代码目录路径。

connection_nums

HTTP 客户端连接数。

cpp_function_id

部署的 C++ 函数 ID,默认通过环境变量 YR_CPP_FUNCID 获取。

deployment_config

auto=True 时,用于定义部署细节。

ds_address

数据系统地址,默认通过环境变量 YR_DS_ADDRESS 获取。

ds_public_key_path

工作进程公钥路径,用于数据系统 TLS 认证。

enable_ds_encrypt

是否启用数据系统 TLS 认证。

enable_metrics

是否启用指标收集。

enable_mtls

是否启用客户端双向认证,默认 False

function_id

部署的函数 ID,默认通过环境变量 YRFUNCID 获取。

invoke_timeout

HTTP 客户端读取超时时间(秒),默认 900

is_driver

仅在运行时初始化时为 False,默认 True

job_id

init 自动生成。

local_mode

在本地运行代码,默认 False

log_dir

日志目录,指定日志文件存储的路径。

log_file_num_max

日志文件的最大数量,默认 0

log_file_size_max

日志文件的最大大小,默认 0

log_flush_interval

日志刷新间隔,默认 5

log_level

YR API 日志级别有 ERROR/WARNING/INFO/DEBUG,默认 WARNING

max_task_instance_num

任务的最大实例数。

ns

命名空间,用于组织和隔离配置或资源。

private_key_path

客户端私钥文件路径。

recycle_time

实例回收周期(秒)。

rpc_timeout

RPC 超时时间(秒)。

rt_server_address

runtime 服务地址,在 driver 中保持默认值。

runtime_id

运行时 ID,在驱动程序中保持默认值。

runtime_private_key_path

客户端私钥路径,用于数据系统 TLS 认证。

runtime_public_key_path

客户端公钥路径,用于数据系统 TLS 认证。

server_address

系统集群地址,默认通过环境变量 YR_SERVER_ADDRESS 获取。

server_name

服务器名称,用于识别和连接到特定的服务器实例。

tls_config

用于外部集群的 HTTPS SSL。

verify_file_path

服务器证书文件路径。

working_dir

指定用户代码或其依赖的本地路径位置,必须是绝对路径,并确保在集群的所有节点上都存在。

load_paths

代码加载路径。

custom_envs

用于为运行时设置自定义环境变量。

master_addr_list

函数主节点地址列表。

dedup_logs

用于对作业中的函数进程标准输出日志去重。

方法