smon

KO | EN

gitlite — search

#hacktoberfest #react #typescript #llm #go #machine-learning #rust #java #awesome #kubernetes #vue #security #mcp #open-source

(★ 8)

simple service monitoring

smon Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# smon

Simple MONitoring tool

## Features

`smon` includes these probes:
   - **TCP** for testing TCP connections;
   - **HTTP** for testing HTTP responses, status codes and response lengths;
   - **PING** for testing ICMP replies;
   - **CERT** for validating X.509 certificates and days until their expiration.

The following reporting methods are available:
   - setting an **exit code**;
   - logging to a **standard output**;
   - mailing via **sendmail**;
   - writing to a **syslog**;
   - making an **HTTP request** (chat bots and other external tools).

## Installation

```
git clone https://github.com/ondras/smon.git
```

## Configuration

1. Create the `conf/` subdirectory
  1. Put all your configuration inside:
    1. Configuration files are CommonJS modules (i.e. JavaScript files)
    1. All files in `conf/` are used; you can either create one-file-per-configuration-element or use one file for all configuration
    1. The `conf-example/` directory shows several examples for probes and reporters

The configuration API has these methods:

```js
require("..").addProbe({ /* probe configuration */ });
require("..").addReporter({ /* reporter configuration */ });
require("..").configure({ /* global options */ });
```

A very simple configuration might look like this:
```js
var app = require("..");

// make sure this web is reachable
app.addProbe({
   type: "http",
   url: "http://www.example.com/",
   status: 200
});

// if not, send me an e-mail
app.addReporter({
   type: "sendmail",
   to: "user@example.com",
   subject: "smon probe failure"
});
```

## Running

```
node .
```

If you have a recent node (6.2+) and your symlinked conffiles are broken, try:

```
node --preserve-symlinks .
```

## Why?

I needed something trivial, easy-to-configure, easy-to-hack. `smon` is written in less than 9kB of JS. Also, I needed a new pet project for my *start learning vim again* chore.

smon

smon Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

smon

smon Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README