Page MenuHomePhorge
Differential D4965

Metrics controller
ClosedPublic
Actions

Authored by mollekopf on Oct 1 2024, 12:59 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Jan 9, 3:05 PM
Unknown Object (File)
Sat, Jan 4, 6:27 AM
Unknown Object (File)
Sat, Jan 4, 6:27 AM
Unknown Object (File)
Sat, Jan 4, 6:27 AM
Unknown Object (File)
Sat, Jan 4, 6:14 AM
Unknown Object (File)
Fri, Jan 3, 12:07 AM
Unknown Object (File)
Thu, Jan 2, 7:52 PM
Unknown Object (File)
Thu, Jan 2, 4:54 PM
View All 67 Files
Subscribers
machniak

Details

Reviewers
machniak
Group Reviewers
Restricted Project
Commits
rKe0040b25a9e5: Metrics controller

Diff Detail

Repository
rK kolab
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

mollekopf requested review of this revision.Oct 1 2024, 12:59 PM
mollekopf created this revision.
Harbormaster completed remote builds in B50640: Diff 14226.Oct 1 2024, 12:59 PM
mollekopf added a reviewer: Restricted Project.Oct 1 2024, 1:00 PM
machniak accepted this revision.Oct 1 2024, 1:50 PM
machniak subscribed.

Looks good, but for consistency both queries should use tenant context and the same way of comparing user status.

This revision is now accepted and ready to land.Oct 1 2024, 1:50 PM
Closed by commit rKe0040b25a9e5: Metrics controller (authored by mollekopf). · Explain WhyOct 10 2024, 9:50 AM
This revision was automatically updated to reflect the committed changes.
mollekopf added a commit: rKe0040b25a9e5: Metrics controller.

Revision Contents
Changeset List

PathSize
src/
app/
Http/
Controllers/
API/
V4/
121 lines
routes/
1 line
tests/
Feature/
Controller/
40 lines

Diff 14283

View Options

src/app/Http/Controllers/API/V4/MetricsController.php

  • This file was added.
<?php
namespace App\Http\Controllers\API\V4;
use App\Http\Controllers\Controller;
use App\Payment;
use App\User;
use App\Wallet;
use Illuminate\Support\Facades\DB;
class MetricsController extends Controller
{
private function addTenantContext($query)
{
if ($tenantId = \config('app.tenant_id')) {
return $query->where('users.tenant_id', $tenantId);
} else {
return $query->whereNull('users.tenant_id');
}
}
/**
* Collect current payers count
*/
protected function collectPayersCount(): int
{
// A subquery to get the all wallets with a successful payment
$payments = DB::table('payments')
->selectRaw('distinct wallet_id')
->where('status', Payment::STATUS_PAID);
// A subquery to get users' wallets (by entitlement) - one record per user
$wallets = DB::table('entitlements')
->selectRaw("min(wallet_id) as id, entitleable_id as user_id")
->where('entitleable_type', User::class)
->groupBy('entitleable_id');
// Count all non-degraded and non-deleted users with any successful payment
$count = DB::table('users')
->joinSub($wallets, 'wallets', function ($join) {
$join->on('users.id', '=', 'wallets.user_id');
})
->joinSub($payments, 'payments', function ($join) {
$join->on('wallets.id', '=', 'payments.wallet_id');
})
->whereNull('users.deleted_at')
->whereNot('users.status', '&', User::STATUS_DEGRADED | User::STATUS_SUSPENDED);
$count = $this->addTenantContext($count);
return $count->count();
}
/**
* Collect number of wallets that require topup
*/
protected function numberOfWalletsWithBalanceBelowManadate(): int
{
$count = Wallet::select('wallets.id')
->join('users', 'users.id', '=', 'wallets.user_id')
->join('wallet_settings', function (\Illuminate\Database\Query\JoinClause $join) {
$join->on('wallet_settings.wallet_id', '=', 'wallets.id')
->where('wallet_settings.key', '=', 'mandate_balance');
})
->whereNull('users.deleted_at')
->whereRaw('wallets.balance < (wallet_settings.value * 100)')
->whereNot('users.status', '&', User::STATUS_DEGRADED | User::STATUS_SUSPENDED);
$count = $this->addTenantContext($count);
return $count->count();
}
/**
* Expose kolab metrics
*
* @return \Illuminate\Http\JsonResponse The response
*/
public function metrics()
{
$appDomain = \config('app.domain');
$tenantId = \config('app.tenant_id');
//TODO just get this from the stats table instead?
$numberOfPayingUsers = $this->collectPayersCount();
$numberOfUsers = User::count();
$numberOfDeletedUsers = User::withTrashed()->whereNotNull('deleted_at')->count();
$numberOfSuspendedUsers = User::where('status', '&', User::STATUS_SUSPENDED)->count();
$numberOfRestrictedUsers = User::where('status', '&', User::STATUS_RESTRICTED)->count();
$numberOfWalletsWithBalanceBelowManadate = $this->numberOfWalletsWithBalanceBelowManadate();
$text = <<<EOF
# HELP kolab_users_count Total number of users
# TYPE kolab_users_count gauge
kolab_users_count{instance="$appDomain", tenant="$tenantId"} $numberOfUsers
# HELP kolab_users_deleted_count Number of deleted users
# TYPE kolab_users_deleted_count gauge
kolab_users_deleted_count{instance="$appDomain", tenant="$tenantId"} $numberOfDeletedUsers
# HELP kolab_users_suspended_count Number of suspended users
# TYPE kolab_users_suspended_count gauge
kolab_users_suspended_count{instance="$appDomain", tenant="$tenantId"} $numberOfSuspendedUsers
# HELP kolab_users_restricted_count Number of restricted users
# TYPE kolab_users_restricted_count gauge
kolab_users_restricted_count{instance="$appDomain", tenant="$tenantId"} $numberOfRestrictedUsers
# HELP kolab_users_paying_count Number of paying users
# TYPE kolab_users_paying_count gauge
kolab_users_paying_count{instance="$appDomain", tenant="$tenantId"} $numberOfPayingUsers
# HELP kolab_wallets_balance_below_mandate_amount_count Number of wallets requiring topup
# TYPE kolab_wallets_balance_below_mandate_amount_count gauge
kolab_wallets_balance_below_mandate_amount{instance="$appDomain", tenant="$tenantId"} $numberOfWalletsWithBalanceBelowManadate
\n
EOF;
return response(
$text,
200,
[
'Content-Type' => "text/plain",
]
);
}
}
View Options

src/routes/api.php

Show First 20 Lines • Show All 220 Lines • ▼ Show 20 Lines Route::group(
function () { function () {
Route::get('nginx', [API\V4\NGINXController::class, 'authenticate']); Route::get('nginx', [API\V4\NGINXController::class, 'authenticate']);
Route::get('nginx-roundcube', [API\V4\NGINXController::class, 'authenticateRoundcube']); Route::get('nginx-roundcube', [API\V4\NGINXController::class, 'authenticateRoundcube']);
Route::get('nginx-httpauth', [API\V4\NGINXController::class, 'httpauth']); Route::get('nginx-httpauth', [API\V4\NGINXController::class, 'httpauth']);
Route::post('cyrus-sasl', [API\V4\NGINXController::class, 'cyrussasl']); Route::post('cyrus-sasl', [API\V4\NGINXController::class, 'cyrussasl']);
Route::post('policy/greylist', [API\V4\PolicyController::class, 'greylist']); Route::post('policy/greylist', [API\V4\PolicyController::class, 'greylist']);
Route::post('policy/ratelimit', [API\V4\PolicyController::class, 'ratelimit']); Route::post('policy/ratelimit', [API\V4\PolicyController::class, 'ratelimit']);
Route::post('policy/spf', [API\V4\PolicyController::class, 'senderPolicyFramework']); Route::post('policy/spf', [API\V4\PolicyController::class, 'senderPolicyFramework']);
Route::get('metrics', [API\V4\MetricsController::class, 'metrics']);
} }
); );
} }
Route::get('health/readiness', [API\V4\HealthController::class, 'readiness']); Route::get('health/readiness', [API\V4\HealthController::class, 'readiness']);
Route::get('health/liveness', [API\V4\HealthController::class, 'liveness']); Route::get('health/liveness', [API\V4\HealthController::class, 'liveness']);
if (\config('app.with_admin')) { if (\config('app.with_admin')) {
▲ Show 20 Lines • Show All 108 Lines • Show Last 20 Lines
View Options

src/tests/Feature/Controller/MetricsTest.php

Loading...