package perf

import "github.com/apache/beam/sdks/go/pkg/beam/x/hooks/perf"

Package perf is to add performance measuring hooks to a runner, such as cpu, heap, or trace profiles.

Index ¶

• func EnableHeapCaptureHook(name string, opts ...string)
• func EnableProfCaptureHook(name string, opts ...string)
• func EnableTraceCaptureHook(name string, opts ...string)
• func RegisterHeapCaptureHook(name string, c CaptureHookFactory)
• func RegisterProfCaptureHook(name string, c CaptureHookFactory)
• func RegisterTraceCaptureHook(name string, c CaptureHookFactory)
• type CaptureHook
• type CaptureHookFactory

Package Files ¶

perf.go

func EnableHeapCaptureHook ¶ Uses

func EnableHeapCaptureHook(name string, opts ...string)

EnableHeapCaptureHook actives a registered heap profile capture hook for a given pipeline.

func EnableProfCaptureHook ¶ Uses

func EnableProfCaptureHook(name string, opts ...string)

EnableProfCaptureHook actives a registered profile capture hook for a given pipeline.

func EnableTraceCaptureHook ¶ Uses

func EnableTraceCaptureHook(name string, opts ...string)

EnableTraceCaptureHook actives a registered profile capture hook for a given pipeline.

func RegisterHeapCaptureHook ¶ Uses

func RegisterHeapCaptureHook(name string, c CaptureHookFactory)

RegisterHeapCaptureHook registers a CaptureHookFactory for the supplied identifier. It panics if the same identifier is registered twice.

func RegisterProfCaptureHook ¶ Uses

func RegisterProfCaptureHook(name string, c CaptureHookFactory)

RegisterProfCaptureHook registers a CaptureHookFactory for the supplied identifier. It panics if the same identifier is registered twice.

func RegisterTraceCaptureHook ¶ Uses

func RegisterTraceCaptureHook(name string, c CaptureHookFactory)

RegisterTraceCaptureHook registers a CaptureHookFactory for the supplied identifier. It panics if the same identifier is registered twice.

type CaptureHook ¶ Uses

type CaptureHook func(context.Context, string, io.Reader) error

CaptureHook is used by the harness to have the runner persist a trace record with the supplied name and comment. The type of trace can be determined by the prefix of the string.

* prof: A profile compatible with traces produced by runtime/pprof * trace: A trace compatible with traces produced by runtime/trace

type CaptureHookFactory ¶ Uses

type CaptureHookFactory func([]string) CaptureHook

CaptureHookFactory creates a CaptureHook from the supplied options.