https://github.com/alexrogalskiy/http-status-check
An FIP health check to monitor the status of an HTTP endpoint
https://github.com/alexrogalskiy/http-status-check
Last synced: 3 months ago
JSON representation
An FIP health check to monitor the status of an HTTP endpoint
- Host: GitHub
- URL: https://github.com/alexrogalskiy/http-status-check
- Owner: AlexRogalskiy
- License: bsd-3-clause
- Created: 2022-01-18T23:24:37.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T23:34:15.000Z (3 months ago)
- Last Synced: 2025-03-14T00:29:58.243Z (3 months ago)
- Size: 430 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# |  | HTTP status check |
[](https://goreportcard.com/report/github.com/sighupio/http-status-check)
## Table of Contents
1. [Overview](#overview)
1. [Getting Started](#getting-started)
* [Installation](#installation)
* [Usage](#usage)
* [Usage from inside a docker image](#usage-from-inside-a-docker-image)
* [Deploy in a cluster as a Job](#deploy-in-a-cluster-as-a-job)
* [Examples](#examples)
1. [Developer Guide](#developer-guide)
1. [License](#license)
## Overview
`http-status-check` is a tool that monitors the status of HTTP GET endpoints.
The tool can be used to monitor the HTTP endpoints of a service in an Kubernetes
cluster. It check if the service endpoints responds with an HTTP status 200 OK.
* As a Kubernetes Job accessing services in a Kubernetes cluster
* As a standalone binary to check HTTP endpoints availability
## Getting Started
### Installation
The simplest way to use the tool is to install the binary from the source repo
as follows:
* Using Go get
``` sh
$ go get -u github.com/sighupio/http-status-check/cmd/http-status-check
#
```
You should find the CLI installed in the `$GOPATH`. From this point mentioned as
`http-status-check`
### Usage
The basic usage info of the tool can be seen by using the following command:
```sh
$ http-status-check -h
Health check to monitor the http endpoints of a service
Usage:
http-status-check [flags]
Flags:
--config string config file (default is $HOME/.http-status-check.yaml)
-h, --help help for http-status-check
-u, --http-url string HTTP URL to monitor
-l, --log-level string logging level (debug, info...) (default "info")
```
> [Refer this extended documentation on CLI usage for more](./cmd/http-status-check/README.md)
#### Usage from inside a docker image
There is a [Dockerfile bundled](./build/builder/Dockerfile) with this repo which
can be used to build a Docker image and that can be used to run the binary. To
build docker image one can use the make rule `build`. You can read more about
Makefile in [CONTRIBUTING.md](./CONTRIBUTING.md). To build the image:
``` sh
$ make build
# The docker image will be created by the name http-status-check:local-build
```
The above image can be run exactly the way the CLI is used like shown by the
code block below:
``` sh
$ docker run -it status-status-check:local-build -h
Health check to monitor the http endpoints of a service
Usage:
http-status-check [flags]
Flags:
--config string config file (default is $HOME/.http-status-check.yaml)
-h, --help help for http-status-check
-u, --http-url string HTTP URL to monitor
-l, --log-level string logging level (debug, info...) (default "info")
$ docker run -v .kube/:/root/.kube/ -it http-status-check:local-build \
--http-url=http://sighup.io
#
```
### Deploy in a cluster as a Job
As a part of the health check toolkit of Fury Intelligence Platform, this tool
is primary built to work as a Kubernetes Job or CronJob monitoring if an HTTP
GET endpoint is up and responding with 200.
In order to do so, our preferred way of deployment is by using a
kustomization file that deploys the RBAC policy letting the job look into the
services and enpoints in a namespace and the cron job itself.
We ship the deployment files under the `deployment` directory. To
understand the usage of these files in detail head over to the [detailed README of the
directory](./deployments/).
### Examples
TBD of example deployments that are being monitored by our
http-status-check tool can be found in the `examples` directory. Follow
the usage information in the [corresponding README](./examples/) for more info.
## Developer Guide
To set the code up locally, build, run tests, etc. Please refer the
[contributor's guide](./CONTRIBUTING.md).
## License
Check the [License here](LICENSE)