StormByte-Database 3.0.0
C++26 database module of the StormByte suite
Loading...
Searching...
No Matches
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-Database.
5 *
6 * StormByte-Database 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-Database 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-Logger tree and
23 * the PostgreSQL, MariaDB and SQLite trees), which remain under their own
24 * licenses.
25 *
26 * Neither license grants any patent rights. Any patent licenses required
27 * to use this software or third-party components must be obtained separately
28 * from the patent holders.
29 *
30 * StormByte-Database is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU Lesser General Public License for more details.
34 *
35 * You should have received a copy of the GNU Lesser General Public License
36 * version 3 along with StormByte-Database. If not, see
37 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
38 *
39 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
40 */
41
42#pragma once
43
45#include <StormByte/safe/atomic.hxx>
46
47#include <string_view>
48
50 class Postgres;
51 class PreparedSTMT;
52
58 public:
62 ~Telemetry() noexcept override;
64 std::uint64_t SerializationConflicts() const noexcept;
66 std::uint64_t Deadlocks() const noexcept;
68 std::uint64_t ConnectionErrors() const noexcept;
70 operator StormByte::Safe::String() const override;
71 private:
72 friend class Postgres;
73 friend class PreparedSTMT;
74 void RecordSqlState(std::string_view sql_state) noexcept;
75 void RecordEvent(BackendEvent event) noexcept override;
76 StormByte::Safe::Atomic<std::uint64_t> m_serialization_conflicts{0};
78 StormByte::Safe::Atomic<std::uint64_t> m_connection_errors{0};
79 };
80}
81
PostgreSQL backend.
Definition postgres.hxx:78
PostgreSQL prepared statement (PQexecPrepared).
Definition prepared_stmt.hxx:76
PostgreSQL-specific counters layered on common database telemetry.
Definition telemetry.hxx:57
std::uint64_t SerializationConflicts() const noexcept
SQLSTATE serialization failures (40001).
Telemetry()
Construct zeroed PostgreSQL counters.
std::uint64_t ConnectionErrors() const noexcept
Connection exception SQLSTATEs (class 08).
friend class PreparedSTMT
Definition telemetry.hxx:73
friend class Postgres
Definition telemetry.hxx:72
std::uint64_t Deadlocks() const noexcept
SQLSTATE deadlock detections (40P01).
~Telemetry() noexcept override
Out-of-line virtual destructor for DLL-safe destruction.
operator StormByte::Safe::String() const override
Flatten common and PostgreSQL-specific metrics.
Thread-safe cumulative telemetry for one database connection.
Definition telemetry.hxx:130
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Logger::Exception)
PostgreSQL backend of the Database module.
BackendEvent
Shared error and warning categories for backend-specific telemetry.
Definition telemetry.hxx:88
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_DATABASE_PUBLIC
Definition visibility.h:54