includes/prometheus/client_metric.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 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.
 */
 
#pragma once
 
#include <cstdint>
#include <string>
#include <tuple>
#include <vector>
 
#include "prometheus/detail/core_export.h"
 
namespace prometheus {
 
struct PROMETHEUS_CPP_CORE_EXPORT ClientMetric {
  // Label
 
  struct Label {
    std::string name;
    std::string value;
 
    friend bool operator<(const Label& lhs, const Label& rhs) {
      return std::tie(lhs.name, lhs.value) < std::tie(rhs.name, rhs.value);
    }
 
    friend bool operator==(const Label& lhs, const Label& rhs) {
      return std::tie(lhs.name, lhs.value) == std::tie(rhs.name, rhs.value);
    }
  };
  std::vector<Label> label;
 
  // Counter
 
  struct Counter {
    double value = 0.0;
  };
  Counter counter;
 
  // Gauge
 
  struct Gauge {
    double value = 0.0;
  };
  Gauge gauge;
 
  // Info
 
  struct Info {
    double value = 1.0;
  };
  Info info;
 
  // Summary
 
  struct Quantile {
    double quantile = 0.0;
    double value = 0.0;
  };
 
  struct Summary {
    std::uint64_t sample_count = 0;
    double sample_sum = 0.0;
    std::vector<Quantile> quantile;
  };
  Summary summary;
 
  // Histogram
 
  struct Bucket {
    std::uint64_t cumulative_count = 0;
    double upper_bound = 0.0;
  };
 
  struct Histogram {
    std::uint64_t sample_count = 0;
    double sample_sum = 0.0;
    std::vector<Bucket> bucket;
  };
  Histogram histogram;
 
  // Untyped
 
  struct Untyped {
    double value = 0;
  };
  Untyped untyped;
 
  // Timestamp
 
  std::int64_t timestamp_ms = 0;
};
 
}  // namespace prometheus