# config

Python API: `luxonis_ml.telemetry.config`

## 类

### TelemetryConfig

遥测数据收集的配置。

#### 方法

##### from_environ

```python
def from_environ(defaults: TelemetryDefaults | None = None) -> TelemetryConfig:
```

从环境变量构建配置。

读取 `LUXONIS_TELEMETRY_*` 设置并返回一个完全填充的 `TelemetryConfig`
实例。[luxonis_ml.telemetry](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry.md)
包文档列出了这些变量。环境变量优先于产品级默认值，产品级默认值又优先于遥测模块的基本默认值。

`backend` 字段是一个例外。如果 `LUXONIS_TELEMETRY_BACKEND` 和 `TelemetryDefaults.backend` 都没有提供值，则最后的备用值保持动态：当解析的 `debug` 为 True 时，后端为
`"stdout"`，否则为 `"posthog"`。

参数

 * `defaults` (`TelemetryDefaults | None`): 当给定环境变量未设置时使用的可选产品级默认值。

返回

 * `TelemetryConfig`: 从环境变量构建的遥测配置。

#### 属性

##### allow_reserved_overrides

调用者和上下文提供者是否可以覆盖保留的遥测控制字段。保留字段是 `$process_person_profile`、`$session_id`、`source_product`、`source_component` 和 `sdk_version`。请参阅
[luxonis_ml.telemetry.context.RESERVED_METADATA_KEYS](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry/context.md)。除非您打算覆盖，否则请保留默认值。PostHog
后端仍然自行设置 `schema_version`。

##### allowlist

可以记录的 CLI 参数名称。

##### api_key

后端适用的 API 密钥。

##### backend

要使用的后端名称，例如 `"posthog"` 或 `"stdout"`。

##### debug

是否启用调试行为，例如 stdout 后端默认值。

##### disable_geoip

是否禁用 PostHog GeoIP 丰富。

##### enabled

遥测是否应发出事件。

##### endpoint

后端适用的自定义端点或主机。

##### include_base_context

是否在每个事件中包含共享的默认上下文。

##### include_system_metadata

是否默认包含扩展系统元数据。

### TelemetryDefaults

遥测配置的可选产品级默认值。

任何留作 `None` 的字段都将回退到遥测模块的该设置的基本默认值。

#### 属性

##### allow_reserved_overrides

##### allowlist

##### api_key

##### backend

##### debug

##### disable_geoip

##### enabled

##### endpoint

##### include_base_context

##### include_system_metadata

## 属性

### T
