Documentation
¶
Overview ¶
package config provides configuration types and functions for Substation.
Any non-backwards compatible changes to the configuration types should be accompanied by a version bump.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Metric ¶ added in v1.0.0
type Metric struct {
// Name is the name of the metric.
Name string `json:"name"`
// Attributes are key-value pairs that are associated with the metric.
Attributes map[string]string `json:"attributes"`
// Destination is the metrics destination that the metric will be sent to (internal/metrics).
Destination config.Config `json:"destination"`
}
type Object ¶ added in v1.0.0
type Object struct {
// SourceKey retrieves a value from a JSON object.
SourceKey string `json:"source_key"`
// TargetKey place a value into a JSON object.
TargetKey string `json:"target_key"`
// BatchKey retrieves a value from a JSON object that is used to organize
// batched data (internal/aggregate).
BatchKey string `json:"batch_key"`
}
type Request ¶ added in v1.0.0
type Request struct {
// Timeout is the amount of time that the request will wait before timing out.
Timeout string `json:"Timeout"`
}
Click to show internal directories.
Click to hide internal directories.