https://github.com/grantstreetgroup/p5-healthcheck-diagnostic-remotehealth

Perl HealthCheck Diagnostic for verifying remote HTTP health - https://grantstreetgroup.github.io/HealthCheck.html
https://github.com/grantstreetgroup/p5-healthcheck-diagnostic-remotehealth

Last synced: about 1 month ago
JSON representation

Perl HealthCheck Diagnostic for verifying remote HTTP health - https://grantstreetgroup.github.io/HealthCheck.html

• Host: GitHub
• URL: https://github.com/grantstreetgroup/p5-healthcheck-diagnostic-remotehealth
• Owner: GrantStreetGroup
• License: other
• Created: 2021-11-01T21:20:10.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-16T18:57:21.000Z (3 months ago)
• Last Synced: 2024-10-18T17:46:52.199Z (3 months ago)
• Language: Perl
• Size: 17.6 KB
• Stars: 2
• Watchers: 7
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# NAME

HealthCheck::Diagnostic::RemoteHealth - Get results from an HTTP HealthCheck

# VERSION

version v0.1.2

# SYNOPSIS

Returns the decoded JSON object from a HTTP HealthCheck endpoint.

    $health_check->register(

        HealthCheck::Diagnostic::RemoteHealth->new(

            url => "https://example.com/healthz",

        )

    );

# DESCRIPTION

Takes in a `url` to a HealthCheck JSON endpoint

and checks to see if a connection can be made.

If the connection fails or the JSON object cannot be decoded,

the `status` is set to "CRITICAL".

If both the connection succeeds and the JSON object is successfully decoded,

it returns the decoded JSON object from the remote endpoint.

# ATTRIBUTES

This diagnostic inherits all attributes from

[HealthCheck::Diagnostic::WebRequest](https://metacpan.org/pod/HealthCheck%3A%3ADiagnostic%3A%3AWebRequest) in addition to its own.

`status_code` is by default set to "200, 503".

## url

The URL to the remote HealthCheck JSON endpoint. This typically ends in

"_/healthz_".

# DEPENDENCIES

- [HealthCheck::Diagnostic::WebRequest](https://metacpan.org/pod/HealthCheck%3A%3ADiagnostic%3A%3AWebRequest)

- [JSON](https://metacpan.org/pod/JSON)

# AUTHOR

Grant Street Group 

# COPYRIGHT AND LICENSE

This software is Copyright (c) 2021 - 2024 by Grant Street Group.

This is free software, licensed under:

    The Artistic License 2.0 (GPL Compatible)