Monito...bility(3pm)

📦
version 0.46 · 2 versions
, in ubuntu jammy

✨ Monitoring::Availability ✨

okay bestie, sit DOWN because we're talking about Monitoring::Availability (that's the 3pm perl module manual, if you were wondering which manual we're in 💅). It's giving "I crunch Nagios/Icinga/Shinken logfiles and tell you how available your stuff actually was" and honestly? Iconic. Let's get into it 🫶

🌸 SYNOPSIS 🌸

use Monitoring::Availability;
my $ma = Monitoring::Availability->new();

that's it. that's the vibe check. you load it, you make an object, you go off 💖

🦋 DESCRIPTION 🦋

so this module calculates the availability for hosts/server from given logfiles. and like, heads up: the Logfileformat is Nagios/Icinga only. no cap. don't come at it with something else, it's not gonna eat that 🍓

💜 REPOSITORY 💜

Git: http://github.com/sni/Monitoring-Availability

👑 CONSTRUCTOR 👑

✨ new ( [ARGS] ) ✨

Creates a Monitoring::Availability object. new takes at least the logs parameter — no logs, no party, fr fr. Arguments are in key-value pairs, like a little group chat where every name has its own reply 💬

  • rpttimeperiod — report timeperiod. defines a timeperiod for this report. Will use 24x7 if not specified. so if you don't say anything, it just assumes you're a 24/7 girlie ✨
  • assumeinitialstates — Assume the initial host/service state if none is found, default: yes
  • assumestateretention — Assume state retention, default: yes
  • assumestatesduringnotrunning — Assume state during times when the monitoring process is not running, default: yes
  • includesoftstates — Include soft states in the calculation. Only hard states are used otherwise, default: no. so soft states are lowkey excluded unless you say otherwise 💅
  • initialassumedhoststate — Assumed host state if none is found, default: unspecified

valid options are: unspecified, current, up, down and unreachable

  • initialassumedservicestate — Assumed service state if none is found, default: unspecified

valid options are: unspecified, current, ok, warning, unknown and critical

  • backtrack — Go back this amount of days to find initial states, default: 4. it literally time-travels backward to find your states, main character energy 🕰️
  • showscheduleddowntime — Include downtimes in calculation, default: yes
  • timeformat — Time format for the log output, default: %s
  • verbose — verbose mode. it talks more. we love a chatty icon 🗣️
  • breakdown — Breakdown availability into 'months', 'weeks', 'days', 'none'

adds additional 'breakdown' hash to each result with broken down results

💖 METHODS 💖

🌈 calculate 🌈

calculate()

Calculate the availability ✨ Here's everything you can hand it:

  • start — Timestamp of start
  • end — Timestamp of end
  • log_string — String containing the logs
  • log_file — File containing the logs
  • log_dir — Directory containing *.log files
  • log_livestatus — Array with logs from a livestatus query

a sample query could be:

selectall_arrayref(GET logs...\nColumns: time type options, {Slice => 1})
  • log_iterator — Iterator object for logentry objects. For example a MongoDB::Cursor object.
  • hosts — array with hostnames for which the report should be generated
  • services — array with hashes of services for which the report should be generated. The array should look like this:
[{host => 'hostname', service => 'description'}, ...]
  • initial_states — if you use the "current" option for initialassumedservicestate or initialassumedhoststate you have to provide the current states with a hash like this:
{
  hosts => {
   'hostname' => 'ok',
   ...
  },
  services => {
   'hostname' => {
       'description' =>  'warning',
       ...
    }
  }
}

valid values for hosts are: up, down and unreachable

valid values for services are: ok, warning, unknown and critical

🎀 get_condensed_logs 🎀

get_condensed_logs()

returns an array of hashes with the condensed log used for this report. condensed, like a little summary, cute and compact 🍓

💅 get_full_logs 💅

get_full_logs()

returns an array of hashes with the full log used for this report. the full tea, unfiltered ☕

💀 BUGS 💀

Please report any bugs or feature requests to <http://github.com/sni/Monitoring-Availability/issues>. don't suffer in silence bestie, tell the devs 🙈

🔥 DEBUGING 🔥

You may enable the debug mode by setting MONITORING_AVAILABILITY_DEBUG environment variable. This will create a logfile: /tmp/Monitoring-Availability-Debug.log which gets overwritten with every calculation — yes, EVERY time, so don't get attached to what's in there 😭. You will need the Log4Perl module to create this logfile.

⭐ SEE ALSO ⭐

You can also look for information at:

  • Search CPAN

<http://search.cpan.org/dist/Monitoring-Availability/>

  • Github

<http://github.com/sni/Monitoring-Availability>

👑 AUTHOR 👑

Sven Nierlein, <nierlein@cpan.org> — absolute legend, we stan 💜

Copyright (C) 2010 by Sven Nierlein

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

and that's the whole page, bestie!! 🫶 this was perl v5.20.1, dated 2014-10-25, and it slayed then and it slays now. go calculate some availability, you got this 💖✨

📦 where this page comes from