config.py

# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Telemetry configuration types.

Canonical location for TelemetryConfig and UsageContext. These are defined
here (in the usage package) rather than in llm_args.py so that the
dependency arrow points correctly: llm_args imports from usage, not
vice versa.

Imported by tensorrt_llm.llmapi.llm_args for use in BaseLlmArgs.
"""

from enum import Enum

from pydantic import Field

from tensorrt_llm.llmapi.utils import StrictBaseModel


class UsageContext(str, Enum):
    """Identifies how TRT-LLM was invoked for telemetry tracking."""

    UNKNOWN = "unknown"
    LLM_CLASS = "llm_class"
    CLI_SERVE = "cli_serve"
    CLI_BENCH = "cli_bench"
    CLI_EVAL = "cli_eval"


class TelemetryConfig(StrictBaseModel):
    """Telemetry configuration for usage data collection.

    Controls opt-out behavior and tracks which entry point invoked TRT-LLM.
    """

    disabled: bool = Field(
        default=False,
        description="Disable anonymous usage telemetry collection. "
        "Can also be set via TRTLLM_NO_USAGE_STATS=1, TELEMETRY_DISABLED=true, "
        "DO_NOT_TRACK=1, or file ~/.config/trtllm/do_not_track.",
    )
    usage_context: UsageContext = Field(
        default=UsageContext.UNKNOWN,
        description="Identifies how TRT-LLM was invoked (CLI command vs Python API). "
        "Set automatically by CLI commands; defaults to UNKNOWN (promoted to "
        "LLM_CLASS by BaseLLM.__init__ for direct Python API usage).",
    )