Skip to main content

Basic monitoring tool designed for rapid deployment and simple results.

Project description

uptimecurl

Basic monitoring tool designed for rapid deployment and simple results.

Scheduled monitoring, dashboards, alerts and other advanced features are out of scope. Instead consider tools like crontab, Cockpit, Grafana or Zabbix.

Usage

Usage: uptimecurl [OPTIONS]

  Basic monitoring tool designed for rapid deployment and simple results.

  Define tests in the DEFINITION file and template in the TEMPLATE file.
  Report is generated at the OUTPUT path.

  Instead of command-line parameters you can use the environment variables
  UPTIMECURL_DEFINITION, UPTIMECURL_TEMPLATE and UPTIMECURL_OUTPUT. These
  can be defined in a .env file in the working directory.

Options:
  --definition FILE  List of test definitions (YAML).
  --template FILE    Template to generate report from test results (Mustache).
  --output FILE      Output path for report (typically HTML).
  --help             Show this message and exit.

Sample definition

example_http:
    type: http_ok
    parameters:
      - http://en.wikipedia.org
example_port:
    type: port_ok
    parameters:
      - en.wikipedia.org
      - 443

Sample template

See https://mustache.github.io/mustache.5.html for template language.

<tbody>
{{#data}}
  <tr>
    <td title="{{timestamp}}">
      {{name}}
    </td>
    <td title="{{parameters}}">
      {{type}}
    </td>
    <td title="{{message}}">
      {{success_code}}
    </td>
  </tr>
{{/data}}
</tbody>

Sample report

Run uptimecurl without parameters to generate this sample report in HTML (hover or view source on each cell for more detail):

Name Test Result
example_http http_ok
example_port port_ok 💚

Test types

http_ok

test_name:
    type: http_ok
    parameters:
      - https://example.com/path

Perform an HTTP request against any URL (parameter 0).

Return 💚 if we get a 200 OK response, ❌ otherwise.

Note that we expect strictly a 200 OK reponse. Redirects and other values will result in a failure. (See the sample report for an example of a failure.)

port_ok

test_name:
    type: port_ok
    parameters:
      - domain.com
      - 1234

Attempt to connect to domain:port (parameter 0, parameter 1).

Return 💚 if successful, ❌ otherwise.

Note that an open port does not guarantee that the underlying application is working, just that the server is up and correctly configured.

Development environment

Install prerequisites

  • Python 3.10
  • pdm
  • make

Instructions

  • Fork the upstream repository.
  • git clone [fork-url]
  • cd [project-folder]
  • Run make develop to initialise your development environment.

You can use any text editor or IDE that supports virtualenv / pdm. See the Makefile for toolchain details.

Please make test and make lint before submitting changes.

Make targets

USAGE: make [target]

help    : Show this message.
develop : Set up Python development environment.
run     : Run from source.
clean   : Remove all build artefacts.
test    : Run tests and generate coverage report.
lint    : Fix or warn about linting errors.
build   : Clean, test, lint, then generate new build artefacts.
publish : Upload build artefacts to PyPI.

Sharing and contributions

uptimecurl
https://lofidevops.neocities.org
Copyright 2020 David Seaward and contributors
SPDX-License-Identifier: AGPL-3.0-or-later

Shared under AGPL-3.0-or-later. We adhere to the Contributor Covenant 2.1, and certify origin per DCO 1.1 with a signed-off-by line. Contributions under the same terms are welcome.

Submit security and conduct issues as private tickets. Sign commits with git commit --signoff. For a software bill of materials run reuse spdx. For more details see CONDUCT, COPYING and CONTRIBUTING.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uptimecurl-0.1.5.tar.gz (34.6 kB view details)

Uploaded Source

Built Distribution

uptimecurl-0.1.5-py3-none-any.whl (43.7 kB view details)

Uploaded Python 3

File details

Details for the file uptimecurl-0.1.5.tar.gz.

File metadata

  • Download URL: uptimecurl-0.1.5.tar.gz
  • Upload date:
  • Size: 34.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.5.2 CPython/3.10.6

File hashes

Hashes for uptimecurl-0.1.5.tar.gz
Algorithm Hash digest
SHA256 786fa6b247f0181028b8c67e391f0a291b07c0a09ac78f9719d08b7a03f8db49
MD5 aaad2d4ef6e22a1a3bafdec679b918bd
BLAKE2b-256 9167a3ae3fceeea8315fb45d4c72abb1f114680f951508f77d06150edabd02f0

See more details on using hashes here.

File details

Details for the file uptimecurl-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: uptimecurl-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 43.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.5.2 CPython/3.10.6

File hashes

Hashes for uptimecurl-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 eb929caaf328e10d941a37ad197346e5ebebf1d8e7d1670955d84512d987f889
MD5 798cf6a3356448c32dbdab5dd0e700e8
BLAKE2b-256 a50c792ec8cd42f764cfa215087ff5583d1493814bded400616466d0c0d5e2f0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page