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
|
<?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 Psr\Log\LoggerInterface;
use Wikimedia\Stats\Exceptions\IllegalOperationException;
/**
* Implementation code common to all metric types.
*
* @internal
* @since 1.43
*/
trait MetricTrait {
/** @var BaseMetricInterface */
private BaseMetricInterface $baseMetric;
/** @var LoggerInterface */
private LoggerInterface $logger;
/** @inheritDoc */
public function __construct( $baseMetric, $logger ) {
$this->baseMetric = $baseMetric;
$this->logger = $logger;
}
/** @inheritDoc */
public function getName(): string {
return $this->baseMetric->getName();
}
/** @inheritDoc */
public function getComponent(): string {
return $this->baseMetric->getComponent();
}
/** @inheritDoc */
public function getSamples(): array {
return $this->baseMetric->getSamples();
}
/** @inheritDoc */
public function getSampleCount(): int {
return $this->baseMetric->getSampleCount();
}
/** @inheritDoc */
public function getSampleRate(): float {
return $this->baseMetric->getSampleRate();
}
/** @inheritDoc */
public function setSampleRate( float $sampleRate ) {
try {
$this->baseMetric->setSampleRate( $sampleRate );
} catch ( IllegalOperationException | InvalidArgumentException $ex ) {
// Log the condition and give the caller something that will absorb calls.
trigger_error( $ex->getMessage(), E_USER_WARNING );
return new NullMetric;
}
return $this;
}
/** @inheritDoc */
public function getLabelKeys(): array {
return $this->baseMetric->getLabelKeys();
}
/** @inheritDoc */
public function setLabel( string $key, string $value ) {
try {
$this->baseMetric->addLabel( $key, $value );
} catch ( IllegalOperationException | InvalidArgumentException $ex ) {
// Log the condition and give the caller something that will absorb calls.
trigger_error( $ex->getMessage(), E_USER_WARNING );
return new NullMetric;
}
return $this;
}
/** @inheritDoc */
public function setLabels( array $labels ) {
try {
foreach ( $labels as $key => $value ) {
$this->baseMetric->addLabel( $key, $value );
}
} catch ( IllegalOperationException | InvalidArgumentException $ex ) {
// Log the condition and give the caller something that will absorb calls.
trigger_error( $ex->getMessage(), E_USER_WARNING );
return new NullMetric;
}
return $this;
}
/** @inheritDoc */
public function copyToStatsdAt( $statsdNamespaces ) {
try {
$this->baseMetric->setStatsdNamespaces( $statsdNamespaces );
} catch ( InvalidArgumentException $ex ) {
// Log the condition and give the caller something that will absorb calls.
trigger_error( $ex->getMessage(), E_USER_WARNING );
return new NullMetric;
}
return $this;
}
/** @inheritDoc */
public function fresh(): self {
$this->baseMetric->clearLabels();
return $this;
}
}
|
