SystemHealth.idl

Go to the documentation of this file.

/**
 * @file   SystemHealth.idl
 * @brief  State of the operating system the product is running on.
 *
 * @author Martin Kuchar
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 */

#import <kerio/web/idl/SharedStructures.idl>

module kerio {
module web {

enum HistogramType {
   HistogramOneDay,  ///< Data interval: 5min,  Max samples: 288
   HistogramTwoHours,///< Data interval: 20sec, Max samples: 360
   HistogramOneWeek, ///< Data interval: 30min, Max samples: 336
   HistogramOneMonth ///< Data interval: 2h,    Max samples: 372
};

enum HistogramIntervalType {
    HistogramInterval5m,  ///< Data interval: 5min,  Max samples: 288, Length 1day
    HistogramInterval20s, ///< Data interval: 20sec, Max samples: 360, Length 2Hours
    HistogramInterval30m, ///< Data interval: 30min, Max samples: 336, Length 1Week
    HistogramInterval2h   ///< Data interval: 2h,    Max samples: 372, Length 1Month
};

/** 0-100%, sample count and rate depens on requested type and is the same as in ActiveHost histogram */
typedef sequence<double> PercentHistogram;

struct SystemHealthData {
   PercentHistogram cpu;
   PercentHistogram memory;
   double memoryTotal;        ///< memory histogram has to have fixed maximum to this value
   double diskTotal;          ///< total number of bytes on data partition (install dir on windows)
   double diskFree;
};

interface SystemHealth {
   void get(out SystemHealthData data, in HistogramType type);
   void getInc(out SystemHealthData data, out DateTimeStamp sampleTime, in HistogramIntervalType type, in kerio::web::DateTimeStamp startSampleTime);
};

}; // module web
}; // module kerio