ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Data Structures | Functions | Variables
ILIAS\Setup\Metrics Namespace Reference

Data Structures

class  ArrayStorage
 
class  CollectedObjective
 Base class to simplify collection of metrics. More...
 
class  Metric
 A metric is something we can measure about the system. More...
 
interface  Storage
 
class  StorageOnPathWrapper
 

Functions

 storeConfigBool (string $key, bool $value, ?string $description=null)
 
 storeConfigCounter (string $key, int $value, ?string $description=null)
 
 storeConfigGauge (string $key, $value, ?string $description=null)
 
 storeConfigTimestamp (string $key, \DateTimeImmutable $value, ?string $description=null)
 
 storeConfigText (string $key, string $value, ?string $description=null)
 
 storeStableBool (string $key, bool $value, ?string $description=null)
 
 storeStableCounter (string $key, int $value, ?string $description=null)
 
 storeStableGauge (string $key, $value, ?string $description=null)
 
 storeStableTimestamp (string $key, \DateTimeImmutable $value, ?string $description=null)
 
 storeStableText (string $key, string $value, ?string $description=null)
 
 storeVolatileBool (string $key, bool $value, ?string $description=null)
 
 storeVolatileCounter (string $key, int $value, ?string $description=null)
 
 storeVolatileGauge (string $key, $value, ?string $description=null)
 
 storeVolatileTimestamp (string $key, \DateTimeImmutable $value, ?string $description=null)
 
 storeVolatileText (string $key, string $value, ?string $description=null)
 

Variables

trait StorageConvenience
 Implements the convenience methods of Storage over Storage::store. More...
 

Function Documentation

◆ storeConfigBool()

ILIAS\Setup\Metrics\storeConfigBool ( string  $key,
bool  $value,
?string  $description = null 
)

Definition at line 32 of file StorageConvenience.php.

32 : void
33 {
34 $this->store(
35 $key,
36 new M(M::STABILITY_CONFIG, M::TYPE_BOOL, $value, $description)
37 );
38 }

◆ storeConfigCounter()

ILIAS\Setup\Metrics\storeConfigCounter ( string  $key,
int  $value,
?string  $description = null 
)

Definition at line 40 of file StorageConvenience.php.

40 : void
41 {
42 $this->store(
43 $key,
44 new M(M::STABILITY_CONFIG, M::TYPE_COUNTER, $value, $description)
45 );
46 }

◆ storeConfigGauge()

ILIAS\Setup\Metrics\storeConfigGauge ( string  $key,
  $value,
?string  $description = null 
)

Definition at line 48 of file StorageConvenience.php.

48 : void
49 {
50 $this->store(
51 $key,
52 new M(M::STABILITY_CONFIG, M::TYPE_GAUGE, $value, $description)
53 );
54 }

◆ storeConfigText()

ILIAS\Setup\Metrics\storeConfigText ( string  $key,
string  $value,
?string  $description = null 
)

Definition at line 64 of file StorageConvenience.php.

64 : void
65 {
66 $this->store(
67 $key,
68 new M(M::STABILITY_CONFIG, M::TYPE_TEXT, $value, $description)
69 );
70 }

◆ storeConfigTimestamp()

ILIAS\Setup\Metrics\storeConfigTimestamp ( string  $key,
\DateTimeImmutable  $value,
?string  $description = null 
)

Definition at line 56 of file StorageConvenience.php.

56 : void
57 {
58 $this->store(
59 $key,
60 new M(M::STABILITY_CONFIG, M::TYPE_TIMESTAMP, $value, $description)
61 );
62 }

◆ storeStableBool()

ILIAS\Setup\Metrics\storeStableBool ( string  $key,
bool  $value,
?string  $description = null 
)

Definition at line 73 of file StorageConvenience.php.

73 : void
74 {
75 $this->store(
76 $key,
77 new M(M::STABILITY_STABLE, M::TYPE_BOOL, $value, $description)
78 );
79 }

◆ storeStableCounter()

ILIAS\Setup\Metrics\storeStableCounter ( string  $key,
int  $value,
?string  $description = null 
)

Definition at line 81 of file StorageConvenience.php.

81 : void
82 {
83 $this->store(
84 $key,
85 new M(M::STABILITY_STABLE, M::TYPE_COUNTER, $value, $description)
86 );
87 }

◆ storeStableGauge()

ILIAS\Setup\Metrics\storeStableGauge ( string  $key,
  $value,
?string  $description = null 
)

Definition at line 89 of file StorageConvenience.php.

89 : void
90 {
91 $this->store(
92 $key,
93 new M(M::STABILITY_STABLE, M::TYPE_GAUGE, $value, $description)
94 );
95 }

◆ storeStableText()

ILIAS\Setup\Metrics\storeStableText ( string  $key,
string  $value,
?string  $description = null 
)

Definition at line 105 of file StorageConvenience.php.

105 : void
106 {
107 $this->store(
108 $key,
109 new M(M::STABILITY_STABLE, M::TYPE_TEXT, $value, $description)
110 );
111 }

◆ storeStableTimestamp()

ILIAS\Setup\Metrics\storeStableTimestamp ( string  $key,
\DateTimeImmutable  $value,
?string  $description = null 
)

Definition at line 97 of file StorageConvenience.php.

97 : void
98 {
99 $this->store(
100 $key,
101 new M(M::STABILITY_STABLE, M::TYPE_TIMESTAMP, $value, $description)
102 );
103 }

◆ storeVolatileBool()

ILIAS\Setup\Metrics\storeVolatileBool ( string  $key,
bool  $value,
?string  $description = null 
)

Definition at line 114 of file StorageConvenience.php.

114 : void
115 {
116 $this->store(
117 $key,
118 new M(M::STABILITY_VOLATILE, M::TYPE_BOOL, $value, $description)
119 );
120 }

◆ storeVolatileCounter()

ILIAS\Setup\Metrics\storeVolatileCounter ( string  $key,
int  $value,
?string  $description = null 
)

Definition at line 122 of file StorageConvenience.php.

122 : void
123 {
124 $this->store(
125 $key,
126 new M(M::STABILITY_VOLATILE, M::TYPE_COUNTER, $value, $description)
127 );
128 }

◆ storeVolatileGauge()

ILIAS\Setup\Metrics\storeVolatileGauge ( string  $key,
  $value,
?string  $description = null 
)

Definition at line 130 of file StorageConvenience.php.

130 : void
131 {
132 $this->store(
133 $key,
134 new M(M::STABILITY_VOLATILE, M::TYPE_GAUGE, $value, $description)
135 );
136 }

◆ storeVolatileText()

ILIAS\Setup\Metrics\storeVolatileText ( string  $key,
string  $value,
?string  $description = null 
)

Definition at line 146 of file StorageConvenience.php.

146 : void
147 {
148 $this->store(
149 $key,
150 new M(M::STABILITY_VOLATILE, M::TYPE_TEXT, $value, $description)
151 );
152 }

◆ storeVolatileTimestamp()

ILIAS\Setup\Metrics\storeVolatileTimestamp ( string  $key,
\DateTimeImmutable  $value,
?string  $description = null 
)

Definition at line 138 of file StorageConvenience.php.

138 : void
139 {
140 $this->store(
141 $key,
142 new M(M::STABILITY_VOLATILE, M::TYPE_TIMESTAMP, $value, $description)
143 );
144 }

Variable Documentation

◆ StorageConvenience

trait ILIAS::Setup::Metrics\StorageConvenience
Initial value:
{
abstract public function store(string $key, M $metric): void

Implements the convenience methods of Storage over Storage::store.

Definition at line 28 of file StorageConvenience.php.