mirror of
https://github.com/valitydev/osquery-1.git
synced 2024-11-08 02:18:53 +00:00
89 lines
2.4 KiB
C++
89 lines
2.4 KiB
C++
/**
|
|
* Copyright (c) 2014-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under both the Apache 2.0 license (found in the
|
|
* LICENSE file in the root directory of this source tree) and the GPLv2 (found
|
|
* in the COPYING file in the root directory of this source tree).
|
|
* You may select, at your option, one of the above-listed licenses.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <chrono>
|
|
#include <string>
|
|
|
|
#include <osquery/core/conversions.h>
|
|
#include <osquery/expected.h>
|
|
|
|
namespace osquery {
|
|
|
|
namespace monitoring {
|
|
|
|
/**
|
|
* Types for clock and time point in monitoring plugin
|
|
*/
|
|
using Clock = std::chrono::system_clock;
|
|
using TimePoint = Clock::time_point;
|
|
|
|
using ValueType = long long int;
|
|
|
|
enum class PreAggregationType {
|
|
None,
|
|
Sum,
|
|
Min,
|
|
Max,
|
|
// not existing PreAggregationType, upper limit definition
|
|
InvalidTypeUpperLimit,
|
|
};
|
|
|
|
/**
|
|
* @brief Record new point to numeric monitoring system.
|
|
*
|
|
* @param path A unique key in monitoring system. If you need to add some common
|
|
* prefix for all osquery points do it in the plugin code.
|
|
* @param value A numeric value of new point.
|
|
* @param pre_aggregation An preliminary aggregation type for this particular
|
|
* path @see PreAggregationType. It allows some numeric monitoring plugins
|
|
* pre-aggregate points before send it.
|
|
* @param time_point A time of new point, in vast majority of cases it is just
|
|
* a now time (default time).
|
|
*
|
|
* Common way to use it:
|
|
* @code{.cpp}
|
|
* monitoring::record("watched.parameter.path",
|
|
* 10.42,
|
|
* monitoring::PreAggregationType::Sum);
|
|
* @endcode
|
|
*/
|
|
void record(const std::string& path,
|
|
ValueType value,
|
|
PreAggregationType pre_aggregation = PreAggregationType::None,
|
|
TimePoint time_point = Clock::now());
|
|
|
|
/**
|
|
* Force flush the pre-aggregation buffer.
|
|
* Only for tests, please do not use it anywhere.
|
|
*/
|
|
void flushForTests();
|
|
|
|
}; // namespace monitoring
|
|
|
|
/**
|
|
* Generic to convert PreAggregationType to string
|
|
*/
|
|
template <typename ToType>
|
|
typename std::enable_if<std::is_same<std::string, ToType>::value, ToType>::type
|
|
to(const monitoring::PreAggregationType& from);
|
|
|
|
/**
|
|
* Generic to parse PreAggregationType from string
|
|
*/
|
|
template <typename ToType>
|
|
typename std::enable_if<
|
|
std::is_same<monitoring::PreAggregationType, ToType>::value,
|
|
Expected<ToType, ConversionError>>::type
|
|
tryTo(const std::string& from);
|
|
|
|
} // namespace osquery
|