class.ilGlobalCacheMetricsCollectedObjective.php

Go to the documentation of this file.

<?php

use ILIAS\Setup\Metrics\CollectedObjective;
use ILIAS\Setup\Environment;
use ILIAS\Setup\Metrics\Storage;
use ILIAS\Cache\Config;
use ILIAS\Setup\Metrics\Metric;

class ilGlobalCacheMetricsCollectedObjective extends CollectedObjective
{
    protected function getTentativePreconditions(Environment $environment): array
    {
        return [
            new ilIniFilesLoadedObjective(),
            new \ilDatabaseInitializedObjective()
        ];
    }

    protected function collectFrom(Environment $environment, Storage $storage): void
    {
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);
        $client_ini = $environment->getResource(Environment::RESOURCE_CLIENT_INI);

        if (!$client_ini) {
            return;
        }

        $config = (new ilGlobalCacheSettingsAdapter($client_ini, $db))->getConfig();

        $service = $config->getAdaptorName();
        $storage->storeConfigText(
            "service",
            $service,
            "The backend that is used for the ILIAS cache."
        );
        $storage->storeConfigBool(
            "active",
            $config->isActivated()
        );

        $servers = $config->getNodes();
        if (
            $service === Config::MEMCACHED &&
            $servers !== []
        ) {
            $server_collection = [];
            foreach ($servers as $server) {
                $host = new Metric(
                    Metric::STABILITY_CONFIG,
                    Metric::TYPE_TEXT,
                    $server->getHost()
                );
                $port = new Metric(
                    Metric::STABILITY_CONFIG,
                    Metric::TYPE_GAUGE,
                    $server->getPort()
                );
                $weight = new Metric(
                    Metric::STABILITY_CONFIG,
                    Metric::TYPE_GAUGE,
                    $server->getWeight()
                );

                $server_collection[] = new Metric(
                    Metric::STABILITY_CONFIG,
                    Metric::TYPE_COLLECTION,
                    [
                        "host" => $host,
                        "port" => $port,
                        "weight" => $weight
                    ],
                    "Configured memcached node."
                );
            }

            $nodes = new Metric(
                Metric::STABILITY_CONFIG,
                Metric::TYPE_COLLECTION,
                $server_collection,
                "Collection of configured memcached nodes."
            );
            $storage->store("memcached_nodes", $nodes);
        }

        $component_activation = [];
        foreach (ilGlobalCache::getAvailableComponents() as $component) {
            $component_activation[$component] = new Metric(
                Metric::STABILITY_CONFIG,
                Metric::TYPE_BOOL,
                $config->isComponentActivated($component)
            );
        }
        $component_activation = new Metric(
            Metric::STABILITY_CONFIG,
            Metric::TYPE_COLLECTION,
            $component_activation,
            "Which components are activated to use caching?"
        );
        $storage->store(
            "components",
            $component_activation
        );
    }
}