callstat

Documentation

Overview

Package callstat provides a few convenient types for tracking function call statistics. It is useful for any system that tracks local or remote procedure call durations or automatically retries failed calls.

Index

• type Call
  • func (c *Call) Add(inner *Call)
  • func (c *Call) Begin(description string)
  • func (c *Call) Complete(err error)
  • func (c *Call) Duration() time.Duration
  • func (c Call) String() string

Types

type Call

type Call struct {
	// Description is a textual description of the call.
	Description string
	// Start is the time at which the call started.
	Start time.Time
	// End is the time at which the call ended or timed out.
	End time.Time
	// Err is the error returned from unsuccessful calls.
	Err error
	// Inner is the set of internal subcalls that were made as part of the call.
	Inner []Call
}

Call represents information about a function call.

func (*Call) Add

func (c *Call) Add(inner *Call)

Add adds the given call as inner call.

func (*Call) Begin

func (c *Call) Begin(description string)

Begin sets the call description and records the current time as the start of the call.

func (*Call) Complete

func (c *Call) Complete(err error)

Complete sets the call error state and records the current time as the end of the call.

If the call was not previously started, Complete assumes that the start and end times of the call are equal.

func (*Call) Duration

func (c *Call) Duration() time.Duration

Duration is the total wall time it took to make the call.

func (Call) String

func (c Call) String() string

String returns a string representation of the call data.