monitored_duration.cc

Go to the documentation of this file.

// Copyright (C) 2024 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#include <config.h>
 
#include <dhcp/pkt4.h>
#include <dhcp/pkt6.h>
#include <dhcp/dhcp6.h>
#include <exceptions/exceptions.h>
#include <monitored_duration.h>
#include <util/boost_time_utils.h>
 
using namespace isc::dhcp;
using namespace isc::data;
using namespace isc::util;
using namespace boost::posix_time;
 
namespace isc {
namespace perfmon {
 
// DurationDataInterval methods
 
DurationDataInterval::DurationDataInterval(const Timestamp& start_time /* = PktEvent::now()*/)
    : start_time_(start_time), occurrences_(0),
      min_duration_(pos_infin), max_duration_(neg_infin),
      total_duration_(microseconds(0)) {
}
 
void
DurationDataInterval::addDuration(const Duration& duration) {
    ++occurrences_;
    if (duration < min_duration_) {
        min_duration_ = duration;
    }
 
    if (duration > max_duration_) {
        max_duration_ = duration;
    }
 
    total_duration_ += duration;
}
 
Duration
DurationDataInterval::getMeanDuration() const {
    if (!occurrences_) {
        return (ZERO_DURATION());
    }
 
    return (total_duration_ / occurrences_);
}
 
bool
DurationDataInterval::operator==(const DurationDataInterval& other) const {
    return ((start_time_ == other.start_time_) &&
            (occurrences_ == other.occurrences_) &&
            (min_duration_ == other.min_duration_) &&
            (max_duration_ == other.max_duration_) &&
            (total_duration_ == other.total_duration_));
}
 
// DurationKey methods
 
DurationKey::DurationKey(uint16_t family,
                         uint8_t query_type,
                         uint8_t response_type,
                         const std::string& start_event_label,
                         const std::string& stop_event_label,
                         dhcp::SubnetID subnet_id)
    : family_(family),
      query_type_(query_type),
      response_type_(response_type),
      start_event_label_(start_event_label),
      stop_event_label_(stop_event_label),
      subnet_id_(subnet_id) {
    if (family != AF_INET && family != AF_INET6) {
        isc_throw (BadValue, "DurationKey: family must be AF_INET or AF_INET6");
    }
 
    validateMessagePair(family, query_type, response_type);
}
 
void
DurationKey::validateMessagePair(uint16_t family, uint8_t query_type, uint8_t response_type) {
    if (family == AF_INET) {
        switch(query_type) {
            case DHCP_NOTYPE:
                if (response_type == DHCP_NOTYPE ||
                    response_type == DHCPOFFER ||
                    response_type == DHCPACK ||
                    response_type == DHCPNAK) {
                        return;
                    }
                break;
 
            case DHCPDISCOVER:
                if (response_type == DHCP_NOTYPE ||
                    response_type == DHCPOFFER ||
                    response_type == DHCPNAK) {
                    return;
                }
                break;
 
            case DHCPREQUEST:
                if (response_type == DHCP_NOTYPE ||
                    response_type == DHCPACK ||
                    response_type == DHCPNAK) {
                    return;
                }
                break;
 
            case DHCPINFORM:
                if (response_type == DHCP_NOTYPE ||
                    response_type == DHCPACK) {
                    return;
                }
                break;
 
            default:
                isc_throw(BadValue, "Query type not supported by monitoring: "
                                    << Pkt4::getName(query_type));
                break;
        }
 
        isc_throw(BadValue, "Response type: " << Pkt4::getName(response_type)
                             << " not valid for query type: " << Pkt4::getName(query_type));
 
    } else {
        switch(query_type) {
            case DHCPV6_NOTYPE:
            case DHCPV6_SOLICIT:
                if (response_type == DHCPV6_NOTYPE ||
                    response_type == DHCPV6_ADVERTISE ||
                    response_type == DHCPV6_REPLY) {
                    return;
                }
                break;
 
            case DHCPV6_REQUEST:
            case DHCPV6_RENEW:
            case DHCPV6_REBIND:
            case DHCPV6_CONFIRM:
                if (response_type == DHCPV6_NOTYPE ||
                    response_type == DHCPV6_REPLY) {
                    return;
                }
                break;
 
            default:
                isc_throw(BadValue, "Query type not supported by monitoring: "
                                     << Pkt6::getName(query_type));
                break;
        }
 
        isc_throw(BadValue, "Response type: " << Pkt6::getName(response_type)
                             << " not valid for query type: " << Pkt6::getName(query_type));
    }
}
 
std::string
DurationKey::getMessageTypeLabel(uint16_t family, uint16_t msg_type) {
    if (family == AF_INET) {
        return (msg_type == DHCP_NOTYPE ? "*" : Pkt4::getName(msg_type));
    }
 
    return (msg_type == DHCPV6_NOTYPE ? "*" : Pkt6::getName(msg_type));
}
 
std::string
DurationKey::getLabel() const {
    std::ostringstream oss;
    oss << getMessageTypeLabel(family_, query_type_)
        << "-"
        << getMessageTypeLabel(family_, response_type_)
        << "." << start_event_label_ << "-" << stop_event_label_
        << "." << subnet_id_;
 
    return (oss.str());
}
 
std::string
DurationKey::getStatName(const std::string& value_name) const {
    std::ostringstream oss;
    if (subnet_id_ != SUBNET_ID_GLOBAL) {
        oss << "subnet-id[" << subnet_id_ << "].";
    }
 
    oss << "perfmon."
        << getMessageTypeLabel(family_, query_type_)
        << "-"
        << getMessageTypeLabel(family_, response_type_)
        << "." << start_event_label_ << "-" << stop_event_label_
        << "." << value_name;
 
    return (oss.str());
}
 
ElementPtr
DurationKey::toElement() const {
    ElementPtr element = Element::createMap();
    element->set("query-type", Element::create(getMessageTypeLabel(family_, query_type_)));
    element->set("response-type", Element::create(getMessageTypeLabel(family_, response_type_)));
    element->set("start-event", Element::create(start_event_label_));
    element->set("stop-event", Element::create(stop_event_label_));
    element->set("subnet-id", Element::create(static_cast<long long>(subnet_id_)));
    return (element);
}
 
bool
DurationKey::operator==(const DurationKey& other) const {
    return (
        (query_type_ == other.query_type_) &&
        (response_type_ == other.response_type_) &&
        (start_event_label_ == other.start_event_label_) &&
        (stop_event_label_ == other.stop_event_label_) &&
        (subnet_id_ == other.subnet_id_)
    );
}
 
bool
DurationKey::operator!=(const DurationKey& other) const {
    return (!(*this == other));
}
 
bool
DurationKey::operator<(const DurationKey& other) const {
    return ((query_type_ < other.query_type_) ||
            (response_type_ < other.response_type_) ||
            (start_event_label_ < other.start_event_label_) ||
            (stop_event_label_ < other.stop_event_label_) ||
            (subnet_id_ < other.subnet_id_));
}
 
std::ostream&
operator<<(std::ostream& os, const DurationKey& key) {
    os << key.getLabel();
    return (os);
}
 
// MonitoredDuration methods
 
MonitoredDuration::MonitoredDuration(uint16_t family,
                                     uint8_t query_type,
                                     uint8_t response_type,
                                     const std::string& start_event_label,
                                     const std::string& stop_event_label,
                                     dhcp::SubnetID subnet_id,
                                     const Duration& interval_duration)
    : DurationKey(family, query_type, response_type, start_event_label, stop_event_label, subnet_id),
      interval_duration_(interval_duration),
      current_interval_(0),
      previous_interval_(0) {
    if (interval_duration_ <= DurationDataInterval::ZERO_DURATION()) {
        isc_throw(BadValue, "MonitoredDuration - interval_duration " << interval_duration_
                            << ", is invalid, it must be greater than 0");
    }
}
 
MonitoredDuration::MonitoredDuration(const DurationKey& key,
                                     const Duration& interval_duration)
    : DurationKey(key),
      interval_duration_(interval_duration),
      current_interval_(0),
      previous_interval_(0) {
    if (interval_duration_ <= DurationDataInterval::ZERO_DURATION()) {
        isc_throw(BadValue, "MonitoredDuration - interval_duration " << interval_duration_
                            << ", is invalid, it must be greater than 0");
    }
}
 
MonitoredDuration::MonitoredDuration(const MonitoredDuration& rhs)
    : DurationKey(rhs),
      interval_duration_(rhs.interval_duration_),
      current_interval_(0),
      previous_interval_(0) {
    if (rhs.current_interval_) {
        current_interval_.reset(new DurationDataInterval(*rhs.current_interval_));
    }
 
    if (rhs.previous_interval_) {
        previous_interval_.reset(new DurationDataInterval(*rhs.previous_interval_));
    }
}
 
Timestamp
MonitoredDuration::getCurrentIntervalStart() const {
    return (current_interval_ ? current_interval_->getStartTime()
                              : dhcp::PktEvent::MIN_TIME());
}
 
bool
MonitoredDuration::addSample(const Duration& sample) {
    auto now = PktEvent::now();
    bool do_report = false;
    if (!current_interval_) {
        current_interval_.reset(new DurationDataInterval(now));
    } else if ((now - current_interval_->getStartTime()) > interval_duration_) {
        previous_interval_ = current_interval_;
        do_report = true;
        current_interval_.reset(new DurationDataInterval(now));
    }
 
    current_interval_->addDuration(sample);
    return (do_report);
}
 
void
MonitoredDuration::expireCurrentInterval() {
    if (!current_interval_) {
        isc_throw(InvalidOperation, "MonitoredDuration::expireInterval"
                                    " - no current interval for: " << getLabel());
    }
 
    previous_interval_ = current_interval_;
    current_interval_.reset();
}
 
void
MonitoredDuration::clear() {
    current_interval_.reset();
    previous_interval_.reset();
}
 
ElementPtr
MonitoredDuration::toElement() const {
    ElementPtr element = Element::createMap();
    element->set("duration-key", DurationKey::toElement());
    if (previous_interval_) {
        element->set("start-time", Element::create(ptimeToText(previous_interval_->getStartTime())));
        element->set("occurrences", Element::create(static_cast<long long>(previous_interval_->getOccurrences())));
        element->set("min-duration-usecs", Element::create(previous_interval_->getMinDuration().total_microseconds()));
        element->set("max-duration-usecs", Element::create(previous_interval_->getMaxDuration().total_microseconds()));
        element->set("total-duration-usecs", Element::create(previous_interval_->getTotalDuration().total_microseconds()));
        element->set("mean-duration-usecs", Element::create(previous_interval_->getMeanDuration().total_microseconds()));
    } else {
        element->set("start-time", Element::create("<none>"));
        element->set("occurrences", Element::create(0));
        element->set("min-duration-usecs", Element::create(0));
        element->set("max-duration-usecs", Element::create(0));
        element->set("total-duration-usecs", Element::create(0));
        element->set("mean-duration-usecs", Element::create(0));
    }
 
    return (element);
}
 
ConstElementPtr
MonitoredDuration::valueRowColumns() {
    static std::list<std::string> column_labels{
        "query-type",
        "response-type",
        "start-event",
        "end-event",
        "subnet-id",
        "interval-start",
        "occurences",
        "min-duration-usecs",
        "max-duration-usecs",
        "total-duration-usecs"
        "mean-duration-usecs"
    };
 
    static ElementPtr cols;
    if (!cols) {
        // Create the list of column names and add it to the result set.
        cols = Element::createList();
        for (auto const& label : column_labels) {
            cols->add(Element::create(label));
        }
    }
 
    return(cols);
}
 
ElementPtr
MonitoredDuration::toValueRow() const {
    // Create the value row.
    ElementPtr row = Element::createList();
 
    // Add key values.
    row->add(Element::create(getMessageTypeLabel(family_, query_type_)));
    row->add(Element::create(getMessageTypeLabel(family_, response_type_)));
    row->add(Element::create(start_event_label_));
    row->add(Element::create(stop_event_label_));
    row->add(Element::create(static_cast<long long>(subnet_id_)));
 
    // Add interval data values.
    if (previous_interval_) {
        row->add(Element::create(ptimeToText(previous_interval_->getStartTime())));
        row->add(Element::create(static_cast<long long>(previous_interval_->getOccurrences())));
        row->add(Element::create(previous_interval_->getMinDuration().total_microseconds()));
        row->add(Element::create(previous_interval_->getMaxDuration().total_microseconds()));
        row->add(Element::create(previous_interval_->getTotalDuration().total_microseconds()));
        row->add(Element::create(previous_interval_->getMeanDuration().total_microseconds()));
    } else {
        row->add(Element::create("<none>"));
        row->add(Element::create(0));
        row->add(Element::create(0));
        row->add(Element::create(0));
        row->add(Element::create(0));
        row->add(Element::create(0));
    }
 
    return (row);
}
 
} // end of namespace perfmon
} // end of namespace isc