service

Documentation

Index

• func BeforeRun()
• func Cleanup()
• func HandleSignals(stopFunction func())
• func ProcessWindowsControlEvents(stopCallback func())
• func WithCpuProfile() bool
• func WithMemProfile() bool

Functions

func BeforeRun

func BeforeRun()

BeforeRun takes care of necessary actions such as creating files before the beat should run.

func Cleanup

func Cleanup()

Cleanup handles cleaning up the runtime and OS environments. This includes tasks such as stopping the CPU profile if it is running.

func HandleSignals

func HandleSignals(stopFunction func())

HandleSignals manages OS signals that ask the service/daemon to stop. The stopFunction should break the loop in the Beat so that the service shut downs gracefully.

func ProcessWindowsControlEvents

func ProcessWindowsControlEvents(stopCallback func())

ProcessWindowsControlEvents is not used on non-windows platforms.

func WithCpuProfile

func WithCpuProfile() bool

WithCpuProfile returns whether the beat should write the CPU profile file

func WithMemProfile

func WithMemProfile() bool

WithMemProfile returns whether the beat should write the memory profile to file