ilGlobalCacheMetricsCollectedObjective Class Reference

Inheritance diagram for ilGlobalCacheMetricsCollectedObjective:

Collaboration diagram for ilGlobalCacheMetricsCollectedObjective:

Protected Member Functions
	getTentativePreconditions (Environment $environment)
	collectFrom (Environment $environment, Storage $storage)
Protected Member Functions inherited from ILIAS\Setup\Metrics\CollectedObjective
	collectFrom (Setup\Environment $environment, Storage $storage)
	Attempt to gather metrics based on the provided environment. More...
	getTentativePreconditions (Setup\Environment $environment)
	Give preconditions that might or might not be fullfilled. More...

Additional Inherited Members
Public Member Functions inherited from ILIAS\Setup\Metrics\CollectedObjective
	__construct (Storage $storage)
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
Public Member Functions inherited from ILIAS\Setup\Objective
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...
Protected Attributes inherited from ILIAS\Setup\Metrics\CollectedObjective
Storage	$storage

Detailed Description

Definition at line 25 of file class.ilGlobalCacheMetricsCollectedObjective.php.

Member Function Documentation

collectFrom()

ilGlobalCacheMetricsCollectedObjective::collectFrom ( Environment  $environment, Storage  $storage  )

protected

Definition at line 35 of file class.ilGlobalCacheMetricsCollectedObjective.php.

References $server, $service, ILIAS\Setup\Environment\getResource(), ILIAS\Setup\Metrics\Storage\store(), ILIAS\Setup\Metrics\Storage\storeConfigBool(), and ILIAS\Setup\Metrics\Storage\storeConfigText().

                                                                              : 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
        );
    }

Here is the call graph for this function:

getTentativePreconditions()

ilGlobalCacheMetricsCollectedObjective::getTentativePreconditions ( Environment  $environment )

protected

Definition at line 27 of file class.ilGlobalCacheMetricsCollectedObjective.php.

                                                                          : array
    {
        return [
            new ilIniFilesLoadedObjective(),
            new \ilDatabaseInitializedObjective()
        ];
    }

---

The documentation for this class was generated from the following file:

• components/ILIAS/GlobalCache_/classes/Setup/class.ilGlobalCacheMetricsCollectedObjective.php