| // 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_COMMON_PLATFORM_API_QUICHE_CLIENT_STATS_H_ |
| #define QUICHE_COMMON_PLATFORM_API_QUICHE_CLIENT_STATS_H_ |
| |
| #include <string> |
| |
| #include "quiche_platform_impl/quiche_client_stats_impl.h" |
| |
| namespace quiche { |
| |
| //------------------------------------------------------------------------------ |
| // 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 |
| // }; |
| // QUICHE_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 QUICHE_CLIENT_HISTOGRAM_ENUM(name, sample, enum_size, docstring) \ |
| QUICHE_CLIENT_HISTOGRAM_ENUM_IMPL(name, sample, enum_size, docstring) |
| |
| //------------------------------------------------------------------------------ |
| // Histogram for boolean values. |
| |
| // Sample usage: |
| // QUICHE_CLIENT_HISTOGRAM_BOOL("My.Boolean", bool, |
| // "Number of times $foo is true or false"); |
| #define QUICHE_CLIENT_HISTOGRAM_BOOL(name, sample, docstring) \ |
| QUICHE_CLIENT_HISTOGRAM_BOOL_IMPL(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: |
| // QUICHE_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 QUICHE_CLIENT_HISTOGRAM_TIMES(name, sample, min, max, bucket_count, \ |
| docstring) \ |
| QUICHE_CLIENT_HISTOGRAM_TIMES_IMPL(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 certain code."); |
| |
| #define QUICHE_CLIENT_HISTOGRAM_COUNTS(name, sample, min, max, bucket_count, \ |
| docstring) \ |
| QUICHE_CLIENT_HISTOGRAM_COUNTS_IMPL(name, sample, min, max, bucket_count, \ |
| docstring) |
| |
| inline void QuicheClientSparseHistogram(const std::string& name, int sample) { |
| QuicheClientSparseHistogramImpl(name, sample); |
| } |
| |
| } // namespace quiche |
| |
| #endif // QUICHE_COMMON_PLATFORM_API_QUICHE_CLIENT_STATS_H_ |