agent

package

v2.10.2 Latest Latest Go to latest Published: Apr 22, 2024 License: AGPL-3.0 Imports: 52 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/coder/coder

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
func PrometheusMetricsHandler(prometheusRegistry *prometheus.Registry, logger slog.Logger) http.Handler
type Agent
- func New(options Options) Agent
type Client
type Options
type PostWorkspaceAgentAppHealth
type WorkspaceAgentApps
type WorkspaceAppHealthReporter
- func NewWorkspaceAppHealthReporter(logger slog.Logger, apps []codersdk.WorkspaceApp, ...) WorkspaceAppHealthReporter

Constants ¶

View Source

const (
	ProtocolReconnectingPTY = "reconnecting-pty"
	ProtocolSSH             = "ssh"
	ProtocolDial            = "dial"
)

View Source

const (
	EnvProcPrioMgmt = "CODER_PROC_PRIO_MGMT"
	EnvProcOOMScore = "CODER_PROC_OOM_SCORE"
)

EnvProcPrioMgmt determines whether we attempt to manage process CPU and OOM Killer priority.

View Source

const EnvAgentSubsystem = "CODER_AGENT_SUBSYSTEM"

EnvAgentSubsystem is the environment variable used to denote the specialized environment in which the agent is running (e.g. envbox, envbuilder).

Variables ¶

This section is empty.

Functions ¶

func PrometheusMetricsHandler ¶ added in v2.10.0

func PrometheusMetricsHandler(prometheusRegistry *prometheus.Registry, logger slog.Logger) http.Handler

Types ¶

type Agent ¶

type Agent interface {
	HTTPDebug() http.Handler
	// TailnetConn may be nil.
	TailnetConn() *tailnet.Conn
	io.Closer
}

func New ¶

func New(options Options) Agent

type Client ¶

type Client interface {
	ConnectRPC(ctx context.Context) (drpc.Conn, error)
	RewriteDERPMap(derpMap *tailcfg.DERPMap)
}

type Options ¶

type Options struct {
	Filesystem                   afero.Fs
	LogDir                       string
	TempDir                      string
	ScriptDataDir                string
	ExchangeToken                func(ctx context.Context) (string, error)
	Client                       Client
	ReconnectingPTYTimeout       time.Duration
	EnvironmentVariables         map[string]string
	Logger                       slog.Logger
	IgnorePorts                  map[int]string
	PortCacheDuration            time.Duration
	SSHMaxTimeout                time.Duration
	TailnetListenPort            uint16
	Subsystems                   []codersdk.AgentSubsystem
	Addresses                    []netip.Prefix
	PrometheusRegistry           *prometheus.Registry
	ReportMetadataInterval       time.Duration
	ServiceBannerRefreshInterval time.Duration
	Syscaller                    agentproc.Syscaller
	// ModifiedProcesses is used for testing process priority management.
	ModifiedProcesses chan []*agentproc.Process
	// ProcessManagementTick is used for testing process priority management.
	ProcessManagementTick <-chan time.Time
}

type PostWorkspaceAgentAppHealth ¶

type PostWorkspaceAgentAppHealth func(context.Context, agentsdk.PostAppHealthsRequest) error

PostWorkspaceAgentAppHealth updates the workspace app health.

type WorkspaceAgentApps ¶

type WorkspaceAgentApps func(context.Context) ([]codersdk.WorkspaceApp, error)

WorkspaceAgentApps fetches the workspace apps.

type WorkspaceAppHealthReporter ¶

type WorkspaceAppHealthReporter func(ctx context.Context)

WorkspaceAppHealthReporter is a function that checks and reports the health of the workspace apps until the passed context is canceled.

func NewWorkspaceAppHealthReporter ¶

func NewWorkspaceAppHealthReporter(logger slog.Logger, apps []codersdk.WorkspaceApp, postWorkspaceAgentAppHealth PostWorkspaceAgentAppHealth) WorkspaceAppHealthReporter

NewWorkspaceAppHealthReporter creates a WorkspaceAppHealthReporter that reports app health to coderd.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
agentproc Package agentproc contains logic for interfacing with local processes running in the same context as the agent.	Package agentproc contains logic for interfacing with local processes running in the same context as the agent.
agentproctest Package agentproctest contains utility functions for testing process management in the agent.	Package agentproctest contains utility functions for testing process management in the agent.
agentscripts
agentssh
agenttest
proto
reaper Package reaper contains logic for reaping subprocesses.	Package reaper contains logic for reaping subprocesses.
reconnectingpty
usershell

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL