StormByte-Network 4.0.0
C++26 networking module of the StormByte suite
Loading...
Searching...
No Matches
server_telemetry.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Network.
5 *
6 * StormByte-Network original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Network source in this
20 * repository. They do not cover other StormByte modules or any third-party
21 * material shipped with this repository (including everything under
22 * thirdparty/, and in particular the bundled StormByte Buffer tree), which
23 * remains under its own license.
24 *
25 * Neither license grants any patent rights. Any patent licenses required
26 * to use this software or third-party components must be obtained separately
27 * from the patent holders.
28 *
29 * StormByte-Network is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU Lesser General Public License for more details.
33 *
34 * You should have received a copy of the GNU Lesser General Public License
35 * version 3 along with StormByte-Network. If not, see
36 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
37 *
38 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
39 */
40
41#pragma once
42
45#include <StormByte/safe/atomic.hxx>
46#include <StormByte/size.hxx>
47
48#include <chrono>
49#include <cstdint>
50
55namespace StormByte {
60 namespace Network {
65 class Server;
66
72 public:
76 ServerTelemetry() noexcept;
77
81 ~ServerTelemetry() noexcept override;
82
87 Size CurrentConnections() const noexcept;
88
93 Size AcceptedConnections() const noexcept;
94
99 Size ClosedConnections() const noexcept;
100
105 Size PeakConnections() const noexcept;
106
111 Size PacketsDispatched() const noexcept;
112
117 Size HandlersCompleted() const noexcept;
118
125
130 Size HandlerErrors() const noexcept;
131
136 Size HandlerLatencySamples() const noexcept;
137
143 std::chrono::microseconds MeanHandlerLatency() const noexcept;
144
150
155 operator StormByte::Safe::String() const override;
156
157 private:
161 friend class Server;
162
168 void RecordConnectionAccepted() noexcept;
169
175 void RecordConnectionClosed() noexcept;
176
180 void RecordPacketDispatched() noexcept;
181
190 void RecordHandlerResult(std::chrono::microseconds elapsed, bool succeeded) noexcept;
191
195 void RecordHandlerError() noexcept;
196
202 Sample MeasureHandler();
203
207 void RecordWorkerQueueBackpressure() noexcept;
208
209 Safe::Atomic<std::uint64_t> m_current_connections{0};
210 Safe::Atomic<std::uint64_t> m_accepted_connections{0};
211 Safe::Atomic<std::uint64_t> m_closed_connections{0};
212 Safe::Atomic<std::uint64_t> m_peak_connections{0};
213 Safe::Atomic<std::uint64_t> m_packets_dispatched{0};
214 Safe::Atomic<std::uint64_t> m_handlers_completed{0};
215 Safe::Atomic<std::uint64_t> m_handlers_without_response{0};
216 Safe::Atomic<std::uint64_t> m_handler_errors{0};
217 Safe::Atomic<std::uint64_t> m_latency_samples{0};
218 Safe::Atomic<std::uint64_t> m_latency_us{0};
219 Safe::Atomic<std::uint64_t> m_queue_backpressure_events{0};
220 };
221 }
222}
223
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Server-wide cumulative telemetry aggregated across all sessions.
Definition server_telemetry.hxx:71
Size CurrentConnections() const noexcept
Number of currently active application sessions.
Size HandlersWithoutResponse() const noexcept
Packet handlers that returned no response.
Size AcceptedConnections() const noexcept
Total application sessions accepted by this Server.
operator StormByte::Safe::String() const override
Flatten the aggregate server counters to owned UTF-8 text.
Size HandlerLatencySamples() const noexcept
Number of completed packet-handler duration samples.
Size WorkerQueueBackpressureEvents() const noexcept
Times a ready session was blocked by a full worker queue.
std::chrono::microseconds MeanHandlerLatency() const noexcept
Mean ProcessClientPacket duration, or zero without samples.
Size HandlerErrors() const noexcept
Worker-pool callbacks that completed with an error.
Size HandlersCompleted() const noexcept
Packet handlers that returned a non-null response.
Size PacketsDispatched() const noexcept
Valid application packets submitted to the worker pool.
ServerTelemetry() noexcept
Construct all server counters at zero.
Size ClosedConnections() const noexcept
Total application sessions closed by this Server.
friend class Server
Allow the owning server to record telemetry events.
Definition server_telemetry.hxx:161
Size PeakConnections() const noexcept
Maximum simultaneous application sessions observed.
Abstract application server.
Definition server.hxx:148
Telemetry() noexcept
Construct an empty Network telemetry base.
StormByte::Clock::Sample Sample
Base-owned independent RAII measurement token.
Definition telemetry.hxx:91
Network module of the StormByte suite.
Root namespace of the StormByte suite.
STL namespace.
#define STORMBYTE_NETWORK_PUBLIC
Definition visibility.h:51