text: // Copyright 2018 The Chromium Authors. All rights reserved.
  // Use of this source code is governed by a BSD-style license that can be
  // found in the LICENSE file.
  
  #ifndef QUICHE_QUIC_PLATFORM_API_QUIC_CLIENT_STATS_H_
  #define QUICHE_QUIC_PLATFORM_API_QUIC_CLIENT_STATS_H_
  
  #include <string>
  
  #include "quiche/common/platform/api/quiche_client_stats.h"
  
  namespace quic {
  
  //------------------------------------------------------------------------------
  // Enumeration histograms.
  //
  // Sample usage:
  //   // In Chrome, these values are persisted to logs. Entries should not be
  //   // renumbered and numeric values should never be reused.
  //   enum class MyEnum {
  //     FIRST_VALUE = 0,
  //     SECOND_VALUE = 1,
  //     ...
  //     FINAL_VALUE = N,
  //     COUNT
  //   };
  //   QUIC_CLIENT_HISTOGRAM_ENUM("My.Enumeration", MyEnum::SOME_VALUE,
  //   MyEnum::COUNT, "Number of time $foo equals to some enum value");
  //
  // Note: The value in |sample| must be strictly less than |enum_size|.
  
  #define QUIC_CLIENT_HISTOGRAM_ENUM(name, sample, enum_size, docstring) \
    QUICHE_CLIENT_HISTOGRAM_ENUM(name, sample, enum_size, docstring)
  
  //------------------------------------------------------------------------------
  // Histogram for boolean values.
  
  // Sample usage:
  //   QUIC_CLIENT_HISTOGRAM_BOOL("My.Boolean", bool,
  //   "Number of times $foo is true or false");
  #define QUIC_CLIENT_HISTOGRAM_BOOL(name, sample, docstring) \
    QUICHE_CLIENT_HISTOGRAM_BOOL(name, sample, docstring)
  
  //------------------------------------------------------------------------------
  // Timing histograms. These are used for collecting timing data (generally
  // latencies).
  
  // These macros create exponentially sized histograms (lengths of the bucket
  // ranges exponentially increase as the sample range increases). The units for
  // sample and max are unspecified, but they must be the same for one histogram.
  
  // Sample usage:
  //   QUIC_CLIENT_HISTOGRAM_TIMES("Very.Long.Timing.Histogram", time_delta,
  //       QuicTime::Delta::FromSeconds(1), QuicTime::Delta::FromSecond(3600 *
  //       24), 100, "Time spent in doing operation.");
  #define QUIC_CLIENT_HISTOGRAM_TIMES(name, sample, min, max, bucket_count, \
                                      docstring)                            \
    QUICHE_CLIENT_HISTOGRAM_TIMES(name, sample, min, max, bucket_count, docstring)
  
  //------------------------------------------------------------------------------
  // Count histograms. These are used for collecting numeric data.
  
  // These macros default to exponential histograms - i.e. the lengths of the
  // bucket ranges exponentially increase as the sample range increases.
  
  // All of these macros must be called with |name| as a runtime constant.
  
  // Any data outside the range here will be put in underflow and overflow
  // buckets. Min values should be >=1 as emitted 0s will still go into the
  // underflow bucket.
  
  // Sample usage:
  //   UMA_CLIENT_HISTOGRAM_CUSTOM_COUNTS("My.Histogram", 1, 100000000, 100,
  //      "Counters of hitting certian code.");
  
  #define QUIC_CLIENT_HISTOGRAM_COUNTS(name, sample, min, max, bucket_count, \
                                       docstring)                            \
    QUICHE_CLIENT_HISTOGRAM_COUNTS(name, sample, min, max, bucket_count,     \
                                   docstring)
  
  inline void QuicClientSparseHistogram(const std::string& name, int sample) {
    quiche::QuicheClientSparseHistogram(name, sample);
  }
  
  }  // namespace quic
  
  #endif  // QUICHE_QUIC_PLATFORM_API_QUIC_CLIENT_STATS_H_
  