NAME

FlightRecorder::Plugin::ReportSuccinct

ABSTRACT

Succinct FlightRecorder Report Generator

SYNOPSIS

  package main;

  use FlightRecorder;
  use FlightRecorder::Plugin::ReportSuccinct;

  my $f = FlightRecorder->new(auto => undef);
  my $r = FlightRecorder::Plugin::ReportSuccinct->new(flight_recorder => $f);

  $f->begin('main');
  $f->debug('something happened');
  $f->end;

  my $reporter = $r;

DESCRIPTION

This package provides a mechanism for converting a FlightRecorder event log into a printable report.

INHERITS

This package inherits behaviors from:

FlightRecorder::Plugin::Report

LIBRARIES

This package uses type constraints from:

Types::Standard

ATTRIBUTES

This package has the following attributes:

flight_recorder

  flight_recorder(InstanceOf['FlightRecorder'])

This attribute is read-only, accepts (InstanceOf['FlightRecorder']) values, and is required.

level

  level(Enum[qw(debug info warn error fatal)])

This attribute is read-write, accepts (Enum[qw(debug info warn error fatal)]) values, and is optional.

METHODS

This package implements the following methods:

generate

  generate() : Str

The generate method generates a succint report of activity captured by FlightRecorder.

generate example #1

  # given: synopsis

  $r->generate

output

  output() : Str

The output method generates a verbose report of activity captured by FlightRecorder and prints it to STDOUT.

output example #1

  # given: synopsis

  $r->output

AUTHOR

Al Newkirk, awncorp@cpan.org

LICENSE

Copyright (C) 2011-2019, Al Newkirk, et al.

This is free software; you can redistribute it and/or modify it under the terms of the The Apache License, Version 2.0, as elucidated in the "license file".

PROJECT

Wiki

Project

Initiatives

Milestones

Contributing

Issues

cpanm FlightRecorder

perl -MCPAN -e shell
install FlightRecorder