telemetry.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Buffer.
 *
 * StormByte-Buffer original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Buffer source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, and in particular the bundled StormByte-Logger tree and
 * the rest of the StormByte suite it vendors), which remains under its own
 * license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Buffer 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Buffer. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/buffer/visibility.h>
#include <StormByte/byte_size.hxx>
#include <StormByte/safe/string.hxx>
#include <StormByte/telemetry.hxx>
 
#include <atomic>
#include <chrono>
#include <cstdint>
#include <string_view>
#include <string>
 
namespace StormByte {
    namespace Buffer {
        class Bridge;
 
        class STORMBYTE_BUFFER_PUBLIC Telemetry: public StormByte::Telemetry {
            public:
                class OperationSample {
                    public:
                        OperationSample(const OperationSample&) = delete;
                        OperationSample(OperationSample&& other) noexcept;
                        OperationSample& operator=(const OperationSample&) = delete;
                        OperationSample& operator=(OperationSample&&) = delete;
 
                        ~OperationSample() noexcept;
 
                        void Commit(StormByte::ByteSize bytes) noexcept;
 
                    private:
                        friend class Telemetry;
 
                        explicit OperationSample(Telemetry& owner);
 
                        Telemetry& m_owner; 
                        StormByte::Clock& m_clock; 
                        std::chrono::microseconds m_before; 
                        std::size_t* m_depth; 
                        StormByte::ByteSize m_bytes {0}; 
                        bool m_committed {false}; 
                };
 
                virtual ~Telemetry() noexcept;
 
                StormByte::ByteSize MeanRate() const noexcept;
 
                OperationSample MeasureOperation();
 
                virtual operator StormByte::Safe::String() const = 0;
 
                STORMBYTE_FORCE_INLINE operator std::string() const {
                    return static_cast<std::string>(static_cast<StormByte::Safe::String>(*this));
                }
 
            protected:
                Telemetry() noexcept;
 
                Telemetry(const Telemetry&) = delete;
                Telemetry(Telemetry&&) = delete;
                Telemetry& operator=(const Telemetry&) = delete;
                Telemetry& operator=(Telemetry&&) = delete;
 
                void RecordOperation(StormByte::ByteSize bytes, std::chrono::microseconds elapsed) noexcept;
 
            private:
                friend class Bridge;
 
                std::atomic<std::uint64_t> m_rate_bytes;    
                std::atomic<std::uint64_t> m_op_us;     
                std::atomic<std::uint64_t> m_mean_rate; 
        };
 
        class STORMBYTE_BUFFER_PUBLIC ReadTelemetry: public Telemetry {
            public:
                ReadTelemetry() noexcept;
 
                ReadTelemetry(const ReadTelemetry&) = delete;
                ReadTelemetry(ReadTelemetry&&) = delete;
 
                virtual ~ReadTelemetry() noexcept override;
 
                ReadTelemetry& operator=(const ReadTelemetry&) = delete;
                ReadTelemetry& operator=(ReadTelemetry&&) = delete;
 
                StormByte::ByteSize Delivered() const noexcept;
 
                operator StormByte::Safe::String() const override;
 
            protected:
                friend class Bridge;
 
                StormByte::ByteSize m_delivered;    
        };
 
        class STORMBYTE_BUFFER_PUBLIC WriteTelemetry: public Telemetry {
            public:
                WriteTelemetry() noexcept;
 
                WriteTelemetry(const WriteTelemetry&) = delete;
                WriteTelemetry(WriteTelemetry&&) = delete;
 
                virtual ~WriteTelemetry() noexcept override;
 
                WriteTelemetry& operator=(const WriteTelemetry&) = delete;
                WriteTelemetry& operator=(WriteTelemetry&&) = delete;
 
                StormByte::ByteSize Accepted() const noexcept;
 
                operator StormByte::Safe::String() const override;
 
            protected:
                friend class Bridge;
 
                StormByte::ByteSize m_accepted; 
        };
    }
}