service

Documentation

Index

• func BeforeRun()
• func Cleanup()
• func HandleSignals(stopFunction func(), cancel context.CancelFunc)
• func NotifyTermination()
• func ProcessWindowsControlEvents(stopCallback func())
• func ProfileEnabled() bool
• func WaitExecutionDone()

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(), cancel context.CancelFunc)

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 NotifyTermination

func NotifyTermination()

NotifyTermination tells the OS that the service is stopped.

func ProcessWindowsControlEvents

func ProcessWindowsControlEvents(stopCallback func())

ProcessWindowsControlEvents is not used on non-windows platforms.

func ProfileEnabled

func ProfileEnabled() bool

ProfileEnabled checks whether the beat should write a cpu or memory profile.

func WaitExecutionDone

func WaitExecutionDone()

WaitExecutionDone is not used on non-windows platforms.