func AgentScriptFromProto(protoScript *proto.WorkspaceAgentScript) (codersdk.WorkspaceAgentScript,error)

func AgentScriptsFromProto(protoScripts []*proto.WorkspaceAgentScript) ([]codersdk.WorkspaceAgentScript,error)

func AppFromProto(protoApp *proto.WorkspaceApp) (codersdk.WorkspaceApp,error)

func AppHealthPoster(aAPIBatchUpdateAppHealthsClient) func(ctxcontext.Context, reqPostAppHealthsRequest)error

func AppsFromProto(protoApps []*proto.WorkspaceApp) ([]codersdk.WorkspaceApp,error)

func BannerConfigFromProto(sbp *proto.BannerConfig)codersdk.BannerConfig

func DevcontainerFromProto(pdc *proto.WorkspaceAgentDevcontainer) (codersdk.WorkspaceAgentDevcontainer,error)

func DevcontainersFromProto(pdcs []*proto.WorkspaceAgentDevcontainer) ([]codersdk.WorkspaceAgentDevcontainer,error)

func LifecycleStateFromProto(sproto.Lifecycle_State) (codersdk.WorkspaceAgentLifecycle,error)

func LogsNotifyChannel(agentIDuuid.UUID)string

func LogsSenderFlushTimeout(timeouttime.Duration) func(*logsSenderOptions)

func LogsWriter(ctxcontext.Context, sender func(ctxcontext.Context, log ...Log)error, sourceuuid.UUID, levelcodersdk.LogLevel)io.WriteCloser

func MetadataDescriptionFromProto(description *proto.WorkspaceAgentMetadata_Description)codersdk.WorkspaceAgentMetadataDescription

func MetadataDescriptionsFromProto(descriptions []*proto.WorkspaceAgentMetadata_Description) []codersdk.WorkspaceAgentMetadataDescription

func MetadataResultFromProto(r *proto.WorkspaceAgentMetadata_Result)codersdk.WorkspaceAgentMetadataResult

func PrebuildClaimedChannel(iduuid.UUID)string

func ProtoFromApp(acodersdk.WorkspaceApp) (*proto.WorkspaceApp,error)

func ProtoFromAppHealthsRequest(reqPostAppHealthsRequest) (*proto.BatchUpdateAppHealthRequest,error)

func ProtoFromApps(apps []codersdk.WorkspaceApp) ([]*proto.WorkspaceApp,error)

func ProtoFromBannerConfig(sbcodersdk.BannerConfig) *proto.BannerConfig

func ProtoFromConnectionType(typConnectionType) (proto.Connection_Type,error)

func ProtoFromDevcontainer(dccodersdk.WorkspaceAgentDevcontainer) *proto.WorkspaceAgentDevcontainer

func ProtoFromDevcontainers(dcs []codersdk.WorkspaceAgentDevcontainer) []*proto.WorkspaceAgentDevcontainer

func ProtoFromLifecycle(reqPostLifecycleRequest) (*proto.Lifecycle,error)

func ProtoFromLifecycleState(scodersdk.WorkspaceAgentLifecycle) (proto.Lifecycle_State,error)

func ProtoFromLog(logLog) (*proto.Log,error)

func ProtoFromManifest(manifestManifest) (*proto.Manifest,error)

func ProtoFromMetadataDescription(dcodersdk.WorkspaceAgentMetadataDescription) *proto.WorkspaceAgentMetadata_Description

func ProtoFromMetadataDescriptions(descriptions []codersdk.WorkspaceAgentMetadataDescription) []*proto.WorkspaceAgentMetadata_Description

func ProtoFromMetadataResult(rcodersdk.WorkspaceAgentMetadataResult) *proto.WorkspaceAgentMetadata_Result

func ProtoFromScript(scodersdk.WorkspaceAgentScript) *proto.WorkspaceAgentScript

func ProtoFromScripts(scripts []codersdk.WorkspaceAgentScript) []*proto.WorkspaceAgentScript

func ProtoFromServiceBanner(sbcodersdk.BannerConfig) *proto.ServiceBanner

func ProtoFromSubsystems(ss []codersdk.AgentSubsystem) ([]proto.Startup_Subsystem,error)

func ServiceBannerFromProto(sbp *proto.ServiceBanner)codersdk.BannerConfig

func WaitForReinitLoop(ctxcontext.Context, loggerslog.Logger, client *Client) <-chanReinitializationEvent

type AWSInstanceIdentityToken struct {Signaturestring `json:"signature" validate:"required"`Documentstring `json:"document" validate:"required"`}

type AgentMetric struct {Namestring             `json:"name" validate:"required"`TypeAgentMetricType    `json:"type" validate:"required" enums:"counter,gauge"`Valuefloat64            `json:"value" validate:"required"`Labels []AgentMetricLabel `json:"labels,omitempty"`}

type AgentMetricLabel struct {Namestring `json:"name" validate:"required"`Valuestring `json:"value" validate:"required"`}

type AgentMetricTypestring

type AuthenticateResponse struct {SessionTokenstring `json:"session_token"`}

type AzureInstanceIdentityToken struct {Signaturestring `json:"signature" validate:"required"`Encodingstring `json:"encoding" validate:"required"`}

type BatchUpdateAppHealthsClient interface {BatchUpdateAppHealths(ctxcontext.Context, req *proto.BatchUpdateAppHealthRequest) (*proto.BatchUpdateAppHealthResponse,error)}

type Client struct {SDK *codersdk.Client}

funcNew¶

func New(serverURL *url.URL) *Client

New returns a client that is used to interact with theCoder API from a workspace agent.

func (*Client)AuthAWSInstanceIdentity¶

func (c *Client) AuthAWSInstanceIdentity(ctxcontext.Context) (AuthenticateResponse,error)

AuthWorkspaceAWSInstanceIdentity uses the Amazon Metadata API tofetch a signed payload, and exchange it for a session token for a workspace agent.

The requesting instance must be registered as a resource in the latest history for a workspace.

func (*Client)AuthAzureInstanceIdentity¶

func (c *Client) AuthAzureInstanceIdentity(ctxcontext.Context) (AuthenticateResponse,error)

AuthWorkspaceAzureInstanceIdentity uses the Azure Instance Metadata Service tofetch a signed payload, and exchange it for a session token for a workspace agent.

func (*Client)AuthGoogleInstanceIdentity¶

func (c *Client) AuthGoogleInstanceIdentity(ctxcontext.Context, serviceAccountstring, gcpClient *metadata.Client) (AuthenticateResponse,error)

AuthWorkspaceGoogleInstanceIdentity uses the Google Compute Engine Metadata API tofetch a signed JWT, and exchange it for a session token for a workspace agent.

The requesting instance must be registered as a resource in the latest history for a workspace.

func (*Client)ConnectRPC¶added inv2.8.0

func (c *Client) ConnectRPC(ctxcontext.Context) (drpc.Conn,error)

ConnectRPC connects to the workspace agent API and tailnet API

func (*Client)ConnectRPC20¶added inv2.14.0

func (c *Client) ConnectRPC20(ctxcontext.Context) (proto.DRPCAgentClient20,error)

ConnectRPC20 returns a dRPC client to the Agent API v2.0. Notably, it is missingGetAnnouncementBanners, but is useful when you want to be maximally compatible with CoderdRelease Versions from 2.9+Deprecated: use ConnectRPC20WithTailnet

func (*Client)ConnectRPC20WithTailnet¶added inv2.18.0

func (c *Client) ConnectRPC20WithTailnet(ctxcontext.Context) (proto.DRPCAgentClient20,tailnetproto.DRPCTailnetClient20,error,)

ConnectRPC20WithTailnet returns a dRPC client to the Agent API v2.0. Notably, it is missingGetAnnouncementBanners, but is useful when you want to be maximally compatible with CoderdRelease Versions from 2.9+

func (*Client)ConnectRPC21¶added inv2.14.0

func (c *Client) ConnectRPC21(ctxcontext.Context) (proto.DRPCAgentClient21,error)

ConnectRPC21 returns a dRPC client to the Agent API v2.1. It is useful when you want to bemaximally compatible with Coderd Release Versions from 2.12+Deprecated: use ConnectRPC21WithTailnet

func (*Client)ConnectRPC21WithTailnet¶added inv2.18.0

func (c *Client) ConnectRPC21WithTailnet(ctxcontext.Context) (proto.DRPCAgentClient21,tailnetproto.DRPCTailnetClient21,error,)

ConnectRPC21WithTailnet returns a dRPC client to the Agent API v2.1. It is useful when you want to bemaximally compatible with Coderd Release Versions from 2.12+

func (*Client)ConnectRPC22¶added inv2.18.0

func (c *Client) ConnectRPC22(ctxcontext.Context) (proto.DRPCAgentClient22,tailnetproto.DRPCTailnetClient22,error,)

ConnectRPC22 returns a dRPC client to the Agent API v2.2. It is useful when you want to bemaximally compatible with Coderd Release Versions from 2.13+

func (*Client)ConnectRPC23¶added inv2.18.0

func (c *Client) ConnectRPC23(ctxcontext.Context) (proto.DRPCAgentClient23,tailnetproto.DRPCTailnetClient23,error,)

ConnectRPC23 returns a dRPC client to the Agent API v2.3. It is useful when you want to bemaximally compatible with Coderd Release Versions from 2.18+

func (*Client)ConnectRPC24¶added inv2.20.0

func (c *Client) ConnectRPC24(ctxcontext.Context) (proto.DRPCAgentClient24,tailnetproto.DRPCTailnetClient24,error,)

ConnectRPC24 returns a dRPC client to the Agent API v2.4. It is useful when you want to bemaximally compatible with Coderd Release Versions from 2.20+

func (*Client)ConnectRPC25¶added inv2.23.0

func (c *Client) ConnectRPC25(ctxcontext.Context) (proto.DRPCAgentClient25,tailnetproto.DRPCTailnetClient25,error,)

ConnectRPC25 returns a dRPC client to the Agent API v2.5. It is useful when you want to bemaximally compatible with Coderd Release Versions from 2.xx+ // TODO(DanielleMaywood): Update version

func (*Client)ExternalAuth¶added inv2.3.0

func (c *Client) ExternalAuth(ctxcontext.Context, reqExternalAuthRequest) (ExternalAuthResponse,error)

ExternalAuth submits a URL or provider ID to fetch an access token for.nolint:revive

func (*Client)GitSSHKey¶

func (c *Client) GitSSHKey(ctxcontext.Context) (GitSSHKey,error)

GitSSHKey will return the user's SSH key pair for the workspace.

func (*Client)PatchAppStatus¶added inv2.21.0

func (c *Client) PatchAppStatus(ctxcontext.Context, reqPatchAppStatus)error

func (*Client)PostLogSource¶added inv2.2.0

func (c *Client) PostLogSource(ctxcontext.Context, reqPostLogSourceRequest) (codersdk.WorkspaceAgentLogSource,error)

func (*Client)RewriteDERPMap¶added inv2.8.0

func (c *Client) RewriteDERPMap(derpMap *tailcfg.DERPMap)

RewriteDERPMap rewrites the DERP map to use the access URL of the SDK as the"embedded relay" access URL. The passed derp map is modified in place.

Agents can provide an arbitrary access URL that may be different that theglobally configured one. This breaks the built-in DERP, which would continueto reference the global access URL.

func (*Client)SetSessionToken¶

func (c *Client) SetSessionToken(tokenstring)

func (*Client)WaitForReinit¶added inv2.22.0

func (c *Client) WaitForReinit(ctxcontext.Context) (*ReinitializationEvent,error)

WaitForReinit polls a SSE endpoint, and receives an event back under the following conditions:- ping: ignored, keepalive- prebuild claimed: a prebuilt workspace is claimed, so the agent must reinitialize.

type ConnectionTypestring

const (ConnectionTypeUnspecifiedConnectionType = "Unspecified"ConnectionTypeSSHConnectionType = "SSH"ConnectionTypeVSCodeConnectionType = "VS Code"ConnectionTypeJetBrainsConnectionType = "JetBrains"ConnectionTypeReconnectingPTYConnectionType = "Web Terminal")

Connection type enums.

funcConnectionTypeFromProto¶added inv2.20.0

func ConnectionTypeFromProto(typproto.Connection_Type) (ConnectionType,error)

type ExternalAuthRequest struct {// ID is the ID of a provider to request authentication for.IDstring// Match is an arbitrary string matched against the regex of the provider.Matchstring// Listen indicates that the request should be long-lived and listen for// a new token to be requested.Listenbool}

type ExternalAuthResponse struct {AccessTokenstring                 `json:"access_token"`TokenExtra  map[string]interface{} `json:"token_extra"`URLstring                 `json:"url"`Typestring                 `json:"type"`// Deprecated: Only supported on `/workspaceagents/me/gitauth`// for backwards compatibility.Usernamestring `json:"username"`Passwordstring `json:"password"`}

type GitSSHKey struct {PublicKeystring `json:"public_key"`PrivateKeystring `json:"private_key"`}

type GoogleInstanceIdentityToken struct {JSONWebTokenstring `json:"json_web_token" validate:"required"`}

type Log struct {CreatedAttime.Time         `json:"created_at"`Outputstring            `json:"output"`Levelcodersdk.LogLevel `json:"level"`}

type LogDest interface {BatchCreateLogs(ctxcontext.Context, request *proto.BatchCreateLogsRequest) (*proto.BatchCreateLogsResponse,error)}

type LogSender struct {*sync.Cond// contains filtered or unexported fields}

funcNewLogSender¶added inv2.9.0

func NewLogSender(loggerslog.Logger) *LogSender

func (*LogSender)Enqueue¶added inv2.9.0

func (l *LogSender) Enqueue(srcuuid.UUID, logs ...Log)

func (*LogSender)Flush¶added inv2.9.0

func (l *LogSender) Flush(srcuuid.UUID)

func (*LogSender)GetScriptLogger¶added inv2.9.0

func (l *LogSender) GetScriptLogger(logSourceIDuuid.UUID)ScriptLogger

func (*LogSender)SendLoop¶added inv2.9.0

func (l *LogSender) SendLoop(ctxcontext.Context, destLogDest)error

SendLoop sends any pending logs until it hits an error or the context is canceled. It does notretry as it is expected that a higher layer retries establishing connection to the agent API andcalls SendLoop again.

func (*LogSender)WaitUntilEmpty¶added inv2.9.0

func (l *LogSender) WaitUntilEmpty(ctxcontext.Context)error

WaitUntilEmpty waits until the LogSender's queues are empty or the given context expires.

type LogSource struct {IDuuid.UUID `json:"id"`DisplayNamestring    `json:"display_name"`Iconstring    `json:"icon"`}

type LogsNotifyMessage struct {CreatedAfterint64 `json:"created_after"`}

type Manifest struct {AgentIDuuid.UUID `json:"agent_id"`AgentNamestring    `json:"agent_name"`// OwnerName and WorkspaceID are used by an open-source user to identify the workspace.// We do not provide insurance that this will not be removed in the future,// but if it's easy to persist lets keep it around.OwnerNamestring    `json:"owner_name"`WorkspaceIDuuid.UUID `json:"workspace_id"`WorkspaceNamestring    `json:"workspace_name"`// GitAuthConfigs stores the number of Git configurations// the Coder deployment has. If this number is >0, we// set up special configuration in the workspace.GitAuthConfigsint                                          `json:"git_auth_configs"`VSCodePortProxyURIstring                                       `json:"vscode_port_proxy_uri"`Apps                     []codersdk.WorkspaceApp                      `json:"apps"`DERPMap                  *tailcfg.DERPMap                             `json:"derpmap"`DERPForceWebSocketsbool                                         `json:"derp_force_websockets"`EnvironmentVariables     map[string]string                            `json:"environment_variables"`Directorystring                                       `json:"directory"`MOTDFilestring                                       `json:"motd_file"`DisableDirectConnectionsbool                                         `json:"disable_direct_connections"`Metadata                 []codersdk.WorkspaceAgentMetadataDescription `json:"metadata"`Scripts                  []codersdk.WorkspaceAgentScript              `json:"scripts"`Devcontainers            []codersdk.WorkspaceAgentDevcontainer        `json:"devcontainers"`}

funcManifestFromProto¶added inv2.8.0

func ManifestFromProto(manifest *proto.Manifest) (Manifest,error)

type Metadata struct {Keystring `json:"key"`codersdk.WorkspaceAgentMetadataResult}

funcMetadataFromProto¶added inv2.9.0

func MetadataFromProto(m *proto.Metadata)Metadata

type PatchAppStatus struct {AppSlugstring                           `json:"app_slug"`Statecodersdk.WorkspaceAppStatusState `json:"state"`Messagestring                           `json:"message"`URIstring                           `json:"uri"`// Deprecated: this field is unused and will be removed in a future version.Iconstring `json:"icon"`// Deprecated: this field is unused and will be removed in a future version.NeedsUserAttentionbool `json:"needs_user_attention"`}

type PatchLogs struct {LogSourceIDuuid.UUID `json:"log_source_id"`Logs        []Log     `json:"logs"`}

type PostAppHealthsRequest struct {// Healths is a map of the workspace app name and the health of the app.Healths map[uuid.UUID]codersdk.WorkspaceAppHealth}

type PostLifecycleRequest struct {Statecodersdk.WorkspaceAgentLifecycle `json:"state"`ChangedAttime.Time                        `json:"changed_at"`}

type PostLogSourceRequest struct {// ID is a unique identifier for the log source.// It is scoped to a workspace agent, and can be statically// defined inside code to prevent duplicate sources from being// created for the same agent.IDuuid.UUID `json:"id"`DisplayNamestring    `json:"display_name"`Iconstring    `json:"icon"`}

type PostMetadataRequest struct {Metadata []Metadata `json:"metadata"`}

type PostMetadataRequestDeprecated =codersdk.WorkspaceAgentMetadataResult

type PostStartupRequest struct {Versionstring                    `json:"version"`ExpandedDirectorystring                    `json:"expanded_directory"`Subsystems        []codersdk.AgentSubsystem `json:"subsystems"`}

type ReinitializationEvent struct {WorkspaceIDuuid.UUIDReasonReinitializationReason `json:"reason"`}

type ReinitializationReasonstring

type SSEAgentReinitReceiver struct {// contains filtered or unexported fields}

funcNewSSEAgentReinitReceiver¶added inv2.22.0

func NewSSEAgentReinitReceiver(rio.ReadCloser) *SSEAgentReinitReceiver

func (*SSEAgentReinitReceiver)Receive¶added inv2.22.0

func (s *SSEAgentReinitReceiver) Receive(ctxcontext.Context) (*ReinitializationEvent,error)

type SSEAgentReinitTransmitter struct {// contains filtered or unexported fields}

funcNewSSEAgentReinitTransmitter¶added inv2.22.0

func NewSSEAgentReinitTransmitter(loggerslog.Logger, rwhttp.ResponseWriter, r *http.Request) *SSEAgentReinitTransmitter

func (*SSEAgentReinitTransmitter)Transmit¶added inv2.22.0

func (s *SSEAgentReinitTransmitter) Transmit(ctxcontext.Context, reinitEvents <-chanReinitializationEvent)error

Transmit will read from the given chan and send events for as long as:* the chan remains open* the context has not been canceled* not timed out* the connection to the receiver remains open

type Script struct {Scriptstring `json:"script"`}

type ScriptLogger struct {// contains filtered or unexported fields}

func (ScriptLogger)Flush¶added inv2.9.0

func (sScriptLogger) Flush(ctxcontext.Context)error

func (ScriptLogger)Send¶added inv2.9.0

func (sScriptLogger) Send(ctxcontext.Context, log ...Log)error

type Stats struct {// ConnectionsByProto is a count of connections by protocol.ConnectionsByProto map[string]int64 `json:"connections_by_proto"`// ConnectionCount is the number of connections received by an agent.ConnectionCountint64 `json:"connection_count"`// ConnectionMedianLatencyMS is the median latency of all connections in milliseconds.ConnectionMedianLatencyMSfloat64 `json:"connection_median_latency_ms"`// RxPackets is the number of received packets.RxPacketsint64 `json:"rx_packets"`// RxBytes is the number of received bytes.RxBytesint64 `json:"rx_bytes"`// TxPackets is the number of transmitted bytes.TxPacketsint64 `json:"tx_packets"`// TxBytes is the number of transmitted bytes.TxBytesint64 `json:"tx_bytes"`// SessionCountVSCode is the number of connections received by an agent// that are from our VS Code extension.SessionCountVSCodeint64 `json:"session_count_vscode"`// SessionCountJetBrains is the number of connections received by an agent// that are from our JetBrains extension.SessionCountJetBrainsint64 `json:"session_count_jetbrains"`// SessionCountReconnectingPTY is the number of connections received by an agent// that are from the reconnecting web terminal.SessionCountReconnectingPTYint64 `json:"session_count_reconnecting_pty"`// SessionCountSSH is the number of connections received by an agent// that are normal, non-tagged SSH sessions.SessionCountSSHint64 `json:"session_count_ssh"`// Metrics collected by the agentMetrics []AgentMetric `json:"metrics"`}

func (Stats)SessionCount¶added inv2.5.0

func (sStats) SessionCount()int64

type StatsResponse struct {// ReportInterval is the duration after which the agent should send stats// again.ReportIntervaltime.Duration `json:"report_interval"`}