# Copyright (c) 2026 Huawei Technologies Co., Ltd.
# openFuyao is licensed under Mulan PSL v2.
# You can use this software according to the terms and conditions of the Mulan PSL v2.
# You may obtain a copy of Mulan PSL v2 at:
# http://license.coscl.org.cn/MulanPSL2
# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
# EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
# MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
# See the Mulan PSL v2 for more details.
"""
Base metric definition for network performance exporter.
"""
from dataclasses import dataclass
from enum import Enum
from typing import List
class MetricType(Enum):
"""Metric types."""
GAUGE = "gauge"
COUNTER = "counter"
HISTOGRAM = "histogram"
@dataclass
class MetricDefinition:
"""Definition of a metric."""
name: str
metric_type: MetricType
help_text: str
labels: List[str]
unit: str = ""
def full_name(self) -> str:
"""Get the full metric name with unit suffix."""
if self.unit:
return f"{self.name}_{self.unit}"
return self.name