# Quartzmon

**Repository Path**: StudioDo/Quartzmon

## Basic Information

- **Project Name**: Quartzmon
- **Description**: No description available
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-16
- **Last Updated**: 2024-04-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
    <h1>Quartzmon</h1>
</p>

---

[![NuGet](https://img.shields.io/nuget/v/Quartzmon.svg)](https://www.nuget.org/packages/Quartzmon/)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)

Quartzmon is a fork of [Quartzmin](https://github.com/jlucansky/Quartzmin).

This fork was created to add the following features:
- Support for .NET Core 3.1, including for the SelfHost package
- Use local time instead of UTC, as well as date formatting
- Create a new forked Nuget package to make these features available easily via Nuget

Quartzmon is powerful, easy to use web management tool for Quartz.NET

Quartzmon can be used within your existing application with minimum effort as a Quartz.NET plugin when it automatically creates embedded web server. Or it can be plugged into your existing OWIN-based web application as a middleware.

> [Quartz.NET](https://www.quartz-scheduler.net) is a full-featured, open source job scheduling system that can be used from smallest apps to large scale enterprise systems.

![Demo](https://raw.githubusercontent.com/jlucansky/public-assets/master/Quartzmin/demo.gif)

The goal of this project is to provide convenient tool to utilize most of the functionality that Quartz.NET enables. The biggest challenge was to create a simple yet effective editor of job data map which is heart of Quartz.NET. Every job data map item is strongly typed and Quartzmon can be easily extended with a custom editor for your specific type beside standard supported types such as String, Integer, DateTime and so on. 

Quartzmon was created with **Semantic UI** and **Handlebars.Net** as the template engine.

## Features
- Add, modify jobs and triggers
- Add, modify calendars (Annual, Cron, Daily, Holiday, Monthly, Weekly)
- Change trigger type to Cron, Simple, Calendar Interval or Daily Time Interval
- Set typed job data map values (bool, DateTime, int, float, long, double, decimal, string, byte[])
- Create custom type editor for complex type in job data map
- Manage scheduler state (standby, shutdown)
- Pause and resume job and trigger groups
- Pause and resume triggers individually
- Pause and resume all triggers for specific job
- Trigger specific job immediately
- Watch currently executing jobs
- Interrupt executing job
- See next scheduled dates for Cron
- See recent job history, state and error messages

## Install
Quartzmon is available on [nuget.org](https://www.nuget.org/packages/Quartzmon/)

To install Quartzmon, run the following command in the Package Manager Console
```powershell
PM> Install-Package Quartzmon
```
## Minimum requirements
- .NET Framework 4.5.2 
- .NET Standard 2.0
- .NET Core 2.0

## Usage
### Embedded web server
Everything you should do is just install [Quartzmon.SelfHost](https://www.nuget.org/packages/Quartzmon.SelfHost/) package and configure `QuartzmonPlugin` and `ExecutionHistoryPlugin` to support histograms and statistics.

Run the following command in the Package Manager Console:
```powershell
PM> Install-Package Quartzmon.SelfHost
```
Add to your `App.config` file:
```xml
<configuration>
  <configSections>
    <section name="quartz" type="System.Configuration.NameValueFileSectionHandler" />
  </configSections>

  <quartz>
    <add key="quartz.plugin.recentHistory.type" value="Quartzmon.Plugins.RecentHistory.ExecutionHistoryPlugin, Quartzmon.Plugins.RecentHistory" />
    <add key="quartz.plugin.recentHistory.storeType" value="Quartzmon.Plugins.RecentHistory.Impl.InProcExecutionHistoryStore, Quartzmon.Plugins.RecentHistory" />

    <add key="quartz.plugin.quartzmon.type" value="Quartzmon.SelfHost.QuartzmonPlugin, Quartzmon.SelfHost" />
    <add key="quartz.plugin.quartzmon.url" value="http://*:333" />
    <add key="quartz.plugin.quartzmon.useLocalTime" value="true" />
    <add key="quartz.plugin.quartzmon.defaultDateFormat" value="MM/dd/yyyy" />
  </quartz>
</configuration>
```
Start Quartz.NET scheduler somewhere:
```csharp
StdSchedulerFactory.GetDefaultScheduler().Result.Start();
```

### OWIN middleware
Add to your `Startup.cs` file:
```csharp
public void Configuration(IAppBuilder app)
{
    app.UseQuartzmon(new QuartzmonOptions()
    {
        Scheduler = StdSchedulerFactory.GetDefaultScheduler().Result
    });
}
```

### ASP.NET Core middleware
Add to your `Startup.cs` file:
```csharp
public void ConfigureServices(IServiceCollection services)
{
    services.AddQuartzmon();
}

public void Configure(IApplicationBuilder app)
{
    app.UseQuartzmon(new QuartzmonOptions()
    {
        Scheduler = StdSchedulerFactory.GetDefaultScheduler().Result
    });
}
```

## Notes
In clustered environment, it make more sense to host Quarzmon on single dedicated Quartz.NET node in standby mode and implement own `IExecutionHistoryStore` depending on database or ORM framework you typically incorporate. Every clustered Quarz.NET node should be configured with `ExecutionHistoryPlugin` and only dedicated node for management may have `QuartzmonPlugin`.


## License
This project is made available under the MIT license. See [LICENSE](LICENSE) for details.