Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiServerConfig ¶
type ApiServerConfig struct {
// Address defines the address of Control Plane API server.
URL string `yaml:"url,omitempty" envconfig:"kuma_control_plane_api_server_url"`
}
ApiServerConfig defines coordinates of the Control Plane API Server.
func (*ApiServerConfig) Sanitize ¶
func (c *ApiServerConfig) Sanitize()
func (*ApiServerConfig) Validate ¶
func (c *ApiServerConfig) Validate() (errs error)
type Config ¶
type Config struct {
// ControlPlane defines coordinates of the Kuma Control Plane.
ControlPlane ControlPlaneConfig `yaml:"controlPlane,omitempty"`
// MonitoringAssignment defines configuration related to Monitoring Assignment in Kuma.
MonitoringAssignment MonitoringAssignmentConfig `yaml:"monitoringAssignment,omitempty"`
// Prometheus defines configuration related to integration with Prometheus.
Prometheus PrometheusConfig `yaml:"prometheus,omitempty"`
}
Config defines configuration of the Prometheus service discovery adapter.
func DefaultConfig ¶
func DefaultConfig() Config
type ControlPlaneConfig ¶
type ControlPlaneConfig struct {
// ApiServer defines coordinates of the Control Plane API Server
ApiServer ApiServerConfig `yaml:"apiServer,omitempty"`
}
ControlPlaneConfig defines coordinates of the Control Plane.
func (*ControlPlaneConfig) Sanitize ¶
func (c *ControlPlaneConfig) Sanitize()
func (*ControlPlaneConfig) Validate ¶
func (c *ControlPlaneConfig) Validate() (errs error)
type MonitoringAssignmentClientConfig ¶
type MonitoringAssignmentClientConfig struct {
// Name this adapter should use when connecting to Monitoring Assignment server.
Name string `yaml:"name,omitempty" envconfig:"kuma_monitoring_assignment_client_name"`
}
MonitoringAssignmentClientConfig defines configuration of a Monitoring Assignment Discovery Service (MADS) client.
func (*MonitoringAssignmentClientConfig) Sanitize ¶
func (c *MonitoringAssignmentClientConfig) Sanitize()
func (*MonitoringAssignmentClientConfig) Validate ¶
func (c *MonitoringAssignmentClientConfig) Validate() (errs error)
type MonitoringAssignmentConfig ¶
type MonitoringAssignmentConfig struct {
// Client defines configuration of a Monitoring Assignment Discovery Service (MADS) client.
Client MonitoringAssignmentClientConfig `yaml:"client,omitempty"`
}
MonitoringAssignmentConfig defines configuration related to Monitoring Assignment in Kuma.
func (*MonitoringAssignmentConfig) Sanitize ¶
func (c *MonitoringAssignmentConfig) Sanitize()
func (*MonitoringAssignmentConfig) Validate ¶
func (c *MonitoringAssignmentConfig) Validate() (errs error)
type PrometheusConfig ¶
type PrometheusConfig struct {
// Path to an output file where Kuma Prometheus SD adapter should persists a list of scrape targets.
// The same file path must be used on Prometheus side in a configuration of `file_sd` discovery mechanism.
OutputFile string `yaml:"outputFile,omitempty" envconfig:"kuma_prometheus_output_file"`
}
PrometheusConfig defines configuration related to integration with Prometheus.
In short, Kuma Prometheus SD adapter integrates with Prometheus via a shared file, where the former is a writer and the latter is a reader. For further details see https://github.com/prometheus/prometheus/tree/master/documentation/examples/custom-sd
func (*PrometheusConfig) Sanitize ¶
func (c *PrometheusConfig) Sanitize()
func (*PrometheusConfig) Validate ¶
func (c *PrometheusConfig) Validate() (errs error)
Source Files