1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_glean_GleanTimingDistribution_h
#define mozilla_glean_GleanTimingDistribution_h
#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/glean/bindings/DistributionData.h"
#include "mozilla/glean/bindings/GleanMetric.h"
#include "mozilla/Maybe.h"
#include "mozilla/Result.h"
#include "mozilla/TimeStamp.h"
#include "nsTArray.h"
namespace mozilla::dom {
struct GleanDistributionData;
} // namespace mozilla::dom
namespace mozilla::glean {
// Forward declaration to make the friend class below work.
class GleanTimingDistribution;
namespace impl {
class TimingDistributionMetric {
public:
constexpr explicit TimingDistributionMetric(uint32_t aId) : mId(aId) {}
/*
* Starts tracking time for the provided metric.
*
* @returns A unique TimerId for the new timer
*/
TimerId Start() const;
/*
* Stops tracking time for the provided metric and associated timer id.
*
* Adds a count to the corresponding bucket in the timing distribution.
* This will record an error if no `Start` was called on this TimerId or
* if this TimerId was used to call `Cancel`.
*
* @param aId The TimerId to associate with this timing. This allows for
* concurrent timing of events associated with different ids.
*/
void StopAndAccumulate(const TimerId&& aId) const;
/*
* Adds a duration sample to a timing distribution metric.
*
* Adds a count to the corresponding bucket in the timing distribution.
* Prefer Start() and StopAndAccumulate() where possible.
* Users of this API are responsible for ensuring the timing source used
* to calculate the TimeDuration is monotonic and consistent accross
* platforms.
*
* NOTE: Negative durations are not handled and will saturate to INT64_MAX
* nanoseconds.
*
* @param aDuration The duration of the sample to add to the distribution.
*/
void AccumulateRawDuration(const TimeDuration& aDuration) const;
/*
* Aborts a previous `Start` call. No error is recorded if no `Start` was
* called.
*
* @param aId The TimerId whose `Start` you wish to abort.
*/
void Cancel(const TimerId&& aId) const;
/**
* **Test-only API**
*
* Gets the currently stored value as a DistributionData.
*
* This function will attempt to await the last parent-process task (if any)
* writing to the the metric's storage engine before returning a value.
* This function will not wait for data from child processes.
*
* This doesn't clear the stored value.
* Parent process only. Panics in child processes.
*
* @param aPingName The (optional) name of the ping to retrieve the metric
* for. Defaults to the first value in `send_in_pings`.
*
* @return value of the stored metric, or Nothing() if there is no value.
*/
Result<Maybe<DistributionData>, nsCString> TestGetValue(
const nsACString& aPingName = nsCString()) const;
class MOZ_RAII AutoTimer {
public:
void Cancel();
~AutoTimer();
private:
AutoTimer(uint32_t aMetricId, TimerId aTimerId)
: mMetricId(aMetricId), mTimerId(aTimerId) {}
AutoTimer(AutoTimer& aOther) = delete;
const uint32_t mMetricId;
TimerId mTimerId;
friend class TimingDistributionMetric;
};
AutoTimer Measure() const;
private:
const uint32_t mId;
friend class mozilla::glean::GleanTimingDistribution;
};
} // namespace impl
class GleanTimingDistribution final : public GleanMetric {
public:
explicit GleanTimingDistribution(uint64_t aId, nsISupports* aParent)
: GleanMetric(aParent), mTimingDist(aId) {}
virtual JSObject* WrapObject(
JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override final;
uint64_t Start();
void StopAndAccumulate(uint64_t aId);
void Cancel(uint64_t aId);
void AccumulateSamples(const nsTArray<int64_t>& aSamples);
void AccumulateSingleSample(int64_t aSample);
void TestGetValue(const nsACString& aPingName,
dom::Nullable<dom::GleanDistributionData>& aRetval,
ErrorResult& aRv);
void TestAccumulateRawMillis(uint64_t aSample);
private:
virtual ~GleanTimingDistribution() = default;
const impl::TimingDistributionMetric mTimingDist;
};
} // namespace mozilla::glean
#endif /* mozilla_glean_GleanTimingDistribution_h */
|
