1 /***************************************************************************
2 * Copyright (C) 2005-2020 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
21 #include "metricsserver.h"
27 #include <QHostAddress>
28 #include <QStringList>
32 #include "corenetwork.h"
34 MetricsServer::MetricsServer(QObject* parent)
37 connect(&_server, &QTcpServer::newConnection, this, &MetricsServer::incomingConnection);
38 connect(&_v6server, &QTcpServer::newConnection, this, &MetricsServer::incomingConnection);
41 bool MetricsServer::startListening()
45 uint16_t port = Quassel::optionValue("metrics-port").toUShort();
47 const QString listen = Quassel::optionValue("metrics-listen");
48 const QStringList listen_list = listen.split(",", QString::SkipEmptyParts);
49 for (const QString& listen_term : listen_list) { // TODO: handle multiple interfaces for same TCP version gracefully
51 if (!addr.setAddress(listen_term)) {
52 qCritical() << qPrintable(
53 tr("Invalid listen address %1")
58 switch (addr.protocol()) {
59 case QAbstractSocket::IPv6Protocol:
60 if (_v6server.listen(addr, port)) {
61 qInfo() << qPrintable(
62 tr("Listening for metrics requests on IPv6 %1 port %2")
64 .arg(_v6server.serverPort())
69 qWarning() << qPrintable(
70 tr("Could not open IPv6 interface %1:%2: %3")
73 .arg(_v6server.errorString()));
75 case QAbstractSocket::IPv4Protocol:
76 if (_server.listen(addr, port)) {
77 qInfo() << qPrintable(
78 tr("Listening for metrics requests on IPv4 %1 port %2")
80 .arg(_server.serverPort())
85 // if v6 succeeded on Any, the port will be already in use - don't display the error then
86 if (!success || _server.serverError() != QAbstractSocket::AddressInUseError)
87 qWarning() << qPrintable(
88 tr("Could not open IPv4 interface %1:%2: %3")
91 .arg(_server.errorString()));
95 qCritical() << qPrintable(
96 tr("Invalid listen address %1, unknown network protocol")
105 qWarning() << qPrintable(tr("Metrics could not open any network interfaces to listen on! No metrics functionality will be available"));
111 void MetricsServer::stopListening(const QString& msg)
113 bool wasListening = false;
115 if (_server.isListening()) {
119 if (_v6server.isListening()) {
126 qInfo() << "No longer listening for metrics requests.";
128 qInfo() << qPrintable(msg);
132 void MetricsServer::incomingConnection()
134 auto server = qobject_cast<QTcpServer*>(sender());
136 while (server->hasPendingConnections()) {
137 QTcpSocket* socket = server->nextPendingConnection();
138 connect(socket, &QIODevice::readyRead, this, &MetricsServer::respond);
139 connect(socket, &QAbstractSocket::disconnected, socket, &QObject::deleteLater);
143 QString parseHttpString(const QByteArray& request, int& index)
146 int end = request.indexOf(' ', index);
148 end = request.length();
152 content = QString::fromUtf8(request.mid(index, end - index));
156 index = request.length();
161 void MetricsServer::respond()
163 auto socket = qobject_cast<QTcpSocket*>(sender());
166 if (!socket->canReadLine()) {
175 for (int i = 0; i < 5 && verb == ""; i++) {
176 request = socket->readLine(4096);
177 if (request.endsWith("\r\n")) {
180 else if (request.endsWith("\n")) {
184 verb = parseHttpString(request, index);
185 requestPath = parseHttpString(request, index);
186 version = parseHttpString(request, index);
189 if (requestPath == "/metrics") {
190 if (version == "HTTP/1.1") {
192 "HTTP/1.1 200 OK\r\n"
193 "Content-Type: text/plain; version=0.0.4\r\n"
194 "Connection: close\r\n"
198 int64_t timestamp = QDateTime::currentMSecsSinceEpoch();
199 for (const auto& key : _sessions.keys()) {
200 const QString& name = _sessions[key];
201 socket->write("# HELP quassel_network_bytes_received Number of currently open connections from quassel clients\n");
202 socket->write("# TYPE quassel_client_sessions gauge\n");
204 QString("quassel_client_sessions{user=\"%1\"} %2 %3\n")
206 .arg(_clientSessions.value(key, 0))
210 socket->write("# HELP quassel_network_bytes_received Number of currently open connections to IRC networks\n");
211 socket->write("# TYPE quassel_network_sessions gauge\n");
213 QString("quassel_network_sessions{user=\"%1\"} %2 %3\n")
215 .arg(_networkSessions.value(key, 0))
219 socket->write("# HELP quassel_network_bytes_received Amount of bytes sent to IRC\n");
220 socket->write("# TYPE quassel_network_bytes_sent counter\n");
222 QString("quassel_network_bytes_sent{user=\"%1\"} %2 %3\n")
224 .arg(_networkDataTransmit.value(key, 0))
228 socket->write("# HELP quassel_network_bytes_received Amount of bytes received from IRC\n");
229 socket->write("# TYPE quassel_network_bytes_received counter\n");
231 QString("quassel_network_bytes_received{user=\"%1\"} %2 %3\n")
233 .arg(_networkDataReceive.value(key, 0))
237 socket->write("# HELP quassel_message_queue The number of messages currently queued for that user\n");
238 socket->write("# TYPE quassel_message_queue gauge\n");
240 QString("quassel_message_queue{user=\"%1\"} %2 %3\n")
242 .arg(_messageQueue.value(key, 0))
246 socket->write("# HELP quassel_login_attempts The number of times the user has attempted to log in\n");
247 socket->write("# TYPE quassel_login_attempts counter\n");
249 QString("quassel_login_attempts{user=\"%1\",successful=\"false\"} %2 %3\n")
251 .arg(_loginAttempts.value(key, 0) - _successfulLogins.value(key, 0))
256 QString("quassel_login_attempts{user=\"%1\",successful=\"true\"} %2 %3\n")
258 .arg(_successfulLogins.value(key, 0))
263 if (!_certificateExpires.isNull()) {
264 socket->write("# HELP quassel_ssl_expire_time_seconds Expiration of the current TLS certificate in unixtime\n");
265 socket->write("# TYPE quassel_ssl_expire_time_seconds gauge\n");
267 QString("quassel_ssl_expire_time_seconds %1 %2\n")
268 .arg(_certificateExpires.toMSecsSinceEpoch() / 1000)
275 else if (requestPath == "/healthz") {
276 if (version == "HTTP/1.1") {
278 "HTTP/1.1 200 OK\r\n"
279 "Content-Type: text/plain\r\n"
280 "Connection: close\r\n"
290 if (version == "HTTP/1.1") {
292 "HTTP/1.1 404 Not Found\r\n"
293 "Content-Type: text/html\r\n"
294 "Connection: close\r\n"
301 "<head><title>404 Not Found</title></head>\n"
303 "<center><h1>404 Not Found</h1></center>\n"
304 "<hr><center>quassel %1 </center>\n"
307 .arg(Quassel::buildInfo().baseVersion)
314 void MetricsServer::addLoginAttempt(UserId user, bool successful) {
315 _loginAttempts.insert(user, _loginAttempts.value(user, 0) + 1);
317 _successfulLogins.insert(user, _successfulLogins.value(user, 0) + 1);
321 void MetricsServer::addLoginAttempt(const QString& user, bool successful) {
322 UserId userId = _sessions.key(user);
323 if (userId.isValid()) {
324 addLoginAttempt(userId, successful);
328 void MetricsServer::addSession(UserId user, const QString& name)
330 _sessions.insert(user, name);
333 void MetricsServer::removeSession(UserId user)
335 _sessions.remove(user);
338 void MetricsServer::addClient(UserId user)
340 _clientSessions.insert(user, _clientSessions.value(user, 0) + 1);
343 void MetricsServer::removeClient(UserId user)
345 int32_t count = _clientSessions.value(user, 0) - 1;
347 _clientSessions.remove(user);
350 _clientSessions.insert(user, count);
354 void MetricsServer::addNetwork(UserId user)
356 _networkSessions.insert(user, _networkSessions.value(user, 0) + 1);
359 void MetricsServer::removeNetwork(UserId user)
361 int32_t count = _networkSessions.value(user, 0) - 1;
363 _networkSessions.remove(user);
366 _networkSessions.insert(user, count);
370 void MetricsServer::transmitDataNetwork(UserId user, uint64_t size)
372 _networkDataTransmit.insert(user, _networkDataTransmit.value(user, 0) + size);
375 void MetricsServer::receiveDataNetwork(UserId user, uint64_t size)
377 _networkDataReceive.insert(user, _networkDataReceive.value(user, 0) + size);
380 void MetricsServer::messageQueue(UserId user, uint64_t size)
382 _messageQueue.insert(user, size);
385 void MetricsServer::setCertificateExpires(QDateTime expires)
387 _certificateExpires = std::move(expires);