Menu

## SamplingHandler extends AbstractHandler
in package

SamplingHandler.php : 30

Sampling handler

A sampled event stream can be useful for logging high frequency events in a production environment where you only need an idea of what is happening and are not concerned with capturing every occurrence. Since the decision to handle or not handle a particular event is determined randomly, the resulting sampled log is not guaranteed to contain 1/N of the events that occurred in the application, but based on the Law of large numbers, it will tend to be close to this ratio with a large number of attempts.

##### Tags

author

  Bryan Davis bd808@wikimedia.org

author

  Kunal Mehta legoktm@gmail.com

### Table of Contents

$bubble : mixed
$factor : int
$formatter : FormatterInterface
$handler : callable|HandlerInterface
$level : mixed
$processors : mixed
__construct() : mixed
__destruct() : mixed
close() : mixed
  Closes the handler.
getBubble() : bool
  Gets the bubbling behavior.
getFormatter() : FormatterInterface
  Gets the formatter.
getHandler() : HandlerInterface
  Return the nested handler
getLevel() : int
  Gets minimum logging level at which this handler will be triggered.
handle() : mixed
handleBatch() : mixed
  Handles a set of records at once.
isHandling() : bool
  Checks whether the given record will be handled by this handler.
popProcessor() : callable
  Removes the processor on top of the stack and returns it.
pushProcessor() : self
  Adds a processor in the stack.
reset() : mixed
setBubble() : self
  Sets the bubbling behavior.
setFormatter() : self
  Sets the formatter.
setLevel() : self
  Sets minimum logging level at which this handler will be triggered.
getDefaultFormatter() : FormatterInterface
  Gets the default formatter.

### Properties

#### $bubble

AbstractHandler.php : 27
`protected mixed $bubble = true`

#### $factor

SamplingHandler.php : 40
`protected int $factor`

#### $formatter

AbstractHandler.php : 32
`protected FormatterInterface $formatter`

#### $handler

SamplingHandler.php : 35
`protected callable|HandlerInterface $handler`

#### $level

AbstractHandler.php : 26
`protected mixed $level = MonologLogger::DEBUG`

#### $processors

AbstractHandler.php : 33
`protected mixed $processors = array()`

### Methods

#### __construct()

SamplingHandler.php : 46
`public __construct(callable|HandlerInterface $handler, int $factor) : mixed`

##### Parameters

$handler : callable|HandlerInterface

  Handler or factory callable($record|null, $samplingHandler).

$factor : int

  Sample factor

##### Return values

mixed —

#### __destruct()

AbstractHandler.php : 167
`public __destruct() : mixed`

##### Return values

mixed —

#### close()

AbstractHandler.php : 68

Closes the handler.

`public close() : mixed`

This will be called automatically when the object is destroyed

##### Return values

mixed —

#### getBubble()

AbstractHandler.php : 162

Gets the bubbling behavior.

`public getBubble() : bool`

##### Return values

bool —

true means that this handler allows bubbling. false means that bubbling is not permitted.

#### getFormatter()

SamplingHandler.php : 109

Gets the formatter.

`public getFormatter() : FormatterInterface`

##### Return values

FormatterInterface —

#### getHandler()

SamplingHandler.php : 84

Return the nested handler

`public getHandler([array<string|int, mixed> $record = null ]) : HandlerInterface`

If the handler was provided as a factory callable, this will trigger the handler's instantiation.

##### Parameters

$record : array<string|int, mixed> = null

##### Return values

HandlerInterface —

#### getLevel()

AbstractHandler.php : 137

Gets minimum logging level at which this handler will be triggered.

`public getLevel() : int`

##### Return values

int —

#### handle()

SamplingHandler.php : 62
`public handle(array<string|int, mixed> $record) : mixed`

##### Parameters

$record : array<string|int, mixed>

##### Return values

mixed —

#### handleBatch()

AbstractHandler.php : 56

Handles a set of records at once.

`public handleBatch(array<string|int, mixed> $records) : mixed`

##### Parameters

$records : array<string|int, mixed>

  The records to handle (an array of record arrays)

##### Return values

mixed —

#### isHandling()

SamplingHandler.php : 57

Checks whether the given record will be handled by this handler.

`public isHandling(array<string|int, mixed> $record) : bool`

##### Parameters

$record : array<string|int, mixed>

  Partial log record containing only a level key

##### Return values

bool —

#### popProcessor()

AbstractHandler.php : 88

Removes the processor on top of the stack and returns it.

`public popProcessor() : callable`

##### Return values

callable —

#### pushProcessor()

AbstractHandler.php : 75

Adds a processor in the stack.

`public pushProcessor(mixed $callback) : self`

##### Parameters

$callback : mixed

##### Return values

self —

#### reset()

AbstractHandler.php : 178
`public reset() : mixed`

##### Return values

mixed —

#### setBubble()

AbstractHandler.php : 149

Sets the bubbling behavior.

`public setBubble(bool $bubble) : self`

##### Parameters

$bubble : bool

  true means that this handler allows bubbling. false means that bubbling is not permitted.

##### Return values

self —

#### setFormatter()

SamplingHandler.php : 99

Sets the formatter.

`public setFormatter(FormatterInterface $formatter) : self`

##### Parameters

$formatter : FormatterInterface

##### Return values

self —

#### setLevel()

AbstractHandler.php : 125

Sets minimum logging level at which this handler will be triggered.

`public setLevel(int|string $level) : self`

##### Parameters

$level : int|string

  Level or level name

##### Return values

self —

#### getDefaultFormatter()

AbstractHandler.php : 192

Gets the default formatter.

`protected getDefaultFormatter() : FormatterInterface`

##### Return values

FormatterInterface —

## Search results