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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
* @file
*/
declare( strict_types=1 );
namespace Wikimedia\Stats\Metrics;
use Wikimedia\Stats\Exceptions\IllegalOperationException;
use Wikimedia\Stats\Sample;
/**
* Timing Metric Implementation
*
* Timing metrics track duration data which can be broken into histograms.
* They are identified by type "ms".
*
* @author Cole White
* @since 1.38
*/
class TimingMetric implements MetricInterface {
use MetricTrait;
/**
* The StatsD protocol type indicator:
* https://github.com/statsd/statsd/blob/v0.9.0/docs/metric_types.md
* https://docs.datadoghq.com/developers/dogstatsd/datagram_shell/?tab=metrics
*/
private const TYPE_INDICATOR = "ms";
/** @var float|null */
private ?float $startTime = null;
/**
* Starts a timer.
*
* @return void
*/
public function start(): void {
$this->startTime = hrtime( true );
}
/**
* Stops a running timer.
*
* @return void
*/
public function stop(): void {
if ( $this->startTime === null ) {
trigger_error( "Stats: stop() called before start() for metric '{$this->getName()}'", E_USER_WARNING );
return;
}
$this->observeNanoseconds( hrtime( true ) - $this->startTime );
$this->startTime = null;
}
/**
* Records a previously calculated observation in milliseconds.
*
* @param float $milliseconds
* @return void
*/
public function observe( float $milliseconds ): void {
foreach ( $this->baseMetric->getStatsdNamespaces() as $namespace ) {
$this->baseMetric->getStatsdDataFactory()->timing( $namespace, $milliseconds );
}
try {
$this->baseMetric->addSample( new Sample( $this->baseMetric->getLabelValues(), $milliseconds ) );
} catch ( IllegalOperationException $ex ) {
// Log the condition and give the caller something that will absorb calls.
trigger_error( $ex->getMessage(), E_USER_WARNING );
}
}
/**
* Record a previously calculated observation in seconds.
*
* Common usage:
* ```php
* $startTime = microtime( true )
* # work to be measured...
* $metric->observeSeconds( microtime( true ) - $startTime )
* ```
*
* @param float $seconds
* @return void
* @since 1.43
*/
public function observeSeconds( float $seconds ): void {
$this->observe( $seconds * 1000 );
}
/**
* Record a previously calculated observation in nanoseconds.
*
* Common usage:
* ```php
* $startTime = hrtime( true )
* # work to be measured...
* $metric->observeNanoseconds( hrtime( true ) - $startTime )
* ```
* @param float $nanoseconds
* @return void
* @since 1.43
*/
public function observeNanoseconds( float $nanoseconds ): void {
$this->observe( $nanoseconds * 1e-6 );
}
/** @inheritDoc */
public function getTypeIndicator(): string {
return self::TYPE_INDICATOR;
}
}
|
