Image

head

code

root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

README

=begin code :lang<raku>

use Updown;

my $ud = Updown.new;  # assume API key in UPDOWN_API_KEY

my $ud = Updown.new(api-key => "secret-api-key");

for $ud.checks -> (:key($check-id), :value($check)) {
    say "$check.apdex_t() $check.url()"
}

my $event = Updown::Event(%hash);  # inside a webhook

=end code


Updown provides a simple object-oriented interface to the API as provided
by L<Updown.io>, a website monitoring service.


Access to functionality is provided through the C<Updown> class, which has
methods that perform the various functions and return objects in the
C<Updown::> hierarchy of classes.


The L<Updown API|https://updown.io/api> is basically followed to the letter,
with a little caching and some minor functional sugar added.


To be consistent with the names used in the API, all identifiers use
underscores (snake_case) in their names, rather then hyphens (kebab-case).


The C<Updown> object connects the code with all of the monitoring that
has been configured for a user of the L<Updown.io|https://updown.io> service.


The following parameters can be specified when creating the C<Updown> object:


A C<Cro::HTTP::Client> object that will be used to access the API of C<Updown>.
Defaults to a default C<Cro::HTTP::Client> object.


The API key that should be used to authenticate requests with the C<Updown>
API.  Defaults to the C<UPDOWN_API_KEY> environment variable.


Any API key (implicitely) specified will be added to the headers of the
C<client> object used to facilitate authentication.


The following methods are available on the C<Updown> object:


Returns a C<Hash> with C<Updown::Check> objects, keyed to their "check_id".
Takes an optional named boolean argument C<:update> to indicate that
the information should be refreshed if it was already obtained before.


Returns a list of "check_id"s of the C<Updown::Check>s that are being
performed for the user associated with the given API key.  Takes an
optional named boolean argument C<:update> to indicate that the information
should be refreshed if it was already obtained before.


Return the C<Updown::Check> object associated with the given "check_id".
Takes an optional named boolean argument C<:update> to indicate that
the information should be refreshed if it was already obtained before.


Returns a list of up to 100 C<Node::Downtime> objects for the given "check_id".
Takes an optional C<:page> argument to indicate the "page": defaults to C<1>.


Returns a C<Updown::Metric> object for the given "check_id".  Optionally
takes two named arguments.


C<:from>, a C<DateTime> object indicating the B<start> of the period for
which to provide overall metrics.  Defaults to C<DateTime.now.earlier(:1month)>.


C<:to>, a C<DateTime> object indicating the B<end> of the period for which
to provide overal metrics.  Defaults to C<DateTime.now>.


Returns an object C<Hash> of C<Updown::Metrics> objects for the given
"check_id" about overall metrics per hour, keyed to C<DateTime> objects
indicating the hour.  Optionally takes two named arguments.


Returns a C<Hash> of C<Updown::Metrics> objects for the given "check_id" about
overall metrics per monitoring server in the C<Updown.io> network, keyed to
"node_id".  Optionally takes two named arguments.


Returns a C<Hash> with C<Updown::Node> objects, keyed to their "node_id".
Takes an optional named boolean argument C<:update> to indicate that
the information should be refreshed if it was already obtained before.


Returns a list of "node_id"s of the monitoring servers of the C<Updown.io>
network.  Takes an optional named boolean argument C<:update> to indicate
that the information should be refreshed if it was already obtained before.


Return the C<Updown::Node> object associated with the given "node_id".
Takes an optional named boolean argument C<:update> to indicate that
the information should be refreshed if it was already obtained before.


Returns a list of strings with the IPv4 numbers of the nodes in the C<Updown.io>
network that are executing the monitoring checks.  Takes an optional named
boolean argument C<:update> to indicate that the information should be
refreshed if it was already obtained before.


Updown

use v6.d;

unit module unprint:ver<0.0.4>:auth<zef:lizmat>;

# We need nqp ops everywhere here, so make it global
use nqp;

proto sub print(|) is export {*}
multi sub print(str $s)   { nqp::print($s)      }
multi sub print(Str:D $s) { nqp::print($s)      }
multi sub print($s)       { nqp::print($s.Str)  }
multi sub print(*@s)      { nqp::print(@s.join) }

proto sub say(|) is export {*}
multi sub say(str $s)   { nqp::say($s)             }
multi sub say(Str:D $s) { nqp::say($s)             }
multi sub say($s)       { nqp::say($s.gist)        }
multi sub say(*@s)      { nqp::say(@s>>.gist.join) }

proto sub put(|) is export {*}
multi sub put(str $s)   { nqp::say($s)     }
multi sub put(Str:D $s) { nqp::say($s)     }
multi sub put($s)       { nqp::say($s.Str) }
multi sub put(*@s)      { nqp::say(@s.join) }



unprint - provide fast print / say / put


This module provides fast C<print>, C<say> and C<put> subroutines that will
directly write to STDOUT of the OS without any overhead caused by determining
which C<$*OUT> to actually use.  As such, this should give you similar speeds
as Perl 5's output.


Source can be located at: https://github.com/lizmat/unprint . Comments and
Pull Requests are welcome.


This library is free software; you can redistribute it and/or modify it under
the Artistic License 2.0.


unprint

The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


README

NAME

SYNOPSIS

DESCRIPTION

AUTHOR

COPYRIGHT AND LICENSE

unprint v0.0.4

Authors

License

Dependencies

Test Dependencies

Provides

Documentation