agent

Documentation

Overview

Package agent provides hooks programs can register to retrieve diagnostics data by using gops.

Index

• func Close()
• func Listen(opts *Options) error
• type Options

Functions

func Close

func Close()

Close closes the agent, removing temporary files and closing the TCP listener. If no agent is listening, Close does nothing.

func Listen

func Listen(opts *Options) error

Listen starts the gops agent on a host process. Once agent started, users can use the advanced gops features. The agent will listen to Interrupt signals and exit the process, if you need to perform further work on the Interrupt signal use the options parameter to configure the agent accordingly.

Note: The agent exposes an endpoint via a TCP connection that can be used by any program on the system. Review your security requirements before starting the agent.

Types

type Options

type Options struct {
	// Addr is the host:port the agent will be listening at.
	// Optional.
	Addr string

	// NoShutdownCleanup tells the agent not to automatically cleanup
	// resources if the running process receives an interrupt.
	// Optional.
	NoShutdownCleanup bool
}

Options allows configuring the started agent.