Documentation
¶
Index ¶
- Constants
- type ProberConfig
- func (*ProberConfig) Descriptor() ([]byte, []int)
- func (m *ProberConfig) GetDisableJitter() bool
- func (m *ProberConfig) GetGlobalTargetsOptions() *proto6.GlobalTargetsOptions
- func (m *ProberConfig) GetGrpcPort() int32
- func (m *ProberConfig) GetGrpcTlsCertFile() string
- func (m *ProberConfig) GetGrpcTlsKeyFile() string
- func (m *ProberConfig) GetHost() string
- func (m *ProberConfig) GetPort() int32
- func (m *ProberConfig) GetProbe() []*proto1.ProbeDef
- func (m *ProberConfig) GetRdsServer() *proto4.ServerConf
- func (m *ProberConfig) GetRtcReportOptions() *proto5.RtcReportOptions
- func (m *ProberConfig) GetServer() []*proto3.ServerDef
- func (m *ProberConfig) GetSharedTargets() []*SharedTargets
- func (m *ProberConfig) GetSurfacer() []*proto2.SurfacerDef
- func (m *ProberConfig) GetSysvarsEnvVar() string
- func (m *ProberConfig) GetSysvarsIntervalMsec() int32
- func (*ProberConfig) ProtoMessage()
- func (m *ProberConfig) Reset()
- func (m *ProberConfig) String() string
- func (m *ProberConfig) XXX_DiscardUnknown()
- func (m *ProberConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ProberConfig) XXX_Merge(src proto.Message)
- func (m *ProberConfig) XXX_Size() int
- func (m *ProberConfig) XXX_Unmarshal(b []byte) error
- type SharedTargets
- func (*SharedTargets) Descriptor() ([]byte, []int)
- func (m *SharedTargets) GetName() string
- func (m *SharedTargets) GetTargets() *proto6.TargetsDef
- func (*SharedTargets) ProtoMessage()
- func (m *SharedTargets) Reset()
- func (m *SharedTargets) String() string
- func (m *SharedTargets) XXX_DiscardUnknown()
- func (m *SharedTargets) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *SharedTargets) XXX_Merge(src proto.Message)
- func (m *SharedTargets) XXX_Size() int
- func (m *SharedTargets) XXX_Unmarshal(b []byte) error
Constants ¶
View Source
const Default_ProberConfig_DisableJitter bool = false
View Source
const Default_ProberConfig_SysvarsEnvVar string = "SYSVARS"
View Source
const Default_ProberConfig_SysvarsIntervalMsec int32 = 10000
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ProberConfig ¶
type ProberConfig struct {
// Probes to run.
Probe []*proto1.ProbeDef `protobuf:"bytes,1,rep,name=probe" json:"probe,omitempty"`
// Surfacers are used to export probe results for further processing.
// If no surfacer is configured, a prometheus and a file surfacer are
// initialized:
// - Prometheus makes probe results available at http://<host>:9313/metrics.
// - File surfacer writes results to stdout.
//
// You can disable default surfacers (in case you want no surfacer at all), by
// adding the following to your config:
// surfacer {}
Surfacer []*proto2.SurfacerDef `protobuf:"bytes,2,rep,name=surfacer" json:"surfacer,omitempty"`
// Servers to run inside cloudprober. These servers can serve as targets for
// other probes.
Server []*proto3.ServerDef `protobuf:"bytes,3,rep,name=server" json:"server,omitempty"`
// probes. Example usage:
//
// shared_targets {
// name: "internal-vms"
// targets {
// rds_targets {
// ..
// }
// }
// }
//
// probe {
// name: "vm-ping"
// type: PING
// targets {
// shared_targets: "internal-vms"
// }
// }
//
// probe {
// name: "vm-http"
// type: HTTP
// targets {
// shared_targets: "internal-vms"
// }
// }
SharedTargets []*SharedTargets `protobuf:"bytes,4,rep,name=shared_targets,json=sharedTargets" json:"shared_targets,omitempty"`
// Resource discovery server
RdsServer *proto4.ServerConf `protobuf:"bytes,95,opt,name=rds_server,json=rdsServer" json:"rds_server,omitempty"`
// Port for the default HTTP server. This port is also used for prometheus
// exporter (URL /metrics). Default port is 9313. If not specified in the
// config, default port can be overridden by the environment variable
// CLOUDPROBER_PORT.
Port *int32 `protobuf:"varint,96,opt,name=port" json:"port,omitempty"`
// Port to run the default gRPC server on. If not specified, and if
// environment variable CLOUDPROBER_GRPC_PORT is set, CLOUDPROBER_GRPC_PORT is
// used for the default gRPC server. If CLOUDPROBER_GRPC_PORT is not set as
// well, default gRPC server is not started.
GrpcPort *int32 `protobuf:"varint,104,opt,name=grpc_port,json=grpcPort" json:"grpc_port,omitempty"`
// If grpc_tls_cert_file and grpc_tls_key_file are given, default gRPC server
// uses the TLS certificate for authentication -- that is, client should
// provide the same TLS certificate to authenticate itself while making calls
// to the gRPC server.
GrpcTlsCertFile *string `protobuf:"bytes,105,opt,name=grpc_tls_cert_file,json=grpcTlsCertFile" json:"grpc_tls_cert_file,omitempty"`
GrpcTlsKeyFile *string `protobuf:"bytes,106,opt,name=grpc_tls_key_file,json=grpcTlsKeyFile" json:"grpc_tls_key_file,omitempty"`
// Host for the default HTTP server. Default listens on all addresses. If not
// specified in the config, default port can be overridden by the environment
// variable CLOUDPROBER_HOST.
Host *string `protobuf:"bytes,101,opt,name=host" json:"host,omitempty"`
// Probes are staggered across time to avoid executing all of them at the
// same time. This behavior can be disabled by setting the following option
// to true.
DisableJitter *bool `protobuf:"varint,102,opt,name=disable_jitter,json=disableJitter,def=0" json:"disable_jitter,omitempty"`
// How often to export system variables. To learn more about system variables:
// http://godoc.org/github.com/google/cloudprober/sysvars.
SysvarsIntervalMsec *int32 `protobuf:"varint,97,opt,name=sysvars_interval_msec,json=sysvarsIntervalMsec,def=10000" json:"sysvars_interval_msec,omitempty"`
// Variables specified in this environment variable are exported as it is.
// This is specifically useful to export information about system environment,
// for example, docker image tag/digest-id, OS version etc. See
// tools/cloudprober_startup.sh in the cloudprober directory for an example on
// how to use these variables.
SysvarsEnvVar *string `protobuf:"bytes,98,opt,name=sysvars_env_var,json=sysvarsEnvVar,def=SYSVARS" json:"sysvars_env_var,omitempty"`
// Options for RTC reporter. RTC reporter reports information about the
// current instance to a Runtime Config (RTC). This is useful if you want your
// instance to be dynamically discoverable through RTC targets. This is
// disabled by default.
RtcReportOptions *proto5.RtcReportOptions `protobuf:"bytes,99,opt,name=rtc_report_options,json=rtcReportOptions" json:"rtc_report_options,omitempty"`
// Global targets options. Per-probe options are specified within the probe
// stanza.
GlobalTargetsOptions *proto6.GlobalTargetsOptions `protobuf:"bytes,100,opt,name=global_targets_options,json=globalTargetsOptions" json:"global_targets_options,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
func (*ProberConfig) Descriptor ¶
func (*ProberConfig) Descriptor() ([]byte, []int)
func (*ProberConfig) GetDisableJitter ¶ added in v0.10.2
func (m *ProberConfig) GetDisableJitter() bool
func (*ProberConfig) GetGlobalTargetsOptions ¶
func (m *ProberConfig) GetGlobalTargetsOptions() *proto6.GlobalTargetsOptions
func (*ProberConfig) GetGrpcPort ¶ added in v0.10.3
func (m *ProberConfig) GetGrpcPort() int32
func (*ProberConfig) GetGrpcTlsCertFile ¶ added in v0.10.3
func (m *ProberConfig) GetGrpcTlsCertFile() string
func (*ProberConfig) GetGrpcTlsKeyFile ¶ added in v0.10.3
func (m *ProberConfig) GetGrpcTlsKeyFile() string
func (*ProberConfig) GetHost ¶ added in v0.10.2
func (m *ProberConfig) GetHost() string
func (*ProberConfig) GetPort ¶
func (m *ProberConfig) GetPort() int32
func (*ProberConfig) GetProbe ¶
func (m *ProberConfig) GetProbe() []*proto1.ProbeDef
func (*ProberConfig) GetRdsServer ¶
func (m *ProberConfig) GetRdsServer() *proto4.ServerConf
func (*ProberConfig) GetRtcReportOptions ¶
func (m *ProberConfig) GetRtcReportOptions() *proto5.RtcReportOptions
func (*ProberConfig) GetServer ¶
func (m *ProberConfig) GetServer() []*proto3.ServerDef
func (*ProberConfig) GetSharedTargets ¶ added in v0.10.5
func (m *ProberConfig) GetSharedTargets() []*SharedTargets
func (*ProberConfig) GetSurfacer ¶
func (m *ProberConfig) GetSurfacer() []*proto2.SurfacerDef
func (*ProberConfig) GetSysvarsEnvVar ¶
func (m *ProberConfig) GetSysvarsEnvVar() string
func (*ProberConfig) GetSysvarsIntervalMsec ¶
func (m *ProberConfig) GetSysvarsIntervalMsec() int32
func (*ProberConfig) ProtoMessage ¶
func (*ProberConfig) ProtoMessage()
func (*ProberConfig) Reset ¶
func (m *ProberConfig) Reset()
func (*ProberConfig) String ¶
func (m *ProberConfig) String() string
func (*ProberConfig) XXX_DiscardUnknown ¶
func (m *ProberConfig) XXX_DiscardUnknown()
func (*ProberConfig) XXX_Marshal ¶
func (m *ProberConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ProberConfig) XXX_Merge ¶
func (m *ProberConfig) XXX_Merge(src proto.Message)
func (*ProberConfig) XXX_Size ¶
func (m *ProberConfig) XXX_Size() int
func (*ProberConfig) XXX_Unmarshal ¶
func (m *ProberConfig) XXX_Unmarshal(b []byte) error
type SharedTargets ¶ added in v0.10.5
type SharedTargets struct {
}
func (*SharedTargets) Descriptor ¶ added in v0.10.5
func (*SharedTargets) Descriptor() ([]byte, []int)
func (*SharedTargets) GetName ¶ added in v0.10.5
func (m *SharedTargets) GetName() string
func (*SharedTargets) GetTargets ¶ added in v0.10.5
func (m *SharedTargets) GetTargets() *proto6.TargetsDef
func (*SharedTargets) ProtoMessage ¶ added in v0.10.5
func (*SharedTargets) ProtoMessage()
func (*SharedTargets) Reset ¶ added in v0.10.5
func (m *SharedTargets) Reset()
func (*SharedTargets) String ¶ added in v0.10.5
func (m *SharedTargets) String() string
func (*SharedTargets) XXX_DiscardUnknown ¶ added in v0.10.5
func (m *SharedTargets) XXX_DiscardUnknown()
func (*SharedTargets) XXX_Marshal ¶ added in v0.10.5
func (m *SharedTargets) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*SharedTargets) XXX_Merge ¶ added in v0.10.5
func (m *SharedTargets) XXX_Merge(src proto.Message)
func (*SharedTargets) XXX_Size ¶ added in v0.10.5
func (m *SharedTargets) XXX_Size() int
func (*SharedTargets) XXX_Unmarshal ¶ added in v0.10.5
func (m *SharedTargets) XXX_Unmarshal(b []byte) error
Click to show internal directories.
Click to hide internal directories.