Documentation
¶
Index ¶
- Constants
- func InjectAgentRPCAPI(ctx context.Context, rpcAPI AgentRPCAPI) context.Context
- func StreamAgentRPCAPIInterceptor(factory AgentRPCAPIFactory) grpc.StreamServerInterceptor
- func UnaryAgentRPCAPIInterceptor(factory AgentRPCAPIFactory) grpc.UnaryServerInterceptor
- type API
- type AgentRPCAPI
- type AgentRPCAPIFactory
- type ApplyDefaults
- type Config
- type Factory
- type Module
- type NopModule
Constants ¶
View Source
const ( // SentryFieldTraceID is the name of the Sentry field for trace ID. SentryFieldTraceID = "trace_id" SentryFieldTraceSampled = "trace_sampled" GRPCServiceSentryField = "grpc.service" GRPCMethodSentryField = "grpc.method" )
Variables ¶
This section is empty.
Functions ¶
func InjectAgentRPCAPI ¶ added in v16.9.0
func InjectAgentRPCAPI(ctx context.Context, rpcAPI AgentRPCAPI) context.Context
func StreamAgentRPCAPIInterceptor ¶ added in v16.9.0
func StreamAgentRPCAPIInterceptor(factory AgentRPCAPIFactory) grpc.StreamServerInterceptor
StreamAgentRPCAPIInterceptor returns a new stream server interceptor that augments connection context with a AgentRPCAPI.
func UnaryAgentRPCAPIInterceptor ¶ added in v16.9.0
func UnaryAgentRPCAPIInterceptor(factory AgentRPCAPIFactory) grpc.UnaryServerInterceptor
UnaryAgentRPCAPIInterceptor returns a new unary server interceptor that augments connection context with a AgentRPCAPI.
Types ¶
type API ¶ added in v16.9.0
type API interface { modshared.API // OnGitPushEvent runs the given callback function for a received git push event. // The git push event may come from any GitLab project and as such it's up to the // callback to filter out the events that it's interested in. // The callback MUST NOT block i.e. perform I/O or acquire contended locks. Perform those operations // asynchronously in a separate goroutine when required. OnGitPushEvent(ctx context.Context, cb syncz.EventCallback[*event.GitPushEvent]) }
API provides the API for the module to use.
type AgentRPCAPI ¶ added in v16.9.0
type AgentRPCAPI interface { modshared.RPCAPI // AgentToken returns the token of an agent making the RPC. AgentToken() api.AgentToken // AgentInfo returns information about the agent making the RPC. // Returns a gRPC-compatible error. // Returns an error with the Unavailable code if there was a retriable error. // If there was an error, it takes care of tracking it via HandleProcessingError(). AgentInfo(ctx context.Context, log *zap.Logger) (*api.AgentInfo, error) }
AgentRPCAPI provides the API for the module's gRPC handlers to use. It should be used only by modules, that handle requests from agents.
func AgentRPCAPIFromContext ¶ added in v16.9.0
func AgentRPCAPIFromContext(ctx context.Context) AgentRPCAPI
type AgentRPCAPIFactory ¶ added in v16.9.0
type AgentRPCAPIFactory func(ctx context.Context, fullMethodName string) (AgentRPCAPI, error)
type ApplyDefaults ¶
type ApplyDefaults func(*kascfg.ConfigurationFile)
ApplyDefaults is a signature of a public function, exposed by modules to perform defaulting. The function should be called ApplyDefaults.
type Config ¶
type Config struct { // Log can be used for logging from the module. // It should not be used for logging from gRPC API methods. Use grpctool.LoggerFromContext(ctx) instead. Log *zap.Logger API API Config *kascfg.ConfigurationFile GitLabClient gitlab.ClientInterface UsageTracker usage_metrics.UsageTrackerRegisterer EventTracker event_tracker.EventTrackerRegisterer // AgentServer is the gRPC server agentk is talking to. // This can be used to add endpoints in Factory.New. // Request handlers can obtain the per-request logger using grpctool.LoggerFromContext(requestContext). // Request handlers that block for a while must use context from // grpctool.MaxConnectionAgeContextFromStreamContext() or poll using rpcAPI.PollWithBackoff() // to respect RPC context abort, kas shutdown, max connection age reached conditions. AgentServer *grpc.Server // APIServer is the gRPC server GitLab is talking to. // This can be used to add endpoints in Factory.New. // Request handlers can obtain the per-request logger using grpctool.LoggerFromContext(requestContext). // Request handlers that block for a while must use context from // grpctool.MaxConnectionAgeContextFromStreamContext() or poll using rpcAPI.PollWithBackoff() // to respect RPC context abort, kas shutdown, max connection age reached conditions. APIServer *grpc.Server // RegisterAgentAPI allows to register a gRPC API endpoint that kas proxies to agentk. RegisterAgentAPI func(*grpc.ServiceDesc) // AgentConn is a gRPC connection that can be used to send requests to an agentk instance. // Agent ID must be specified in the request metadata in RoutingAgentIDMetadataKey field. // Make sure factory returns modshared.ModuleStartAfterServers if module uses this connection. AgentConn grpc.ClientConnInterface Gitaly gitaly.PoolInterface TraceProvider trace.TracerProvider TracePropagator propagation.TextMapPropagator MeterProvider otelmetric.MeterProvider Meter otelmetric.Meter RedisClient rueidis.Client // KASName is a string "gitlab-kas". Can be used as a user agent, server name, service name, etc. KASName string // Version is gitlab-kas version. Version string // CommitID is gitlab-kas commit sha. CommitID string // ProbeRegistry is for registering liveness probes and readiness probes ProbeRegistry *observability.ProbeRegistry }
Config holds configuration for a Module.
Click to show internal directories.
Click to hide internal directories.