ILIAS  release_7 Revision v7.30-3-g800a261c036
Storage.php
Go to the documentation of this file.
1<?php
2
3/* Copyright (c) 2020 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */
4
5namespace ILIAS\Setup\Metrics;
6
7interface Storage
8{
12 public function store(string $key, Metric $metric) : void;
13
14 // Convenience methods to store the common types of metrics.
15
16 public function storeConfigBool($key, bool $value, string $description = null) : void;
17 public function storeConfigCounter($key, int $value, string $description = null) : void;
18 public function storeConfigGauge($key, $value, string $description = null) : void;
19 public function storeConfigTimestamp($key, \DateTimeImmutable $value, string $description = null) : void;
20 public function storeConfigText($key, string $value, string $description = null) : void;
21
22 public function storeStableBool($key, bool $value, string $description = null) : void;
23 public function storeStableCounter($key, int $value, string $description = null) : void;
24 public function storeStableGauge($key, $value, string $description = null) : void;
25 public function storeStableTimestamp($key, \DateTimeImmutable $value, string $description = null) : void;
26 public function storeStableText($key, string $value, string $description = null) : void;
27
28 public function storeVolatileBool($key, bool $value, string $description = null) : void;
29 public function storeVolatileCounter($key, int $value, string $description = null) : void;
30 public function storeVolatileGauge($key, $value, string $description = null) : void;
31 public function storeVolatileTimestamp($key, \DateTimeImmutable $value, string $description = null) : void;
32 public function storeVolatileText($key, string $value, string $description = null) : void;
33}
An exception for terminatinating execution or to throw for unit testing.
A metric is something we can measure about the system.
Definition: Metric.php:18
storeVolatileText($key, string $value, string $description=null)
storeVolatileGauge($key, $value, string $description=null)
storeStableCounter($key, int $value, string $description=null)
storeConfigCounter($key, int $value, string $description=null)
storeStableText($key, string $value, string $description=null)
storeStableBool($key, bool $value, string $description=null)
storeConfigGauge($key, $value, string $description=null)
storeVolatileCounter($key, int $value, string $description=null)
store(string $key, Metric $metric)
Store some metric in the storage.
storeConfigTimestamp($key, \DateTimeImmutable $value, string $description=null)
storeStableTimestamp($key, \DateTimeImmutable $value, string $description=null)
storeVolatileTimestamp($key, \DateTimeImmutable $value, string $description=null)
storeConfigText($key, string $value, string $description=null)
storeConfigBool($key, bool $value, string $description=null)
storeStableGauge($key, $value, string $description=null)
storeVolatileBool($key, bool $value, string $description=null)