StatusInformationAwareMonitoringProvider.php

<?php

declare(strict_types=1);

/*
 * This file is part of the Composer package "cpsit/monitoring".
 *
 * Copyright (C) 2021 Elias Häußler <e.haeussler@familie-redlich.de>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace CPSIT\Monitoring\Provider;

/**
 * StatusInformationAwareMonitoringProvider.
 *
 * @author Elias Häußler <e.haeussler@familie-redlich.de>
 * @license GPL-3.0-or-later
 */
interface StatusInformationAwareMonitoringProvider extends MonitoringProvider
{
    /**
     * Get additional status information.
     *
     * Returns individual status information for the current provider. It
     * should describe the current state providing additional information used
     * to ensure the service works as expected.
     *
     * Note that status information must be JSON-serializable. For example,
     * plain strings or arrays as well as objects implementing the
     * {@link \JsonSerializable} interface can be returned.
     *
     * @return mixed JSON-serializable individual status information
     */
    public function getStatusInformation(): mixed;
}