# singleton

Python API: `luxonis_ml.telemetry.singleton`

## 类

### TelemetryKey

#### 属性

##### library_name

##### source_component

## 函数

### get_or_init

```python
def get_or_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, register_exit_handler: bool = True) -> Telemetry:
```

返回一个现有的遥测实例或初始化一个。

> **注意**
> 对同一键的第二次调用不会重建实例，它以两种不同的方式协调参数：

 * `config` 和 `library_version` 是不可变的。与现有值不同的值将被忽略，函数会记录警告。
 * `context_providers` 和 `system_context_providers` 是累加的。新的提供者将合并到现有实例中。

这使得多个集成点可以在不重建单例的情况下贡献遥测上下文。

参数

 * `library_name` (`str`): 发出遥测的库的名称。
 * `source_component` (`str | None`): 单例实例的可选发射器/组件名称。如果省略，则重用库名称。
 * `library_version` (`str | None`): 库的版本字符串。
 * `config` (`TelemetryConfig | None`): 可选的遥测配置。
 * `context_providers` (`list[ContextProvider] | None`): 返回要附加到每个事件的额外上下文的可调用对象。
 * `system_context_providers` (`list[SystemContextProvider] | None`): 仅在请求系统元数据时返回要附加的额外上下文的可调用对象。
 * `register_exit_handler` (`bool`): 是否在进程退出时刷新遥测。

返回

 * `Telemetry`: `(library_name, source_component)` 键的现有或新初始化的遥测实例。

### get_telemetry

```python
def get_telemetry(library_name: str | None = None, *, source_component: str | None = None) -> Telemetry | None:
```

通过单例标识返回遥测实例。

参数

 * `library_name` (`str | None`): 可选的库/产品名称，用于过滤。
 * `source_component` (`str | None`): 可选的发射器/组件名称，用于过滤。

返回

 * `Telemetry | None`: 当查找解析为一个实例时，匹配的遥测实例。模糊查找返回 `None`。

### initialize_telemetry

```python
def initialize_telemetry(*, 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, register_exit_handler: bool = True) -> Telemetry:
```

为一个发射器初始化并返回一个遥测实例。

参数

 * `library_name` (`str`): 发出遥测的库的名称。
 * `source_component` (`str | None`): 可选的发射器/组件名称。如果省略，则重用库名称。
 * `library_version` (`str | None`): 库的可选版本字符串。
 * `config` (`TelemetryConfig | None`): 可选的遥测配置。
 * `context_providers` (`list[ContextProvider] | None`): 上下文提供者可调用对象的可选列表。
 * `system_context_providers` (`list[SystemContextProvider] | None`): 系统上下文提供者可调用对象的可选列表。
 * `register_exit_handler` (`bool`): 是否在进程退出时刷新遥测。

返回

 * `Telemetry`: 针对精确 `(library_name, source_component)` 键的初始化遥测实例。

### shutdown_on_exit

```python
def shutdown_on_exit():
```

注册一个退出处理程序，以便在关闭时刷新遥测。
