Documentation ¶
Index ¶
- Variables
- func Deploy(ctx context.Context, configFilename string) error
- func NewBabysitter(ctx context.Context, app *protos.AppConfig, config *BabysitterConfig, ...) (*babysitter, error)
- func ToolVersion() (string, bool, error)
- type BabysitterConfig
- func (*BabysitterConfig) Descriptor() ([]byte, []int)deprecated
- func (x *BabysitterConfig) GetDeploymentId() string
- func (x *BabysitterConfig) GetGroups() map[string]string
- func (x *BabysitterConfig) GetListeners() map[string]int32
- func (x *BabysitterConfig) GetNamespace() string
- func (x *BabysitterConfig) GetTelemetry() *Telemetry
- func (*BabysitterConfig) ProtoMessage()
- func (x *BabysitterConfig) ProtoReflect() protoreflect.Message
- func (x *BabysitterConfig) Reset()
- func (x *BabysitterConfig) String() string
- type BabysitterOptions
- type MetricOptions
- func (*MetricOptions) Descriptor() ([]byte, []int)deprecated
- func (x *MetricOptions) GetAutoGenerateMetrics() bool
- func (x *MetricOptions) GetExportInterval() *durationpb.Duration
- func (*MetricOptions) ProtoMessage()
- func (x *MetricOptions) ProtoReflect() protoreflect.Message
- func (x *MetricOptions) Reset()
- func (x *MetricOptions) String() string
- type Telemetry
Constants ¶
This section is empty.
Variables ¶
var File_internal_impl_kube_proto protoreflect.FileDescriptor
Functions ¶
func Deploy ¶ added in v0.23.0
Deploy generates a Kubernetes YAML file and corresponding Docker image to deploy the Service Weaver application specified by the provided kube.yaml config file.
func NewBabysitter ¶ added in v0.23.0
func NewBabysitter(ctx context.Context, app *protos.AppConfig, config *BabysitterConfig, components []string, opts BabysitterOptions) (*babysitter, error)
func ToolVersion ¶ added in v0.21.2
ToolVersion returns the version of the running tool binary, along with an indication whether the tool was built manually, i.e., not via go install.
Types ¶
type BabysitterConfig ¶ added in v0.23.0
type BabysitterConfig struct { Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` // Kubernetes namespace DeploymentId string `protobuf:"bytes,2,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"` // globally unique deployment id Listeners map[string]int32 `` // a map from listener name to port /* 160-byte string literal not displayed */ Groups map[string]string `` // a map from component name to group name /* 153-byte string literal not displayed */ Telemetry *Telemetry `protobuf:"bytes,5,opt,name=telemetry,proto3" json:"telemetry,omitempty"` // options to control how the telemetry is being manipulated. // contains filtered or unexported fields }
BabysitterConfig contains configuration passed to a babysitter.
func (*BabysitterConfig) Descriptor
deprecated
added in
v0.23.0
func (*BabysitterConfig) Descriptor() ([]byte, []int)
Deprecated: Use BabysitterConfig.ProtoReflect.Descriptor instead.
func (*BabysitterConfig) GetDeploymentId ¶ added in v0.23.0
func (x *BabysitterConfig) GetDeploymentId() string
func (*BabysitterConfig) GetGroups ¶ added in v0.23.0
func (x *BabysitterConfig) GetGroups() map[string]string
func (*BabysitterConfig) GetListeners ¶ added in v0.23.0
func (x *BabysitterConfig) GetListeners() map[string]int32
func (*BabysitterConfig) GetNamespace ¶ added in v0.23.0
func (x *BabysitterConfig) GetNamespace() string
func (*BabysitterConfig) GetTelemetry ¶ added in v0.24.4
func (x *BabysitterConfig) GetTelemetry() *Telemetry
func (*BabysitterConfig) ProtoMessage ¶ added in v0.23.0
func (*BabysitterConfig) ProtoMessage()
func (*BabysitterConfig) ProtoReflect ¶ added in v0.23.0
func (x *BabysitterConfig) ProtoReflect() protoreflect.Message
func (*BabysitterConfig) Reset ¶ added in v0.23.0
func (x *BabysitterConfig) Reset()
func (*BabysitterConfig) String ¶ added in v0.23.0
func (x *BabysitterConfig) String() string
type BabysitterOptions ¶ added in v0.23.0
type BabysitterOptions struct { HandleLogEntry func(context.Context, *protos.LogEntry) error HandleTraceSpans func(context.Context, []trace.ReadOnlySpan) error HandleMetrics func(context.Context, []*metrics.MetricSnapshot) error }
BabysitterOptions configure a babysitter. See tool.Plugins for details.
type MetricOptions ¶ added in v0.24.4
type MetricOptions struct { // If true, the deployer also exports metrics created implicitly by the // framework; e.g., autogenerated metrics, http metrics. AutoGenerateMetrics bool `protobuf:"varint,1,opt,name=auto_generate_metrics,json=autoGenerateMetrics,proto3" json:"auto_generate_metrics,omitempty"` // How often to export the metrics to Google Cloud. ExportInterval *durationpb.Duration `protobuf:"bytes,2,opt,name=export_interval,json=exportInterval,proto3" json:"export_interval,omitempty"` // contains filtered or unexported fields }
Options to configure how the metrics are handled by the deployer.
func (*MetricOptions) Descriptor
deprecated
added in
v0.24.4
func (*MetricOptions) Descriptor() ([]byte, []int)
Deprecated: Use MetricOptions.ProtoReflect.Descriptor instead.
func (*MetricOptions) GetAutoGenerateMetrics ¶ added in v0.24.4
func (x *MetricOptions) GetAutoGenerateMetrics() bool
func (*MetricOptions) GetExportInterval ¶ added in v0.24.4
func (x *MetricOptions) GetExportInterval() *durationpb.Duration
func (*MetricOptions) ProtoMessage ¶ added in v0.24.4
func (*MetricOptions) ProtoMessage()
func (*MetricOptions) ProtoReflect ¶ added in v0.24.4
func (x *MetricOptions) ProtoReflect() protoreflect.Message
func (*MetricOptions) Reset ¶ added in v0.24.4
func (x *MetricOptions) Reset()
func (*MetricOptions) String ¶ added in v0.24.4
func (x *MetricOptions) String() string
type Telemetry ¶ added in v0.24.4
type Telemetry struct { Metrics *MetricOptions `protobuf:"bytes,1,opt,name=metrics,proto3" json:"metrics,omitempty"` // contains filtered or unexported fields }
Options to control how the telemetry is being manipulated.
func (*Telemetry) Descriptor
deprecated
added in
v0.24.4
func (*Telemetry) GetMetrics ¶ added in v0.24.4
func (x *Telemetry) GetMetrics() *MetricOptions
func (*Telemetry) ProtoMessage ¶ added in v0.24.4
func (*Telemetry) ProtoMessage()
func (*Telemetry) ProtoReflect ¶ added in v0.24.4
func (x *Telemetry) ProtoReflect() protoreflect.Message