Opcache.php$6 ➔ wasted() - Code Metrics - Inspection of "Add status exporters for fpm and opcache" - krenor/prometheus-client - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( dbd74f...a60ca0 )

by Stan

created 2019-12-14 21:04 UTC

Opcache.php$6 ➔ wasted() A

↳ Parent: Opcache

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
c	0
b	0
f	0
dl	0
loc	9
ccs	3
cts	3
cp	1
crap	1
rs	9.9666

<?php

namespace Krenor\Prometheus\Exporter;

use Krenor\Prometheus\Metrics\Gauge;
use Krenor\Prometheus\Metrics\Counter;
use Krenor\Prometheus\Contracts\Exporter;
use Krenor\Prometheus\MetricFamilySamples;

class Opcache extends Exporter
{
    /**
     * @return MetricFamilySamples
     */
    public function enabled(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'enabled';
                protected $description = 'Indicator if opcache is enabled.';
            },
            $this->data['opcache_enabled']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function oom(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'out_of_memory';
                protected $description = 'Indicator if cache is full.';
            },
            $this->data['cache_full']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function restarts(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'restart_pending';
                protected $description = 'Indicator if a restart is pending';
            },
            $this->data['restart_pending']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function restarting(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'is_restarting';
                protected $description = 'Indicator if a restart is in progress.';
            },
            $this->data['restart_in_progress']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function consumed(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'memory_used_bytes';
                protected $description = 'The amount of memory consumed.';
            },
            $this->data['memory_usage']['used_memory']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function free(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'memory_free_bytes';
                protected $description = 'The amount of memory available for consumption.';
            },
            $this->data['memory_usage']['free_memory']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function wasted(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'memory_wasted_bytes';
                protected $description = 'The amount of memory wasted.';
            },
            $this->data['memory_usage']['wasted_memory']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function wastePercentage(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'memory_wasted_percent';
                protected $description = 'The percentage of currently wasted memory.';
            },
            $this->data['memory_usage']['current_wasted_percentage']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function stringsBuffer(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Counter {
                protected $namespace = 'php_opcache';
                protected $name = 'strings_buffer_size_bytes';
                protected $description = 'The buffer size of interned strings.';
            },
            $this->data['interned_strings_usage']['buffer_size']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function stringsMemoryConsumed(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'strings_memory_used_bytes';
                protected $description = 'The amount of memory used by interned strings.';
            },
            $this->data['interned_strings_usage']['used_memory']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function stringsMemoryFree(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'strings_memory_free_bytes';
                protected $description = 'The amount of memory available for interned strings.';
            },
            $this->data['interned_strings_usage']['free_memory']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function strings(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Counter {
                protected $namespace = 'php_opcache';
                protected $name = 'strings_count';
                protected $description = 'The amount of used interned strings';
            },
            $this->data['interned_strings_usage']['number_of_strings']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function scripts(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Counter {
                protected $namespace = 'php_opcache';
                protected $name = 'cache_scripts_count';
                protected $description = 'The amount of cached scripts.';
            },
            $this->data['opcache_statistics']['num_cached_scripts']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function keys(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Counter {
                protected $namespace = 'php_opcache';
                protected $name = 'cache_keys_count';
                protected $description = 'The amount of hash table keys.';
            },
            $this->data['opcache_statistics']['num_cached_keys']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function maxCachedKeys(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'cache_max_keys_count';
                protected $description = 'The maximum amount of hash table keys.';
            },
            $this->data['opcache_statistics']['max_cached_keys']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function hits(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Counter {
                protected $namespace = 'php_opcache';
                protected $name = 'cache_hits_count';
                protected $description = 'The amount of cache hits.';
            },
            $this->data['opcache_statistics']['hits']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function started(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Counter {
                protected $namespace = 'php_opcache';
                protected $name = 'started';
                protected $description = 'The timestamp opcache has been started.';
            },
            $this->data['opcache_statistics']['start_time']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function restart(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Counter {
                protected $namespace = 'php_opcache';
                protected $name = 'last_restart';
                protected $description = 'The last timestamp opcache has been restarted.';
            },
            $this->data['opcache_statistics']['last_restart_time']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function oomRestarts(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Counter {
                protected $namespace = 'php_opcache';
                protected $name = 'restarts_oom_count';
                protected $description = 'The amount of out of memory restarts.';
            },
            $this->data['opcache_statistics']['oom_restarts']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function hashRestarts(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Counter {
                protected $namespace = 'php_opcache';
                protected $name = 'restarts_hash_count';
                protected $description = 'The amount of hash table overflow restarts.';
            },
            $this->data['opcache_statistics']['hash_restarts']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function manualRestarts(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Counter {
                protected $namespace = 'php_opcache';
                protected $name = 'restarts_manual_count';
                protected $description = 'The amount of manual restarts.';
            },
            $this->data['opcache_statistics']['manual_restarts']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function misses(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Counter {
                protected $namespace = 'php_opcache';
                protected $name = 'cache_misses_count';
                protected $description = 'The amount of cache misses.';
            },
            $this->data['opcache_statistics']['misses']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function blacklistMisses(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Counter {
                protected $namespace = 'php_opcache';
                protected $name = 'cache_blacklist_misses_count';
                protected $description = 'The amount of blacklist cache misses.';
            },
            $this->data['opcache_statistics']['blacklist_misses']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function blacklistMissRatio(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'cache_blacklist_misses_percent';
                protected $description = 'The percentage of blacklist cache misses. ';
            },
            $this->data['opcache_statistics']['blacklist_miss_ratio']
        );
    }

    /**
     * @return MetricFamilySamples
     */
    public function hitRatio(): MetricFamilySamples
    {
        return $this->sampled(
            new class extends Gauge {
                protected $namespace = 'php_opcache';
                protected $name = 'cache_hit_percent';
                protected $description = 'The percentage of cache hits.';
            },
            $this->data['opcache_statistics']['opcache_hit_rate']
        );
    }
}


1		<?php
2
3		namespace Krenor\Prometheus\Exporter;
4
5		use Krenor\Prometheus\Metrics\Gauge;
6		use Krenor\Prometheus\Metrics\Counter;
7		use Krenor\Prometheus\Contracts\Exporter;
8		use Krenor\Prometheus\MetricFamilySamples;
9
10		class Opcache extends Exporter
11		{
12		/**
13		* @return MetricFamilySamples
14		*/
15	1	public function enabled(): MetricFamilySamples
16		{
17	1	return $this->sampled(
18		new class extends Gauge {
19		protected $namespace = 'php_opcache';
20		protected $name = 'enabled';
21		protected $description = 'Indicator if opcache is enabled.';
22		},
23	1	$this->data['opcache_enabled']
24		);
25		}
26
27		/**
28		* @return MetricFamilySamples
29		*/
30	1	public function oom(): MetricFamilySamples
31		{
32	1	return $this->sampled(
33		new class extends Gauge {
34		protected $namespace = 'php_opcache';
35		protected $name = 'out_of_memory';
36		protected $description = 'Indicator if cache is full.';
37		},
38	1	$this->data['cache_full']
39		);
40		}
41
42		/**
43		* @return MetricFamilySamples
44		*/
45	1	public function restarts(): MetricFamilySamples
46		{
47	1	return $this->sampled(
48		new class extends Gauge {
49		protected $namespace = 'php_opcache';
50		protected $name = 'restart_pending';
51		protected $description = 'Indicator if a restart is pending';
52		},
53	1	$this->data['restart_pending']
54		);
55		}
56
57		/**
58		* @return MetricFamilySamples
59		*/
60	1	public function restarting(): MetricFamilySamples
61		{
62	1	return $this->sampled(
63		new class extends Gauge {
64		protected $namespace = 'php_opcache';
65		protected $name = 'is_restarting';
66		protected $description = 'Indicator if a restart is in progress.';
67		},
68	1	$this->data['restart_in_progress']
69		);
70		}
71
72		/**
73		* @return MetricFamilySamples
74		*/
75	1	public function consumed(): MetricFamilySamples
76		{
77	1	return $this->sampled(
78		new class extends Gauge {
79		protected $namespace = 'php_opcache';
80		protected $name = 'memory_used_bytes';
81		protected $description = 'The amount of memory consumed.';
82		},
83	1	$this->data['memory_usage']['used_memory']
84		);
85		}
86
87		/**
88		* @return MetricFamilySamples
89		*/
90	1	public function free(): MetricFamilySamples
91		{
92	1	return $this->sampled(
93		new class extends Gauge {
94		protected $namespace = 'php_opcache';
95		protected $name = 'memory_free_bytes';
96		protected $description = 'The amount of memory available for consumption.';
97		},
98	1	$this->data['memory_usage']['free_memory']
99		);
100		}
101
102		/**
103		* @return MetricFamilySamples
104		*/
105	1	public function wasted(): MetricFamilySamples
106		{
107	1	return $this->sampled(
108		new class extends Gauge {
109		protected $namespace = 'php_opcache';
110		protected $name = 'memory_wasted_bytes';
111		protected $description = 'The amount of memory wasted.';
112		},
113	1	$this->data['memory_usage']['wasted_memory']
114		);
115		}
116
117		/**
118		* @return MetricFamilySamples
119		*/
120	1	public function wastePercentage(): MetricFamilySamples
121		{
122	1	return $this->sampled(
123		new class extends Gauge {
124		protected $namespace = 'php_opcache';
125		protected $name = 'memory_wasted_percent';
126		protected $description = 'The percentage of currently wasted memory.';
127		},
128	1	$this->data['memory_usage']['current_wasted_percentage']
129		);
130		}
131
132		/**
133		* @return MetricFamilySamples
134		*/
135	1	public function stringsBuffer(): MetricFamilySamples
136		{
137	1	return $this->sampled(
138		new class extends Counter {
139		protected $namespace = 'php_opcache';
140		protected $name = 'strings_buffer_size_bytes';
141		protected $description = 'The buffer size of interned strings.';
142		},
143	1	$this->data['interned_strings_usage']['buffer_size']
144		);
145		}
146
147		/**
148		* @return MetricFamilySamples
149		*/
150	1	public function stringsMemoryConsumed(): MetricFamilySamples
151		{
152	1	return $this->sampled(
153		new class extends Gauge {
154		protected $namespace = 'php_opcache';
155		protected $name = 'strings_memory_used_bytes';
156		protected $description = 'The amount of memory used by interned strings.';
157		},
158	1	$this->data['interned_strings_usage']['used_memory']
159		);
160		}
161
162		/**
163		* @return MetricFamilySamples
164		*/
165	1	public function stringsMemoryFree(): MetricFamilySamples
166		{
167	1	return $this->sampled(
168		new class extends Gauge {
169		protected $namespace = 'php_opcache';
170		protected $name = 'strings_memory_free_bytes';
171		protected $description = 'The amount of memory available for interned strings.';
172		},
173	1	$this->data['interned_strings_usage']['free_memory']
174		);
175		}
176
177		/**
178		* @return MetricFamilySamples
179		*/
180	1	public function strings(): MetricFamilySamples
181		{
182	1	return $this->sampled(
183		new class extends Counter {
184		protected $namespace = 'php_opcache';
185		protected $name = 'strings_count';
186		protected $description = 'The amount of used interned strings';
187		},
188	1	$this->data['interned_strings_usage']['number_of_strings']
189		);
190		}
191
192		/**
193		* @return MetricFamilySamples
194		*/
195	1	public function scripts(): MetricFamilySamples
196		{
197	1	return $this->sampled(
198		new class extends Counter {
199		protected $namespace = 'php_opcache';
200		protected $name = 'cache_scripts_count';
201		protected $description = 'The amount of cached scripts.';
202		},
203	1	$this->data['opcache_statistics']['num_cached_scripts']
204		);
205		}
206
207		/**
208		* @return MetricFamilySamples
209		*/
210	1	public function keys(): MetricFamilySamples
211		{
212	1	return $this->sampled(
213		new class extends Counter {
214		protected $namespace = 'php_opcache';
215		protected $name = 'cache_keys_count';
216		protected $description = 'The amount of hash table keys.';
217		},
218	1	$this->data['opcache_statistics']['num_cached_keys']
219		);
220		}
221
222		/**
223		* @return MetricFamilySamples
224		*/
225	1	public function maxCachedKeys(): MetricFamilySamples
226		{
227	1	return $this->sampled(
228		new class extends Gauge {
229		protected $namespace = 'php_opcache';
230		protected $name = 'cache_max_keys_count';
231		protected $description = 'The maximum amount of hash table keys.';
232		},
233	1	$this->data['opcache_statistics']['max_cached_keys']
234		);
235		}
236
237		/**
238		* @return MetricFamilySamples
239		*/
240	1	public function hits(): MetricFamilySamples
241		{
242	1	return $this->sampled(
243		new class extends Counter {
244		protected $namespace = 'php_opcache';
245		protected $name = 'cache_hits_count';
246		protected $description = 'The amount of cache hits.';
247		},
248	1	$this->data['opcache_statistics']['hits']
249		);
250		}
251
252		/**
253		* @return MetricFamilySamples
254		*/
255	1	public function started(): MetricFamilySamples
256		{
257	1	return $this->sampled(
258		new class extends Counter {
259		protected $namespace = 'php_opcache';
260		protected $name = 'started';
261		protected $description = 'The timestamp opcache has been started.';
262		},
263	1	$this->data['opcache_statistics']['start_time']
264		);
265		}
266
267		/**
268		* @return MetricFamilySamples
269		*/
270	1	public function restart(): MetricFamilySamples
271		{
272	1	return $this->sampled(
273		new class extends Counter {
274		protected $namespace = 'php_opcache';
275		protected $name = 'last_restart';
276		protected $description = 'The last timestamp opcache has been restarted.';
277		},
278	1	$this->data['opcache_statistics']['last_restart_time']
279		);
280		}
281
282		/**
283		* @return MetricFamilySamples
284		*/
285	1	public function oomRestarts(): MetricFamilySamples
286		{
287	1	return $this->sampled(
288		new class extends Counter {
289		protected $namespace = 'php_opcache';
290		protected $name = 'restarts_oom_count';
291		protected $description = 'The amount of out of memory restarts.';
292		},
293	1	$this->data['opcache_statistics']['oom_restarts']
294		);
295		}
296
297		/**
298		* @return MetricFamilySamples
299		*/
300	1	public function hashRestarts(): MetricFamilySamples
301		{
302	1	return $this->sampled(
303		new class extends Counter {
304		protected $namespace = 'php_opcache';
305		protected $name = 'restarts_hash_count';
306		protected $description = 'The amount of hash table overflow restarts.';
307		},
308	1	$this->data['opcache_statistics']['hash_restarts']
309		);
310		}
311
312		/**
313		* @return MetricFamilySamples
314		*/
315	1	public function manualRestarts(): MetricFamilySamples
316		{
317	1	return $this->sampled(
318		new class extends Counter {
319		protected $namespace = 'php_opcache';
320		protected $name = 'restarts_manual_count';
321		protected $description = 'The amount of manual restarts.';
322		},
323	1	$this->data['opcache_statistics']['manual_restarts']
324		);
325		}
326
327		/**
328		* @return MetricFamilySamples
329		*/
330	1	public function misses(): MetricFamilySamples
331		{
332	1	return $this->sampled(
333		new class extends Counter {
334		protected $namespace = 'php_opcache';
335		protected $name = 'cache_misses_count';
336		protected $description = 'The amount of cache misses.';
337		},
338	1	$this->data['opcache_statistics']['misses']
339		);
340		}
341
342		/**
343		* @return MetricFamilySamples
344		*/
345	1	public function blacklistMisses(): MetricFamilySamples
346		{
347	1	return $this->sampled(
348		new class extends Counter {
349		protected $namespace = 'php_opcache';
350		protected $name = 'cache_blacklist_misses_count';
351		protected $description = 'The amount of blacklist cache misses.';
352		},
353	1	$this->data['opcache_statistics']['blacklist_misses']
354		);
355		}
356
357		/**
358		* @return MetricFamilySamples
359		*/
360	1	public function blacklistMissRatio(): MetricFamilySamples
361		{
362	1	return $this->sampled(
363		new class extends Gauge {
364		protected $namespace = 'php_opcache';
365		protected $name = 'cache_blacklist_misses_percent';
366		protected $description = 'The percentage of blacklist cache misses. ';
367		},
368	1	$this->data['opcache_statistics']['blacklist_miss_ratio']
369		);
370		}
371
372		/**
373		* @return MetricFamilySamples
374		*/
375	1	public function hitRatio(): MetricFamilySamples
376		{
377	1	return $this->sampled(
378		new class extends Gauge {
379		protected $namespace = 'php_opcache';
380		protected $name = 'cache_hit_percent';
381		protected $description = 'The percentage of cache hits.';
382		},
383	1	$this->data['opcache_statistics']['opcache_hit_rate']
384		);
385		}
386		}
387

krenor / prometheus-client

Push — develop ( dbd74f...a60ca0 )

Opcache.php$6 ➔ wasted() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like