better-prometheus

danog\BetterPrometheus\BetterCollectorRegistry

Back to index

Author: Daniil Gentili [email protected]

A better collector registry.

Properties

• $storageAdapter: Prometheus\Storage\Adapter

Method list:

• __construct(\Prometheus\Storage\Adapter $storageAdapter, bool $registerDefaultMetrics = true)
• wipeStorage(): void
• getMetricFamilySamples(bool $sortMetrics = true): list<\Prometheus\MetricFamilySamples>
• registerGauge(string $namespace, string $name, string $help, array<string, string> $labels = []): \danog\BetterPrometheus\BetterGauge
• getGauge(string $namespace, string $name): \danog\BetterPrometheus\BetterGauge
• getOrRegisterGauge(string $namespace, string $name, string $help, array<string, string> $labels = []): \danog\BetterPrometheus\BetterGauge
• registerCounter(string $namespace, string $name, string $help, array<string, string> $labels = []): \danog\BetterPrometheus\BetterCounter
• getCounter(string $namespace, string $name): \danog\BetterPrometheus\BetterCounter
• getOrRegisterCounter(string $namespace, string $name, string $help, array<string, string> $labels = []): \danog\BetterPrometheus\BetterCounter
• registerHistogram(string $namespace, string $name, string $help, array<string, string> $labels = [], (non-empty-list<float>|null) $buckets = NULL): \danog\BetterPrometheus\BetterHistogram
• getHistogram(string $namespace, string $name): \danog\BetterPrometheus\BetterHistogram
• getOrRegisterHistogram(string $namespace, string $name, string $help, array<string, string> $labels = [], (non-empty-list<float>|null) $buckets = NULL): \danog\BetterPrometheus\BetterHistogram
• registerSummary(string $namespace, string $name, string $help, array<string, string> $labels = [], int $maxAgeSeconds = 600, (non-empty-list<float>|null) $quantiles = NULL): \danog\BetterPrometheus\BetterSummary
• getSummary(string $namespace, string $name): \danog\BetterPrometheus\BetterSummary
• getOrRegisterSummary(string $namespace, string $name, string $help, array<string, string> $labels = [], int $maxAgeSeconds = 600, (non-empty-list<float>|null) $quantiles = NULL): \danog\BetterPrometheus\BetterSummary

Methods:

__construct(\Prometheus\Storage\Adapter $storageAdapter, bool $registerDefaultMetrics = true)

CollectorRegistry constructor.

Parameters:

• $storageAdapter: \Prometheus\Storage\Adapter
• $registerDefaultMetrics: bool

See also:

• \Prometheus\Storage\Adapter

wipeStorage(): void

Removes all previously stored metrics from underlying storage adapter.

getMetricFamilySamples(bool $sortMetrics = true): list<\Prometheus\MetricFamilySamples>

Parameters:

• $sortMetrics: bool

See also:

• \Prometheus\MetricFamilySamples

registerGauge(string $namespace, string $name, string $help, array<string, string> $labels = []): \danog\BetterPrometheus\BetterGauge

Parameters:

• $namespace: string e.g. cms
• $name: string e.g. duration_seconds
• $help: string e.g. The duration something took in seconds.
• $labels: array<string, string> e.g. [‘controller’ => ‘someController’, ‘action’ => ‘someAction’]

See also:

• \danog\BetterPrometheus\BetterGauge: A better prometheus gauge.

getGauge(string $namespace, string $name): \danog\BetterPrometheus\BetterGauge

Parameters:

• $namespace: string
• $name: string

See also:

• \danog\BetterPrometheus\BetterGauge: A better prometheus gauge.

getOrRegisterGauge(string $namespace, string $name, string $help, array<string, string> $labels = []): \danog\BetterPrometheus\BetterGauge

Parameters:

• $namespace: string e.g. cms
• $name: string e.g. duration_seconds
• $help: string e.g. The duration something took in seconds.
• $labels: array<string, string> e.g. [‘controller’ => ‘someController’, ‘action’ => ‘someAction’]

See also:

• \danog\BetterPrometheus\BetterGauge: A better prometheus gauge.

registerCounter(string $namespace, string $name, string $help, array<string, string> $labels = []): \danog\BetterPrometheus\BetterCounter

Parameters:

• $namespace: string e.g. cms
• $name: string e.g. requests
• $help: string e.g. The number of requests made.
• $labels: array<string, string> e.g. [‘controller’ => ‘someController’, ‘action’ => ‘someAction’]

See also:

• \danog\BetterPrometheus\BetterCounter: A better prometheus counter.

getCounter(string $namespace, string $name): \danog\BetterPrometheus\BetterCounter

Parameters:

• $namespace: string
• $name: string

See also:

• \danog\BetterPrometheus\BetterCounter: A better prometheus counter.

getOrRegisterCounter(string $namespace, string $name, string $help, array<string, string> $labels = []): \danog\BetterPrometheus\BetterCounter

Parameters:

• $namespace: string e.g. cms
• $name: string e.g. requests
• $help: string e.g. The number of requests made.
• $labels: array<string, string> e.g. [‘controller’ => ‘someController’, ‘action’ => ‘someAction’]

See also:

• \danog\BetterPrometheus\BetterCounter: A better prometheus counter.

registerHistogram(string $namespace, string $name, string $help, array<string, string> $labels = [], (non-empty-list<float>|null) $buckets = NULL): \danog\BetterPrometheus\BetterHistogram

Parameters:

• $namespace: string e.g. cms
• $name: string e.g. duration_seconds
• $help: string e.g. A histogram of the duration in seconds.
• $labels: array<string, string> e.g. [‘controller’ => ‘someController’, ‘action’ => ‘someAction’]
• $buckets: (non-empty-list<float>|null) e.g. [100, 200, 300]

See also:

• non-empty-list
• \danog\BetterPrometheus\BetterHistogram: A better prometheus histogram.

getHistogram(string $namespace, string $name): \danog\BetterPrometheus\BetterHistogram

Parameters:

• $namespace: string
• $name: string

See also:

• \danog\BetterPrometheus\BetterHistogram: A better prometheus histogram.

getOrRegisterHistogram(string $namespace, string $name, string $help, array<string, string> $labels = [], (non-empty-list<float>|null) $buckets = NULL): \danog\BetterPrometheus\BetterHistogram

Parameters:

• $namespace: string e.g. cms
• $name: string e.g. duration_seconds
• $help: string e.g. A histogram of the duration in seconds.
• $labels: array<string, string> e.g. [‘controller’ => ‘someController’, ‘action’ => ‘someAction’]
• $buckets: (non-empty-list<float>|null) e.g. [100, 200, 300]

See also:

• non-empty-list
• \danog\BetterPrometheus\BetterHistogram: A better prometheus histogram.

registerSummary(string $namespace, string $name, string $help, array<string, string> $labels = [], int $maxAgeSeconds = 600, (non-empty-list<float>|null) $quantiles = NULL): \danog\BetterPrometheus\BetterSummary

Parameters:

• $namespace: string e.g. cms
• $name: string e.g. duration_seconds
• $help: string e.g. A summary of the duration in seconds.
• $labels: array<string, string> e.g. [‘controller’ => ‘someController’, ‘action’ => ‘someAction’]
• $maxAgeSeconds: int e.g. 604800
• $quantiles: (non-empty-list<float>|null) e.g. [0.01, 0.5, 0.99]

See also:

• non-empty-list
• \danog\BetterPrometheus\BetterSummary: A better prometheus summary.

getSummary(string $namespace, string $name): \danog\BetterPrometheus\BetterSummary

Parameters:

• $namespace: string
• $name: string

See also:

• \danog\BetterPrometheus\BetterSummary: A better prometheus summary.

getOrRegisterSummary(string $namespace, string $name, string $help, array<string, string> $labels = [], int $maxAgeSeconds = 600, (non-empty-list<float>|null) $quantiles = NULL): \danog\BetterPrometheus\BetterSummary

Parameters:

• $namespace: string e.g. cms
• $name: string e.g. duration_seconds
• $help: string e.g. A summary of the duration in seconds.
• $labels: array<string, string> e.g. [‘controller’ => ‘someController’, ‘action’ => ‘someAction’]
• $maxAgeSeconds: int e.g. 604800
• $quantiles: (non-empty-list<float>|null) e.g. [0.01, 0.5, 0.99]

See also:

• non-empty-list
• \danog\BetterPrometheus\BetterSummary: A better prometheus summary.

---

Generated by danog/phpdoc

This site is open source. Improve this page.