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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
<?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 InvalidArgumentException;
use Wikimedia\Stats\Exceptions\IllegalOperationException;
use Wikimedia\Stats\IBufferingStatsdDataFactory;
use Wikimedia\Stats\Sample;
use Wikimedia\Stats\StatsUtils;
/**
* Base Metric Implementation V1
*
* Implements shared Metric functionality:
* * Label validation and handling
* * Sample rate validation and handling
* * Sample generation
* * Common properties
* * StatsD transition support
*
* @author Cole White
* @since 1.41
*/
class BaseMetric implements BaseMetricInterface {
private float $sampleRate = StatsUtils::DEFAULT_SAMPLE_RATE;
private string $name;
private string $component;
/** @var array key-value pairs of metric-specific labels */
private array $workingLabels = [];
/** @var string[] ordered array of label keys */
private array $labelKeys = [];
/** @var Sample[] */
private array $samples = [];
private ?IBufferingStatsdDataFactory $statsdDataFactory = null;
/** @var string[] */
private array $statsdNamespaces = [];
/** @inheritDoc */
public function __construct( string $component, string $name ) {
$this->component = $component;
$this->name = StatsUtils::normalizeString( $name );
}
/** @inheritDoc */
public function addSample( Sample $sample ): void {
$this->samples[] = $sample;
}
/** @inheritDoc */
public function setSampleRate( float $sampleRate ): void {
if ( $this->hasSamples() ) {
throw new IllegalOperationException(
"Stats: Cannot change sample rate on metric with recorded samples." );
}
StatsUtils::validateNewSampleRate( $sampleRate );
$this->sampleRate = $sampleRate;
}
/** @inheritDoc */
public function getName(): string {
return $this->name;
}
/** @inheritDoc */
public function getSampleRate(): float {
return $this->sampleRate;
}
/** @inheritDoc */
public function getSamples(): array {
return StatsUtils::getFilteredSamples( $this->sampleRate, $this->samples );
}
/** @inheritDoc */
public function getSampleCount(): int {
return count( $this->samples );
}
/** @inheritDoc */
public function addLabel( string $key, string $value ): void {
StatsUtils::validateLabelValue( $value );
$key = StatsUtils::normalizeString( $key );
StatsUtils::validateLabelKey( $key );
$this->addLabelKey( $key );
$this->workingLabels[$key] = StatsUtils::normalizeString( $value );
}
/** @inheritDoc */
public function getStatsdDataFactory() {
return $this->statsdDataFactory;
}
/** @inheritDoc */
public function withStatsdDataFactory( $statsdDataFactory ): BaseMetric {
$this->statsdDataFactory = $statsdDataFactory;
return $this;
}
/** @inheritDoc */
public function setStatsdNamespaces( $statsdNamespaces ): void {
if ( $this->statsdDataFactory === null ) {
return;
}
$statsdNamespaces = is_array( $statsdNamespaces ) ? $statsdNamespaces : [ $statsdNamespaces ];
foreach ( $statsdNamespaces as $namespace ) {
if ( $namespace === '' ) {
throw new InvalidArgumentException( "Stats: StatsD namespace cannot be empty." );
}
if ( !is_string( $namespace ) ) {
throw new InvalidArgumentException( "Stats: StatsD namespace must be a string." );
}
}
$this->statsdNamespaces = $statsdNamespaces;
}
/** @inheritDoc */
public function getStatsdNamespaces(): array {
return $this->statsdNamespaces;
}
/**
* Registers a label key
*
* @param string $key
* @return void
*/
private function addLabelKey( string $key ): void {
if ( in_array( $key, $this->labelKeys, true ) ) {
return; // key already exists
}
if ( $this->hasSamples() ) {
throw new IllegalOperationException(
"Stats: Cannot add labels to a metric containing samples for '" . $this->name . "'"
);
}
$this->labelKeys[] = $key;
}
/** @return string[] */
public function getLabelKeys(): array {
return $this->labelKeys;
}
/**
* Get label values in the order of labelKeys.
*
* @return string[]
*/
public function getLabelValues(): array {
$output = [];
# make sure all labels are accounted for
if ( array_diff( $this->labelKeys, array_keys( $this->workingLabels ) ) ) {
throw new IllegalOperationException(
"Stats: Cannot associate label keys with label values: "
. "Not all initialized labels have an assigned value." );
}
foreach ( $this->labelKeys as $labelKey ) {
$output[] = $this->workingLabels[$labelKey];
}
return $output;
}
/** @inheritDoc */
public function clearLabels(): void {
$this->workingLabels = [];
}
/** @inheritDoc */
public function getComponent(): string {
return $this->component;
}
private function hasSamples(): bool {
return $this->samples !== [];
}
}
|
