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 11.7 KB
Newer Older
1
2
3
//================================================================================
// Name        : SensorBase.h
// Author      : Micha Mueller
Micha Müller's avatar
Micha Müller committed
4
// Contact     : info@dcdb.it
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// 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.
//================================================================================
27
28
29
30

#ifndef SRC_SENSORBASE_H_
#define SRC_SENSORBASE_H_

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

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

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

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

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

89
	virtual ~SensorBase() {}
90
91
92
93

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

		return *this;
114
115
	}

116
	const bool 				isDelta()			const 	{ return _delta;}
117
118
	const std::string& 		getName() 			const	{ return _name; }
	const std::string&		getMqtt() 			const	{ return _mqtt; }
119
	bool					getSkipConstVal()	const	{ return _skipConstVal; }
Alessio Netti's avatar
Alessio Netti committed
120
	unsigned				getCacheInterval()	const	{ return _cacheInterval; }
121
	unsigned 				getSubsampling()	const   { return _subsamplingFactor; }
Alessio Netti's avatar
Alessio Netti committed
122
	const CacheEntry* const	getCache() 			const	{ return _cache.get(); }
Micha Mueller's avatar
Micha Mueller committed
123
	const reading_t&		getLatestValue()	const	{ return _latestValue; }
Alessio Netti's avatar
Alessio Netti committed
124
	const bool				isInit()			const 	{ return _cache && _readingQueue; }
125

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

129
	void	setSkipConstVal(bool skipConstVal)				{ _skipConstVal = skipConstVal;	}
130
	void	setDelta(const bool delta) 						{ _delta = delta; }
131
	void	setName(const std::string& name)				{ _name = name; }
132
133
	void	setMqtt(const std::string& mqtt)				{ _mqtt = mqtt; }
	void 	setCacheInterval(unsigned cacheInterval)		{ _cacheInterval = cacheInterval; }
134
	void	setSubsampling(unsigned factor)					{ _subsamplingFactor = factor; }
135
136
	void    setLastRaw(int64_t raw)                         { _lastRawValue.value = raw; }
	void    setLastURaw(uint64_t raw)                       { _lastRawUValue.value = raw; }
137
138
139

	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
140
	void 				clearReadingQueue() const	{ reading_t buf; while(_readingQueue->pop(buf)) {} }
141
142
	void				pushReadingQueue(reading_t *reads, std::size_t count) const	{ _readingQueue->push(reads, count); }

143
	void initSensor(unsigned interval) {
Alessio Netti's avatar
Alessio Netti committed
144
		uint64_t cacheSize = _cacheInterval / interval + 1;
145
		if(!_cache) {
Alessio Netti's avatar
Alessio Netti committed
146
147
			//TODO: have all time-related configuration parameters use the same unit (e.g. milliseconds)
			_cache.reset(new CacheEntry( (uint64_t)_cacheInterval * 1000000, cacheSize));
148
			_cache->updateBatchSize(1, true);
149
150
		}
		if(!_readingQueue) {
lu43jih's avatar
lu43jih committed
151
			_readingQueue.reset(new boost::lockfree::spsc_queue<reading_t>(QUEUE_MAXLIMIT));
152
153
154
		}
	}

155
156
	/**
	 * Store a reading, in order to get it pushed to the data base eventually.
157
	 * Also this method takes care of other optional reading post-processing,
158
159
160
161
162
163
164
165
	 * 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.
Micha Müller's avatar
Micha Müller committed
166
	 * @param storeGlobal Store reading in reading queue, so that it can get pushed.
167
	 */
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
	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;
185

186
187
188
189
		storeReadingLocal(reading);
		if (storeGlobal) {
		    storeReadingGlobal(reading);
		}
190
191
	}

192
193
	/**
     * Store an unsigned reading, in order to get it pushed to the data base eventually.
194
     * Also this method takes care of other optional reading post-processing,
195
196
197
198
199
200
201
202
203
204
205
206
207
     * 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.
Micha Müller's avatar
Micha Müller committed
208
     * @param storeGlobal Store reading in reading queue, so that it can get pushed.
209
     */
210
	void storeReading(ureading_t rawReading, double factor=1.0, unsigned long long maxValue=ULLONG_MAX, bool storeGlobal=true) {
211
212
        reading_t reading;
        reading.timestamp = rawReading.timestamp;
213
214
        if( _delta ) {
            if (!_firstReading) {
215
216
217
218
                if (rawReading.value < _lastRawUValue.value)
                    reading.value = (rawReading.value + (maxValue - _lastRawUValue.value)) * factor;
                else
                    reading.value = (rawReading.value - _lastRawUValue.value) * factor;
219
            } else {
220
221
222
                _firstReading = false;
                _lastRawUValue = rawReading;
                return;
223
224
225
226
227
228
            }
            _lastRawUValue = rawReading;
        }
        else
            reading.value = rawReading.value * factor;

229
230
231
232
        storeReadingLocal(reading);
        if (storeGlobal) {
            storeReadingGlobal(reading);
        }
233
234
    }

235
236
237
238
239
240
    /**
     * 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) {
241
242
        _cache->store(reading);
        _latestValue = reading;
243
    }
244

245
246
247
248
249
250
    /**
     * Store the reading in the readingQueue so it can get pushed.
     */
    inline
    void storeReadingGlobal(reading_t reading) {
        if( _delta )
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
            // 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;
        }
266
    }
267
    
268
269
270
	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
271
	  //LOG_VAR(ll) << leading << "    MQTT Topic:  " << _mqtt;
272
273
274
      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");
275
276
	}

277
278
protected:

279
280
	std::string _name;
	std::string _mqtt;
281
	bool _skipConstVal;
282
	unsigned int _cacheInterval;
283
284
	unsigned int _subsamplingFactor;
	unsigned int _subsamplingIndex;
Alessio Netti's avatar
Alessio Netti committed
285
	std::unique_ptr<CacheEntry> _cache;
286
	bool _delta;
287
	bool _firstReading;
288
	ureading_t _lastRawUValue;
289
	reading_t _lastRawValue;
290
	reading_t _latestValue;
291
	reading_t _lastSentValue;
Alessio Netti's avatar
Alessio Netti committed
292
	reading_t _accumulator;
293
	std::unique_ptr<boost::lockfree::spsc_queue<reading_t>> _readingQueue;
294
295
};

296
297
298
//for better readability
using SBasePtr = std::shared_ptr<SensorBase>;

299
#endif /* SRC_SENSORBASE_H_ */