[RPC] Add an uptime command that displays the amount of time that bitcoind has been running

This commit is contained in:
Ricardo Velhote 2017-05-14 19:18:26 +01:00
parent d609fd85ca
commit c07475294a
No known key found for this signature in database
GPG Key ID: 0D24CDB222472576
6 changed files with 63 additions and 3 deletions

View File

@ -26,7 +26,6 @@
class CBlockIndex; class CBlockIndex;
static const int64_t nClientStartupTime = GetTime();
static int64_t nLastHeaderTipUpdateNotification = 0; static int64_t nLastHeaderTipUpdateNotification = 0;
static int64_t nLastBlockTipUpdateNotification = 0; static int64_t nLastBlockTipUpdateNotification = 0;
@ -238,7 +237,7 @@ bool ClientModel::isReleaseVersion() const
QString ClientModel::formatClientStartupTime() const QString ClientModel::formatClientStartupTime() const
{ {
return QDateTime::fromTime_t(nClientStartupTime).toString(); return QDateTime::fromTime_t(GetStartupTime()).toString();
} }
QString ClientModel::dataDir() const QString ClientModel::dataDir() const

View File

@ -258,6 +258,22 @@ UniValue stop(const JSONRPCRequest& jsonRequest)
return "Bitcoin server stopping"; return "Bitcoin server stopping";
} }
UniValue uptime(const JSONRPCRequest& jsonRequest)
{
if (jsonRequest.fHelp || jsonRequest.params.size() > 1)
throw std::runtime_error(
"uptime\n"
"\nReturns the total uptime of the server.\n"
"\nResult:\n"
"ttt (numeric) The number of seconds that the server has been running\n"
"\nExamples:\n"
+ HelpExampleCli("uptime", "")
+ HelpExampleRpc("uptime", "")
);
return GetTime() - GetStartupTime();
}
/** /**
* Call Table * Call Table
*/ */
@ -267,6 +283,7 @@ static const CRPCCommand vRPCCommands[] =
/* Overall control/query calls */ /* Overall control/query calls */
{ "control", "help", &help, true, {"command"} }, { "control", "help", &help, true, {"command"} },
{ "control", "stop", &stop, true, {} }, { "control", "stop", &stop, true, {} },
{ "control", "uptime", &uptime, true, {} },
}; };
CRPCTable::CRPCTable() CRPCTable::CRPCTable()

View File

@ -84,6 +84,8 @@
#include <openssl/rand.h> #include <openssl/rand.h>
#include <openssl/conf.h> #include <openssl/conf.h>
// Application startup time (used for uptime calculation)
const int64_t nStartupTime = GetTime();
const char * const BITCOIN_CONF_FILENAME = "bitcoin.conf"; const char * const BITCOIN_CONF_FILENAME = "bitcoin.conf";
const char * const BITCOIN_PID_FILENAME = "bitcoind.pid"; const char * const BITCOIN_PID_FILENAME = "bitcoind.pid";
@ -889,3 +891,9 @@ std::string CopyrightHolders(const std::string& strPrefix)
} }
return strCopyrightHolders; return strCopyrightHolders;
} }
// Obtain the application startup time (used for uptime calculation)
int64_t GetStartupTime()
{
return nStartupTime;
}

View File

@ -5,7 +5,7 @@
/** /**
* Server/client environment: argument handling, config file parsing, * Server/client environment: argument handling, config file parsing,
* logging, thread wrappers * logging, thread wrappers, startup time
*/ */
#ifndef BITCOIN_UTIL_H #ifndef BITCOIN_UTIL_H
#define BITCOIN_UTIL_H #define BITCOIN_UTIL_H
@ -29,6 +29,9 @@
#include <boost/signals2/signal.hpp> #include <boost/signals2/signal.hpp>
// Application startup time (used for uptime calculation)
int64_t GetStartupTime();
static const bool DEFAULT_LOGTIMEMICROS = false; static const bool DEFAULT_LOGTIMEMICROS = false;
static const bool DEFAULT_LOGIPS = false; static const bool DEFAULT_LOGIPS = false;
static const bool DEFAULT_LOGTIMESTAMPS = true; static const bool DEFAULT_LOGTIMESTAMPS = true;

View File

@ -113,6 +113,7 @@ BASE_SCRIPTS= [
'listsinceblock.py', 'listsinceblock.py',
'p2p-leaktests.py', 'p2p-leaktests.py',
'wallet-encryption.py', 'wallet-encryption.py',
'uptime.py',
] ]
EXTENDED_SCRIPTS = [ EXTENDED_SCRIPTS = [

32
test/functional/uptime.py Executable file
View File

@ -0,0 +1,32 @@
#!/usr/bin/env python3
# Copyright (c) 2017 The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
"""Test the RPC call related to the uptime command.
Test corresponds to code in rpc/server.cpp.
"""
import time
from test_framework.test_framework import BitcoinTestFramework
class UptimeTest(BitcoinTestFramework):
def __init__(self):
super().__init__()
self.num_nodes = 1
self.setup_clean_chain = True
def run_test(self):
self._test_uptime()
def _test_uptime(self):
wait_time = 10
self.nodes[0].setmocktime(int(time.time() + wait_time))
assert(self.nodes[0].uptime() >= wait_time)
if __name__ == '__main__':
UptimeTest().main()