-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: emit metrics about entity imports #847
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
9765a1e
feat: emit metrics about entity imports
m90 9045733
refactor: use counter for modeling failed/successful import job metrics
m90 f76177c
feat: use persistent storage for prometheus metrics, enabling counters
m90 7f3454e
chore: clean up unused vars
m90 67f383f
chore: remove redundant database setting
m90 5d47b79
docs: add CHANGELOG
m90 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
<?php | ||
|
||
|
||
namespace App\Metrics; | ||
|
||
use LKDevelopment\HorizonPrometheusExporter\Contracts\Exporter; | ||
use Prometheus\CollectorRegistry; | ||
use App\WikiEntityImport; | ||
use App\WikiEntityImportStatus; | ||
|
||
class WikiEntityImports implements Exporter | ||
{ | ||
protected $pending; | ||
public function metrics(CollectorRegistry $collectorRegistry) | ||
{ | ||
$this->pending = $collectorRegistry->getOrRegisterGauge( | ||
config('horizon-exporter.namespace'), | ||
'wiki_entity_imports_pending', | ||
'The number of pending Entity imports currently being processed.', | ||
); | ||
} | ||
|
||
|
||
public function collect() | ||
{ | ||
// counters for failed / success are incremented in the HTTP controller | ||
$this->pending->set( | ||
WikiEntityImport::where(['status' => WikiEntityImportStatus::Pending])->count() | ||
); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
<?php | ||
|
||
namespace App\Providers; | ||
|
||
use Illuminate\Support\ServiceProvider; | ||
use Illuminate\Support\Facades\Config; | ||
use Prometheus\CollectorRegistry; | ||
use Prometheus\Storage\Redis; | ||
use Illuminate\Contracts\Foundation\Application; | ||
use LKDevelopment\HorizonPrometheusExporter\Repository\ExporterRepository; | ||
|
||
|
||
class CollectorRegistryProvider extends ServiceProvider | ||
{ | ||
/** | ||
* Register services. | ||
*/ | ||
public function register(): void | ||
{ | ||
$this->app->bind(CollectorRegistry::class, function (Application $app) { | ||
return new CollectorRegistry(new Redis([ | ||
'host' => Config::get('database.redis.metrics.host'), | ||
'port' => Config::get('database.redis.metrics.port'), | ||
'password' => Config::get('database.redis.metrics.password'), | ||
'timeout' => 0.1, // in seconds | ||
'read_timeout' => '10', // in seconds | ||
'persistent_connections' => false | ||
])); | ||
}, true); | ||
} | ||
|
||
/** | ||
* Bootstrap services. | ||
*/ | ||
public function boot(): void | ||
{ | ||
ExporterRepository::setRegistry( | ||
$this->app->make(CollectorRegistry::class), | ||
); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a tricky decision here: if we define these counters only once, it means they will be missing from the metrics if they have never been increased yet (the controller that answers the scraper will not know about it yet as it's never been persisted).
Alternatively we could:
Metrics/WikiEntityImport
classmetrics
methods on the metrics classes themselvesThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I understand right this isn't really a big problem? It just means that instead of
0
we will havenull
until the first import?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, exactly