https://github.com/songmu/p5-app-runcron

https://github.com/songmu/p5-app-runcron

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/songmu/p5-app-runcron
• Owner: Songmu
• License: other
• Created: 2013-10-19T20:09:14.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2014-12-21T07:14:12.000Z (almost 10 years ago)
• Last Synced: 2024-10-11T21:09:53.853Z (27 days ago)
• Language: Perl
• Size: 453 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/Songmu/p5-App-RunCron.svg?branch=master)](https://travis-ci.org/Songmu/p5-App-RunCron) [![Coverage Status](https://img.shields.io/coveralls/Songmu/p5-App-RunCron/master.svg)](https://coveralls.io/r/Songmu/p5-App-RunCron?branch=master)

# NAME

App::RunCron - making wrapper script for crontab

# SYNOPSIS

    use App::RunCron;

    my $runner = App::RunCron->new(

        timestamp => 1,

        command   => [@ARGV],

        logfile   => 'tmp/log%Y-%m-%d.log',

        reporter  => 'Stdout',

        error_reporter => [

            'Stdout',

            'File', {

                file => 'tmp/error%Y-%m-%d.log'

            },

        ],

    );

    $runner->run;

# DESCRIPTION

App::RunCron is a software for making wrapper script for running cron tasks.

App::RunCron can separate reporting way if the command execution success or failed

(i.e. fails to start, or returns a non-zero exit code, or killed by a signal).

It is handled by \`reporter\` and \`error\_reporter\` option.

By default, \`reporter\` is 'None' and \`error\_reporter\` is 'Stdout'.

It prints the outputs the command if and only if the command execution failed.

In other words, this behaviour causes [cron(8)](http://man.he.net/man8/cron) to send mail when and only when an error occurs.

Default behaviour is same like [cronlog](https://github.com/kazuho/kaztools/blob/master/cronlog).

# OPTIONS

## timestamp

Add timestamp or not. (Default: undef)

## tag

Identifier of the job name. (Optional)

## command

command to be executed. (Required)

## logfile

If logfile is specified, stdout and stderr of the command will be logged to the file so that it could be used for later inspection. 

If not specified, the outputs will not be logged.

The logfile can be a `strftime` format. eg. '%Y-%m-%d.log'. (NOTICE: '%' must be escaped in crontab.)

## reporter|error\_reporter|common\_reporter

`common_reporter` is optional, processing after `(error_)?reporter` is handled.

The `reporter`, `error_reporter` and `common_reporter` can be like following.

- `$module_name`

- `[$module_name[, \%opt], ...]`

- `$coderef`

_$module\_name_ package name of the plugin. You can write it as two form like [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware):

    reporter => 'Stdout',    # => loads App::RunCron::Reporter::Stdout

If you want to load a plugin in your own name space, use the '+' character before a package name, like following:

    reporter => '+MyApp::Reporter::Foo', # => loads MyApp::Reporter::Foo

## announcer

Package name of an "Announcer" which announce job information before running the job. (Optional)

## METHODS AND ACCESORS

### `$self->run`

Running the job.

### `my $str = $self->result_line`

One line result string of the command.

### `my $str = $self->report`

Retrieve the output of the command.

### `my $bool = $self->is_success`

command is success or not.

### `my $int = $self->exit_code`

same as `$?`

### `my $int = $self->child_exit_code`

exit code of child process.

### `my $int = $self->child_signal`

signal number if chile process accepted a signal.

# SEE ALSO

[runcron](https://metacpan.org/pod/runcron), [cronlog](https://github.com/kazuho/kaztools/blob/master/cronlog)

# LICENSE

Copyright (C) Songmu.

This library is free software; you can redistribute it and/or modify

it under the same terms as Perl itself.

# AUTHOR

Songmu