lokireceiver

package module

v0.154.0 Latest Latest Go to latest Published: Jun 9, 2026 License: Apache-2.0 Imports: 23 Imported by: 5

README ¶

Loki Receiver

The Loki receiver implements the Loki push api as specified in Loki HTTP API: Ingest logs. It allows Promtail instances to specify the open telemetry collector as their lokiAddress.

This receiver runs HTTP and GRPC servers to ingest log entries in Loki format.

Status
Stability	alpha: logs
Distributions	contrib
Issues
Code coverage
Code Owners	@mar4uk

Getting Started

The settings are:

endpoint (required, default = localhost:3500 for HTTP protocol, localhost:3600 gRPC protocol): host:port to which the receiver is going to receive data. See our security best practices doc to understand how to set the endpoint in different environments.
use_incoming_timestamp (optional, default = false) if set true the timestamp from Loki log entry is used

Example:

receivers:
  loki:
    protocols:
      http:
        endpoint: 0.0.0.0:3500
      grpc:
        endpoint: 0.0.0.0:3600
    use_incoming_timestamp: true

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

Documentation ¶

Index ¶

Constants
func NewFactory() receiver.Factory
type Config
- func (cfg *Config) Unmarshal(conf *confmap.Conf) error
- func (cfg *Config) Validate() error
type Protocols

Constants ¶

View Source

const ErrAtLeastOneEntryFailedToProcess = "at least one entry in the push request failed to process"

Variables ¶

This section is empty.

Functions ¶

func NewFactory ¶

func NewFactory() receiver.Factory

NewFactory return a new receiver.Factory for loki receiver.

Types ¶

type Config ¶

type Config struct {
	// Protocols is the configuration for the supported protocols, currently gRPC and HTTP (Proto and JSON).
	Protocols     `mapstructure:"protocols"`
	KeepTimestamp bool `mapstructure:"use_incoming_timestamp"`
	// contains filtered or unexported fields
}

Config defines configuration for the lokireceiver receiver.

func (*Config) Unmarshal ¶

func (cfg *Config) Unmarshal(conf *confmap.Conf) error

Unmarshal a confmap.Conf into the config struct.

func (*Config) Validate ¶

func (cfg *Config) Validate() error

Validate checks the receiver configuration is valid

type Protocols ¶

type Protocols struct {
	GRPC *configgrpc.ServerConfig `mapstructure:"grpc"`
	HTTP *confighttp.ServerConfig `mapstructure:"http"`
	// contains filtered or unexported fields
}

Protocols is the configuration for the supported protocols.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal
metadata Package metadata contains the autogenerated telemetry and build information for the receiver/loki component.	Package metadata contains the autogenerated telemetry and build information for the receiver/loki component.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL