client
最后更新
luxonis_ml.telemetry.client类
Telemetry
方法
init
Python
1def __init__(library_name: str, *, source_component: str | None = None, library_version: str | None = None, config: TelemetryConfig | None = None, context_providers: list[ContextProvider] | None = None, system_context_providers: list[SystemContextProvider] | None = None):library_name(str): 发出遥测的库的名称,例如"luxonis_ml"。source_component(str | None): 事件上下文的可选发射器/组件名称。如果省略,则重用库名称。library_version(str | None): 库的版本字符串。如果省略,则在可能的情况下从包元数据中解析。config(TelemetryConfig | None): 要使用的遥测配置。如果省略,则从环境变量中读取值。context_providers(list[ContextProvider] | None): 返回要附加到每个事件的额外上下文的可调用对象。system_context_providers(list[SystemContextProvider] | None): 仅在请求系统元数据时返回额外上下文的可调用对象。
add_context_provider
Python
1def add_context_provider(provider: ContextProvider):add_system_context_provider
Python
1def add_system_context_provider(provider: SystemContextProvider):capture
Python
1def capture(event: str, properties: dict[str, Any] | None = None, *, allowlist: set[str] | None = None, include_system_metadata: bool | None = None, distinct_id: str | None = None):event(str): 事件名称,例如"train_started"。properties(dict[str, Any] | None): 可选事件属性。值在发送前经过清理和编辑。allowlist(set[str] | None): 如果设置,则仅包含这些属性键。include_system_metadata(bool | None): 是否为此事件添加扩展系统元数据。如果省略,则使用配置默认值。distinct_id(str | None): 可选的后端身份覆盖。如果省略,则默认为客户端的临时会话标识符。
extend_context_providers
Python
1def extend_context_providers(providers: list[ContextProvider] | None):extend_system_context_providers
Python
1def extend_system_context_providers(providers: list[SystemContextProvider] | None):flush
Python
1def flush(self):register_backend
Python
1def register_backend(name: str, backend_cls: type[TelemetryBackend]):示例
注册后端并通过配置选择它。
Python
1Telemetry.register_backend("my_backend", MyBackend)
2
3config = TelemetryConfig(backend="my_backend")
4telemetry = Telemetry("luxonis_ml", config=config)注意
注册会替换已存储在相同名称下的任何后端。
name(str):TelemetryConfig.backend中使用的后端名称。名称以小写形式存储,因此查找会忽略大小写。backend_cls(type[TelemetryBackend]): 使用TelemetryConfig实例化的后端类。
shutdown
Python
1def shutdown(self):