Cronitor API Client

Cronitor is a service for heartbeat-style monitoring of anything that can send an HTTP request. It's particularly well suited for monitoring cron jobs, Jenkins jobs, or any other scheduled task.

Supported APIs

This .NET library provides a simple way of pinging a Cronitor monitor. For a better understanding of the API this library talks to, please see the documentation, links below.

• Activity API
• Issues API
• Monitor API
• Notifications API
• Telemetry API

Install

You can download the cronitor client nuget. https://www.nuget.org/packages/Cronitor

Usage

For the full documentation please read our wiki, telemetry wiki!

NET Generic Host

If you're using .NET HostBuilder and utilizing the default hosting and startup pattern (Microsoft.Extensions.Hosting).

The easiest way to use the client is to run .UseCronitor(), this will create a static instance (Cronitor) of the client that can be used throughout your application.

Examples

await Host.CreateDefaultBuilder()
    .UseCronitor("apiKey")
    .Build()
    .RunAsync();

await Host.CreateDefaultBuilder()
    .UseCronitor((context) => context.Configuration.GetValue<string>("Cronitor:ApiKey"))
    .Build()
    .RunAsync();

And then you'll be able to use it like this:

public class SomeClass
{
    public Monitor Create()
    {
        var monitor = new Monitor();
        var request = new CreateMonitorRequest(monitor);
        var response = Cronitor.Monitors.Create(request);

        return response;
    }

    public async Task<Monitor> CreateAsync()
    {
        var monitor = new Monitor();
        var request = new CreateMonitorRequest(monitor);
        var response = await Cronitor.Monitors.CreateAsync(request);

        return resposne;
    }
}

If you much rather like to use each client (IssuesClient, MonitorsClient, NotificationsClient or TelemetriesClient) you can use each client on its own by running .ConfigureCronitor() instead, this will not configure the static client.

Examples

await Host.CreateDefaultBuilder()
    .ConfigureCronitor("apiKey")
    .Build()
    .RunAsync();

await Host.CreateDefaultBuilder()
    .ConfigureCronitor((context) => context.Configuration.GetValue<string>("Cronitor:ApiKey"))
    .Build()
    .RunAsync();

And then you'll be able to use it like this:

public class SomeClass
{
    private readonly IMonitorsClient _monitorsClient;

    public SomeClass(IMonitorsClient monitorsClient)
    {
        _monitorsClient = monitorsClient;
    }
    
    public Monitor Create()
    {
        var monitor = new Monitor();
        var request = new CreateMonitorRequest(monitor);
        var response = _monitorsClient.Create(request);

        return response;
    }

    public async Task<Monitor> CreateAsync()
    {
        var monitor = new Monitor();
        var request = new CreateMonitorRequest(monitor);
        var response = await _monitorsClient.CreateAsync(request);

        return resposne;
    }
}

Simple

Examples

using Cronitor.Models;
using Cronitor.Requests;

Cronitor.Configure("apiKey")

var monitor = new Monitor();
var request = new CreateMonitorRequest(monitor);
var response = Cronitor.Monitors.Create(request);

Manual

If you only need access to one (or a few) clients you're able to configure each client individually.

Examples

using Cronitor.Models;
using Cronitor.Requests;

public class SomeClass
{
    private readonly IMonitorsClient _monitorsClient;

    public SomeClass()
    {
        _monitorsClient = new IMonitorsClient("apiKey");
    }

    public Monitor Create()
    {
        var monitor = new Monitor();
        var request = new CreateMonitorRequest(monitor);
        var response = _monitorsClient.Create(request);

        return response;
    }

    public async Task<Monitor> CreateAsync()
    {
        var monitor = new Monitor();
        var request = new CreateMonitorRequest(monitor);
        var response = await _monitorsClient.CreateAsync(request);

        return resposne;
    }
}

Development

Suggestions

• Add support for Quartz.NET Jobs
• Implement Timezone constant (if not too big of a hassle to maintain)
• Implement cron expression-language (if found as needed?)
• Implement Cronitor assertions-language (if found as needed?)

Contributing

Pull requests and features are happily considered! By participating in this project you agree to abide by the Code of Conduct.

To contribute

Fork, then clone the repo:

git clone git@github.com:your-username/Cronitor.git

Push to your fork and submit a pull request