Currently job artifacts in CI/CD pipelines on LRZ GitLab never expire. Starting from Wed 26.1.2022 the default expiration time will be 30 days (GitLab default). Currently existing artifacts in already completed jobs will not be affected by the change. The latest artifacts for all jobs in the latest successful pipelines will be kept. More information: https://gitlab.lrz.de/help/user/admin_area/settings/continuous_integration.html#default-artifacts-expiration

sensorbase.h 12.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
//================================================================================
// Name        : SensorBase.h
// Author      : Micha Mueller
// Copyright   : Leibniz Supercomputing Centre
// Description : General sensor base class.
//================================================================================

//================================================================================
// This file is part of DCDB (DataCenter DataBase)
// Copyright (C) 2018-2019 Leibniz Supercomputing Centre
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//================================================================================
26
27
28
29

#ifndef SRC_SENSORBASE_H_
#define SRC_SENSORBASE_H_

30
#include <fstream>
31
#include <memory>
32
#include <string>
33
#include <limits.h>
34
#include <boost/lockfree/spsc_queue.hpp>
35
#include "logging.h"
Alessio Netti's avatar
Alessio Netti committed
36
#include "cacheentry.h"
37

38
39
40
41
42
/**
 * @brief General sensor base class.
 *
 * @ingroup common
 */
43
44
class SensorBase {
public:
lu43jih's avatar
lu43jih committed
45
46
	static const size_t QUEUE_MAXLIMIT=1024;

47
48
	SensorBase(const std::string& name) :
		_name(name),
49
		_mqtt(""),
50
		_sinkPath(""),
51
		_skipConstVal(false),
52
		_cacheInterval(900000),
53
54
		_subsamplingFactor(1),
		_subsamplingIndex(0),
55
		_cache(nullptr),
56
		_delta(false),
57
		_firstReading(true),
58
59
		_readingQueue(nullptr),
		_sinkFile(nullptr) {
60

Alessio Netti's avatar
Alessio Netti committed
61
62
        _lastRawUValue.timestamp = 0;
        _lastRawUValue.value     = 0;
63
64
        _lastRawValue.timestamp = 0;
        _lastRawValue.value     = 0;
Alessio Netti's avatar
Alessio Netti committed
65
66
        _latestValue.timestamp	= 0;
        _latestValue.value		= 0;
67
68
        _lastSentValue.timestamp= 0;
        _lastSentValue.value	= 0;
Alessio Netti's avatar
Alessio Netti committed
69
70
        _accumulator.timestamp  = 0;
        _accumulator.value		= 0;
71
72
	}

73
74
75
	SensorBase(const SensorBase& other) :
		_name(other._name),
		_mqtt(other._mqtt),
76
		_sinkPath(other._sinkPath),
77
		_skipConstVal(other._skipConstVal),
78
		_cacheInterval(other._cacheInterval),
79
80
		_subsamplingFactor(other._subsamplingFactor),
		_subsamplingIndex(0),
81
		_cache(nullptr),
82
		_delta(other._delta),
83
		_firstReading(true),
Alessio Netti's avatar
Alessio Netti committed
84
		_lastRawUValue(other._lastRawUValue),
Alessio Netti's avatar
Alessio Netti committed
85
		_lastRawValue(other._lastRawValue),
Alessio Netti's avatar
Alessio Netti committed
86
		_latestValue(other._latestValue),
87
        _lastSentValue(other._lastSentValue),
Alessio Netti's avatar
Alessio Netti committed
88
        _accumulator(other._accumulator),
89
90
		_readingQueue(nullptr),
		_sinkFile(nullptr) {}
91

92
	virtual ~SensorBase() { if(_sinkFile) _sinkFile->close(); }
93
94
95
96

	SensorBase& operator=(const SensorBase& other) {
		_name = other._name;
		_mqtt = other._mqtt;
97
		_sinkPath = other._sinkPath;
98
		_skipConstVal = other._skipConstVal;
99
		_cacheInterval = other._cacheInterval;
100
101
		_subsamplingFactor = other._subsamplingFactor;
		_subsamplingIndex = 0;
102
		_cache.reset(nullptr);
103
		_delta = other._delta;
104
		_firstReading = true;
105
106
107
108
		_lastRawUValue.timestamp = other._lastRawUValue.timestamp;
        _lastRawUValue.value     = other._lastRawUValue.value;
		_lastRawValue.timestamp = other._lastRawValue.timestamp;
        _lastRawValue.value     = other._lastRawValue.value;
109
110
		_latestValue.timestamp	= other._latestValue.timestamp;
		_latestValue.value		= other._latestValue.value;
111
112
        _lastSentValue.timestamp= other._lastSentValue.timestamp;
        _lastSentValue.value	= other._lastSentValue.value;
Alessio Netti's avatar
Alessio Netti committed
113
114
        _accumulator.timestamp  = other._accumulator.timestamp;
        _accumulator.value      = other._accumulator.value;
115
		_readingQueue.reset(nullptr);
116
		_sinkFile.reset(nullptr);
117
118

		return *this;
119
120
	}

121
	const bool 				isDelta()			const 	{ return _delta;}
122
123
	const std::string& 		getName() 			const	{ return _name; }
	const std::string&		getMqtt() 			const	{ return _mqtt; }
124
	const std::string&		getSinkPath() 		const	{ return _sinkPath; }
125
	bool					getSkipConstVal()	const	{ return _skipConstVal; }
Alessio Netti's avatar
Alessio Netti committed
126
	unsigned				getCacheInterval()	const	{ return _cacheInterval; }
127
	unsigned 				getSubsampling()	const   { return _subsamplingFactor; }
Alessio Netti's avatar
Alessio Netti committed
128
	const CacheEntry* const	getCache() 			const	{ return _cache.get(); }
Micha Mueller's avatar
Micha Mueller committed
129
	const reading_t&		getLatestValue()	const	{ return _latestValue; }
Alessio Netti's avatar
Alessio Netti committed
130
	const bool				isInit()			const 	{ return _cache && _readingQueue; }
131

132
133
134
	// Exposing the reading queue is necessary for publishing sensor data from the collectagent
	boost::lockfree::spsc_queue<reading_t>* getReadingQueue() { return _readingQueue.get(); }

135
	void	setSkipConstVal(bool skipConstVal)				{ _skipConstVal = skipConstVal;	}
136
	void	setDelta(const bool delta) 						{ _delta = delta; }
137
	void	setName(const std::string& name)				{ _name = name; }
138
	void	setMqtt(const std::string& mqtt)				{ _mqtt = mqtt; }
139
	void 	setSinkPath(const std::string& path)			{ _sinkPath = path; }
140
	void 	setCacheInterval(unsigned cacheInterval)		{ _cacheInterval = cacheInterval; }
141
	void	setSubsampling(unsigned factor)					{ _subsamplingFactor = factor; }
142
143
	void    setLastRaw(int64_t raw)                         { _lastRawValue.value = raw; }
	void    setLastURaw(uint64_t raw)                       { _lastRawUValue.value = raw; }
144
145
146

	const std::size_t	getSizeOfReadingQueue() const { return _readingQueue->read_available(); }
	std::size_t 		popReadingQueue(reading_t *reads, std::size_t max) const	{ return _readingQueue->pop(reads, max); }
Alessio Netti's avatar
Alessio Netti committed
147
	void 				clearReadingQueue() const	{ reading_t buf; while(_readingQueue->pop(buf)) {} }
148
149
	void				pushReadingQueue(reading_t *reads, std::size_t count) const	{ _readingQueue->push(reads, count); }

150
	void initSensor(unsigned interval) {
Alessio Netti's avatar
Alessio Netti committed
151
		uint64_t cacheSize = _cacheInterval / interval + 1;
152
		if(!_cache) {
Alessio Netti's avatar
Alessio Netti committed
153
154
			//TODO: have all time-related configuration parameters use the same unit (e.g. milliseconds)
			_cache.reset(new CacheEntry( (uint64_t)_cacheInterval * 1000000, cacheSize));
155
			_cache->updateBatchSize(1, true);
156
157
		}
		if(!_readingQueue) {
lu43jih's avatar
lu43jih committed
158
			_readingQueue.reset(new boost::lockfree::spsc_queue<reading_t>(QUEUE_MAXLIMIT));
159
		}
160
161
162
163
164
		if(!_sinkFile && _sinkPath != "") {
			_sinkFile.reset(new std::ofstream(_sinkPath));
			if(!_sinkFile->is_open())
				_sinkFile.reset(nullptr);
		}
165
166
	}

167
168
	/**
	 * Store a reading, in order to get it pushed to the data base eventually.
169
	 * Also this method takes care of other optional reading post-processing,
170
171
172
173
174
175
176
177
178
	 * e.g. delta computation, subsampling, caching, scaling, etc.
	 *
	 * This is the primary storeReading() and should be used whenever possible.
	 *
	 * @param rawReading  Reading struct with value and timestamp to be stored.
	 * @param factor      Scaling factor, which is applied to the reading value (optional)
	 * @param maxValue    Maximum possible value of the reading; required for the
	 *                    delta computation to detect an overflow.
	 */
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
	void storeReading(reading_t rawReading, double factor=1.0, long long maxValue=LLONG_MAX, bool storeGlobal=true) {
        reading_t reading = rawReading;
        if( _delta ) {
            if (!_firstReading) {
                if (rawReading.value < _lastRawValue.value)
                    reading.value = (rawReading.value + (maxValue - _lastRawValue.value)) * factor;
                else
                    reading.value = (rawReading.value - _lastRawValue.value) * factor;
            } else {
                _firstReading = false;
                _lastRawValue = rawReading;
                return;
            }
            _lastRawValue = rawReading;
        }
        else
            reading.value = rawReading.value * factor;
196

197
198
199
200
		storeReadingLocal(reading);
		if (storeGlobal) {
		    storeReadingGlobal(reading);
		}
201
202
	}

203
204
	/**
     * Store an unsigned reading, in order to get it pushed to the data base eventually.
205
     * Also this method takes care of other optional reading post-processing,
206
207
208
209
210
211
212
213
214
215
216
217
218
219
     * e.g. delta computation, subsampling, caching, scaling, etc.
     *
     * This is a variant of the primary storeReading() for monotonically increasing
     * sensors reading unsigned 64bit values which may require more than the 63bit
     * offered by a signed reading_t. The readings are still stored as signed int64
     * in the database, therefore all such sensors should enable storage of deltas!
     *
     * This variant only adapts the delta computation for ureading_t actually.
     *
     * @param rawReading  Reading struct with (usigned) value and timestamp to be stored.
     * @param factor      Scaling factor, which is applied to the reading value (optional)
     * @param maxValue    Maximum possible value of the reading; required for the
     *                    delta computation to detect an overflow.
     */
220
	void storeReading(ureading_t rawReading, double factor=1.0, unsigned long long maxValue=ULLONG_MAX, bool storeGlobal=true) {
221
222
        reading_t reading;
        reading.timestamp = rawReading.timestamp;
223
224
        if( _delta ) {
            if (!_firstReading) {
225
226
227
228
                if (rawReading.value < _lastRawUValue.value)
                    reading.value = (rawReading.value + (maxValue - _lastRawUValue.value)) * factor;
                else
                    reading.value = (rawReading.value - _lastRawUValue.value) * factor;
229
            } else {
230
231
232
                _firstReading = false;
                _lastRawUValue = rawReading;
                return;
233
234
235
236
237
238
            }
            _lastRawUValue = rawReading;
        }
        else
            reading.value = rawReading.value * factor;

239
240
241
242
        storeReadingLocal(reading);
        if (storeGlobal) {
            storeReadingGlobal(reading);
        }
243
244
    }

245
246
247
248
249
250
251
    /**
     * Store reading within the sensor, but do not put it in the readingQueue
     * so the reading does not get pushed but the caches are still updated.
     */
    inline
    void storeReadingLocal(reading_t reading) {
        if (_sinkFile) {
252
253
254
255
256
257
258
259
            try {
                _sinkFile->seekp(0, std::ios::beg);
                *_sinkFile << reading.value << std::endl;
            } catch(const std::exception &e) { _sinkFile->close(); _sinkFile.reset(nullptr); }
        }

        _cache->store(reading);
        _latestValue = reading;
260
    }
261

262
263
264
265
266
267
    /**
     * Store the reading in the readingQueue so it can get pushed.
     */
    inline
    void storeReadingGlobal(reading_t reading) {
        if( _delta )
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
            // If in delta mode, _accumulator acts as a buffer, summing all deltas for the subsampling period
            _accumulator.value += reading.value;
        else
            _accumulator.value = reading.value;

        if (_subsamplingIndex++ % _subsamplingFactor == 0) {
            _accumulator.timestamp = reading.timestamp;
            //TODO: if sensor starts with values of 0, these won't be pushed. This should be fixed
            if( !(_skipConstVal && (_accumulator.value == _lastSentValue.value)) ) {
                _readingQueue->push(_accumulator);
                _lastSentValue = _accumulator;
            }
            // We reset the accumulator's value for the correct accumulation of deltas
            _accumulator.value = 0;
        }
283
    }
284
    
285
286
287
	virtual void printConfig(LOG_LEVEL ll, LOGGER& lg, unsigned leadingSpaces=16) {
	  std::string leading(leadingSpaces, ' ');
	  LOG_VAR(ll) << leading << "Sensor: " << _name;
Alessio Netti's avatar
Alessio Netti committed
288
	  //LOG_VAR(ll) << leading << "    MQTT Topic:  " << _mqtt;
289
290
291
292
	  LOG_VAR(ll) << leading << "    Sink:        " << (getSinkPath() != "" ? getSinkPath() : "none");
      LOG_VAR(ll) << leading << "    SubSampling: " << getSubsampling();
      LOG_VAR(ll) << leading << (_skipConstVal ? "    Skipping constant values" : "    No skipping of constant values");
      LOG_VAR(ll) << leading << (_delta ? "    Storing delta readings" : "    Storing absolute readings");
293
294
	}

295
296
protected:

297
298
	std::string _name;
	std::string _mqtt;
299
	std::string _sinkPath;
300
	bool _skipConstVal;
301
	unsigned int _cacheInterval;
302
303
	unsigned int _subsamplingFactor;
	unsigned int _subsamplingIndex;
Alessio Netti's avatar
Alessio Netti committed
304
	std::unique_ptr<CacheEntry> _cache;
305
	bool _delta;
306
	bool _firstReading;
307
	ureading_t _lastRawUValue;
308
	reading_t _lastRawValue;
309
	reading_t _latestValue;
310
	reading_t _lastSentValue;
Alessio Netti's avatar
Alessio Netti committed
311
	reading_t _accumulator;
312
	std::unique_ptr<boost::lockfree::spsc_queue<reading_t>> _readingQueue;
313
	std::unique_ptr<std::ofstream> _sinkFile;
314
315
};

316
317
318
//for better readability
using SBasePtr = std::shared_ptr<SensorBase>;

319
#endif /* SRC_SENSORBASE_H_ */