performance

Documentation

Overview

Copyright 2021 k0s authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type Timer
  • func NewTimer(name string) *Timer
  • func (t *Timer) Buffer() *Timer
  • func (t *Timer) Checkpoint(name string)
  • func (t *Timer) Output()
  • func (t *Timer) Start() *Timer

Types

type Timer

type Timer struct {
	// contains filtered or unexported fields
}

The Timer is a performance measuring tool. You should enable bufferOutput if you want to programmatically decide when to output messages. If buffering is disabled, Checkpoint timings will be logged immediately when recorded. Buffering can be useful when you want to see all the recorded timings in a single place, to make comparison easy.

func NewTimer

func NewTimer(name string) *Timer

func (*Timer) Buffer

func (t *Timer) Buffer() *Timer

Buffer will enable buffering

func (*Timer) Checkpoint

func (t *Timer) Checkpoint(name string)

Checkpoint records the time since the timer was started

func (*Timer) Output

func (t *Timer) Output()

Output will loop through the message buffer and output all messages in order.

func (*Timer) Start

func (t *Timer) Start() *Timer

Start will start the timer. It returns itself to allow easy chaining of create + start