LogSpamTest.h

Go to the documentation of this file.

/*
 * This file is part of ArmarX.
 *
 * ArmarX is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * ArmarX 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 <http://www.gnu.org/licenses/>.
 *
 * @package    ArmarXCore::ArmarXObjects::LogSpamTest
 * @date       2026
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
#pragma once
 
#include <atomic>
#include <random>
#include <string>
#include <vector>
 
#include <ArmarXCore/core/Component.h>
#include <ArmarXCore/core/services/tasks/RunningTask.h>
 
namespace armarx
{
    /**
     * @class LogSpamTestPropertyDefinitions
     * @brief Properties of the LogSpamTest component.
     */
    class LogSpamTestPropertyDefinitions : public armarx::ComponentPropertyDefinitions
    {
    public:
        LogSpamTestPropertyDefinitions(std::string prefix);
    };
 
    /**
     * @defgroup Component-LogSpamTest LogSpamTest
     * @ingroup ArmarXCore-Components
     *
     * Emits log messages at a configurable rate, severity mix and shape, to put the
     * logging path (LogSender -> IceStorm "Log" topic -> LogViewer GUI) under a
     * reproducible load.
     *
     * Every message is unique: the text is assembled from random words plus a per-thread
     * counter and a random id. That matters because the viewer deduplicates nothing and
     * because identical lines would not exercise its per-entry work realistically.
     *
     * The knobs are chosen to reach the parts of the path that actually cost something:
     *
     * - @c WarningPercent / @c ErrorPercent -- messages at WARN and above carry a full
     *   backtrace (see LogSender::log), which dominates both payload size and sender cost.
     * - @c MultilinePercent -- multi-line messages are what give the viewer's table rows
     *   individual heights.
     * - @c TagCount -- spreads messages over several tags.
     * - @c ThreadCount -- concurrent senders, so the global console mutex in LogSender is
     *   contended as it is in a real component.
     * - @c BurstEveryMs / @c BurstSize -- periodic bursts on top of the steady rate, to
     *   exercise the viewer's staging queue rather than only its steady-state throughput.
     *
     * The component name shown in the viewer is the *application* name, so a scenario runs
     * several instances of this app to produce several distinct log sources.
     *
     * @class LogSpamTest
     * @ingroup Component-LogSpamTest
     * @brief Generates configurable log load for testing the logging path.
     */
    class LogSpamTest : virtual public armarx::Component
    {
    public:
        /// @see armarx::ManagedIceObject::getDefaultName()
        std::string getDefaultName() const override;
 
    protected:
        /// @see armarx::ManagedIceObject::onInitComponent()
        void onInitComponent() override;
 
        /// @see armarx::ManagedIceObject::onConnectComponent()
        void onConnectComponent() override;
 
        /// @see armarx::ManagedIceObject::onDisconnectComponent()
        void onDisconnectComponent() override;
 
        /// @see armarx::ManagedIceObject::onExitComponent()
        void onExitComponent() override;
 
        /// @see PropertyUser::createPropertyDefinitions()
        armarx::PropertyDefinitionsPtr createPropertyDefinitions() override;
 
    private:
        //! Body of each spam thread: paces itself to its share of the target rate.
        void spamTaskRun();
 
        //! Emit one random message. \p rng is the calling thread's generator.
        void emitOne(std::mt19937& rng, long& counter);
 
        //! Build a random, unique message body.
        std::string buildMessage(std::mt19937& rng, long counter) const;
 
        int messagesPerSecond = 0;
        int threadCount = 1;
        int seed = 0;
        int warningPercent = 0;
        int errorPercent = 0;
        int verbosePercent = 0;
        int multilinePercent = 0;
        int multilineMaxLines = 1;
        int minWords = 1;
        int maxWords = 1;
        int tagCount = 1;
        int burstEveryMs = 0;
        int burstSize = 0;
 
        //! Hands each spam thread its index, so they can seed their generators distinctly.
        std::atomic<int> nextThreadIndex{0};
 
        //! Cleared before the tasks are stopped, so the loops leave promptly.
        std::atomic<bool> running{false};
 
        std::vector<RunningTask<LogSpamTest>::pointer_type> tasks;
    };
} // namespace armarx