Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F6076751
BaseMetricInterface.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
3 KB
Referenced Files
None
Subscribers
None
BaseMetricInterface.php
View Options
<?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\IBufferingStatsdDataFactory
;
use
Wikimedia\Stats\Sample
;
/**
* Base Metric Interface
*
* Interface for defining a Base Metric.
*
* @author Cole White
* @since 1.41
*/
interface
BaseMetricInterface
{
/**
* @param string $component The component this metric will track.
* @param string $name The Metric Name.
*/
public
function
__construct
(
string
$component
,
string
$name
);
/**
* Records a Metric Sample.
*
* @param Sample $sample
* @return void
*/
public
function
addSample
(
Sample
$sample
):
void
;
/**
* Returns the configured sample rate.
*
* @return float
*/
public
function
getSampleRate
():
float
;
/**
* Sets the sample rate.
*
* @param float $sampleRate
*/
public
function
setSampleRate
(
float
$sampleRate
):
void
;
/**
* Returns subset of samples corresponding to sample rate setting.
*
* @return Sample[]
*/
public
function
getSamples
():
array
;
/**
* Returns a count of samples recorded by the metric.
*
* @return int
*/
public
function
getSampleCount
():
int
;
/**
* Returns the Metric Name
*
* @return string
*/
public
function
getName
():
string
;
/**
* Add a label with key => value.
* Note that the order in which labels are added is significant for StatsD output.
*
* Example:
* ```php
* $statsFactory->withComponent( 'demo' )
* ->getCounter( 'testMetric_total' )
* ->setLabel( 'first', 'foo' )
* ->setLabel( 'second', 'bar' )
* ->setLabel( 'third', 'baz' )
* ->increment();
* ```
* statsd: "mediawiki.demo.testMetric_total.foo.bar.baz"
* prometheus: "mediawiki_demo_testMetric_total{first='foo',second='bar',third='baz'}
*
* @param string $key
* @param string $value
* @return void
*/
public
function
addLabel
(
string
$key
,
string
$value
):
void
;
/**
* Returns array of label keys.
*
* @return string[]
*/
public
function
getLabelKeys
():
array
;
/**
* Returns an array of label values in the order of label keys.
*
* @return string[]
*/
public
function
getLabelValues
():
array
;
/**
* Returns the Metric Component
*
* @return string
*/
public
function
getComponent
():
string
;
/**
* Clears the working labels.
*
* @return void
*/
public
function
clearLabels
():
void
;
/**
* Gets StatsD Data Factory instance or null.
*/
public
function
getStatsdDataFactory
();
/**
* Validates and sets legacy StatsD namespaces.
*
* @param string|string[] $statsdNamespaces
* @return void
*/
public
function
setStatsdNamespaces
(
$statsdNamespaces
):
void
;
/**
* Returns the configured legacy StatsD namespaces.
*
* @return string[]
*/
public
function
getStatsdNamespaces
():
array
;
/**
* StatsD Data Factory instance to copy metrics to.
*
* @param IBufferingStatsdDataFactory $statsdDataFactory
* @return BaseMetricInterface
*/
public
function
withStatsdDataFactory
(
IBufferingStatsdDataFactory
$statsdDataFactory
);
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Oct 5 2026, 09:24 (6 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
58/4e/a2b68832774e2dad9310ed271322
Default Alt Text
BaseMetricInterface.php (3 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment