Documentation
¶
Overview ¶
Package otlp provides an otelcol.receiver.otlp component.
Index ¶
- Variables
- type Arguments
- func (args Arguments) Convert() (otelcomponent.Config, error)
- func (args Arguments) DebugMetricsConfig() otelcol.DebugMetricsArguments
- func (args Arguments) Exporters() map[otelcomponent.DataType]map[otelcomponent.ID]otelcomponent.Component
- func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension
- func (args Arguments) NextConsumers() *otelcol.ConsumerArguments
- func (args *Arguments) SetToDefault()
- func (args *Arguments) Validate() error
- type GRPCServerArguments
- type HTTPConfigArguments
Constants ¶
This section is empty.
Variables ¶
View Source
var (
DefaultGRPCServerArguments = GRPCServerArguments{
Endpoint: "0.0.0.0:4317",
Transport: "tcp",
ReadBufferSize: 512 * units.Kibibyte,
}
DefaultHTTPConfigArguments = HTTPConfigArguments{
HTTPServerArguments: &otelcol.HTTPServerArguments{
Endpoint: "0.0.0.0:4318",
},
MetricsURLPath: "/v1/metrics",
LogsURLPath: "/v1/logs",
TracesURLPath: "/v1/traces",
}
)
Default server settings.
Functions ¶
This section is empty.
Types ¶
type Arguments ¶
type Arguments struct {
GRPC *GRPCServerArguments `river:"grpc,block,optional"`
HTTP *HTTPConfigArguments `river:"http,block,optional"`
// DebugMetrics configures component internal metrics. Optional.
DebugMetrics otelcol.DebugMetricsArguments `river:"debug_metrics,block,optional"`
// Output configures where to send received data. Required.
Output *otelcol.ConsumerArguments `river:"output,block"`
}
Arguments configures the otelcol.receiver.otlp component.
func (Arguments) Convert ¶
func (args Arguments) Convert() (otelcomponent.Config, error)
Convert implements receiver.Arguments.
func (Arguments) DebugMetricsConfig ¶ added in v0.37.0
func (args Arguments) DebugMetricsConfig() otelcol.DebugMetricsArguments
DebugMetricsConfig implements receiver.Arguments.
func (Arguments) Exporters ¶
func (args Arguments) Exporters() map[otelcomponent.DataType]map[otelcomponent.ID]otelcomponent.Component
Exporters implements receiver.Arguments.
func (Arguments) Extensions ¶
func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension
Extensions implements receiver.Arguments.
func (Arguments) NextConsumers ¶
func (args Arguments) NextConsumers() *otelcol.ConsumerArguments
NextConsumers implements receiver.Arguments.
func (*Arguments) SetToDefault ¶ added in v0.40.0
func (args *Arguments) SetToDefault()
SetToDefault implements river.Defaulter.
type GRPCServerArguments ¶
type GRPCServerArguments otelcol.GRPCServerArguments
GRPCServerArguments is used to configure otelcol.receiver.otlp with component-specific defaults.
func (*GRPCServerArguments) SetToDefault ¶ added in v0.35.0
func (args *GRPCServerArguments) SetToDefault()
SetToDefault implements river.Defaulter.
type HTTPConfigArguments ¶ added in v0.37.0
type HTTPConfigArguments struct {
HTTPServerArguments *otelcol.HTTPServerArguments `river:",squash"`
// The URL path to receive traces on. If omitted "/v1/traces" will be used.
TracesURLPath string `river:"traces_url_path,attr,optional"`
// The URL path to receive metrics on. If omitted "/v1/metrics" will be used.
MetricsURLPath string `river:"metrics_url_path,attr,optional"`
// The URL path to receive logs on. If omitted "/v1/logs" will be used.
LogsURLPath string `river:"logs_url_path,attr,optional"`
}
func (*HTTPConfigArguments) Convert ¶ added in v0.37.0
func (args *HTTPConfigArguments) Convert() *otlpreceiver.HTTPConfig
Convert converts args into the upstream type.
func (*HTTPConfigArguments) SetToDefault ¶ added in v0.37.0
func (args *HTTPConfigArguments) SetToDefault()
SetToDefault implements river.Defaulter.
Click to show internal directories.
Click to hide internal directories.