Menu

Caution

Grafana Alloy is the new name for our distribution of the OTel collector. Grafana Agent has been deprecated and is in Long-Term Support (LTS) through October 31, 2025. Grafana Agent will reach an End-of-Life (EOL) on November 1, 2025. Read more about why we recommend migrating to Grafana Alloy.

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Open source

loki.source.api

loki.source.api receives log entries over HTTP and forwards them to other loki.* components.

The HTTP API exposed is compatible with Loki push API and the logproto format. This means that other loki.write components can be used as a client and send requests to loki.source.api which enables using the Agent as a proxy for logs.

Usage

river
loki.source.api "LABEL" {
    http {
        listen_address = "LISTEN_ADDRESS"
        listen_port = PORT 
    }
    forward_to = RECEIVER_LIST
}

The component will start HTTP server on the configured port and address with the following endpoints:

  • /loki/api/v1/push - accepting POST requests compatible with Loki push API, for example, from another Grafana Agent’s loki.write component.
  • /loki/api/v1/raw - accepting POST requests with newline-delimited log lines in body. This can be used to send NDJSON or plaintext logs. This is compatible with promtail’s push API endpoint - see promtail’s documentation for more information. NOTE: when this endpoint is used, the incoming timestamps cannot be used and the use_incoming_timestamp = true setting will be ignored.
  • /loki/ready - accepting GET requests - can be used to confirm the server is reachable and healthy.
  • /api/v1/push - internally reroutes to /loki/api/v1/push
  • /api/v1/raw - internally reroutes to /loki/api/v1/raw

Arguments

loki.source.api supports the following arguments:

NameTypeDescriptionDefaultRequired
forward_tolist(LogsReceiver)List of receivers to send log entries to.yes
use_incoming_timestampboolWhether or not to use the timestamp received from request.falseno
labelsmap(string)The labels to associate with each received logs record.{}no
relabel_rulesRelabelRulesRelabeling rules to apply on log entries.{}no

The relabel_rules field can make use of the rules export value from a loki.relabel component to apply one or more relabeling rules to log entries before they’re forwarded to the list of receivers in forward_to.

Blocks

The following blocks are supported inside the definition of loki.source.api:

HierarchyNameDescriptionRequired
httphttpConfigures the HTTP server that receives requests.no

http

The http block configures the HTTP server.

You can use the following arguments to configure the http block. Any omitted fields take their default values.

NameTypeDescriptionDefaultRequired
conn_limitintMaximum number of simultaneous HTTP connections. Defaults to no limit.0no
listen_addressstringNetwork address on which the server listens for new connections. Defaults to accepting all incoming connections.""no
listen_portintPort number on which the server listens for new connections.8080no
server_idle_timeoutdurationIdle timeout for HTTP server."120s"no
server_read_timeoutdurationRead timeout for HTTP server."30s"no
server_write_timeoutdurationWrite timeout for HTTP server."30s"no

Exported fields

loki.source.api does not export any fields.

Component health

loki.source.api is only reported as unhealthy if given an invalid configuration.

Debug metrics

The following are some of the metrics that are exposed when this component is used. Note that the metrics include labels such as status_code where relevant, which can be used to measure request success rates.

  • loki_source_api_request_duration_seconds (histogram): Time (in seconds) spent serving HTTP requests.
  • loki_source_api_request_message_bytes (histogram): Size (in bytes) of messages received in the request.
  • loki_source_api_response_message_bytes (histogram): Size (in bytes) of messages sent in response.
  • loki_source_api_tcp_connections (gauge): Current number of accepted TCP connections.

Example

This example starts an HTTP server on 0.0.0.0 address and port 9999. The server receives log entries and forwards them to a loki.write component while adding a forwarded="true" label. The loki.write component will send the logs to the specified loki instance using basic auth credentials provided.

river
loki.write "local" {
    endpoint {
        url = "http://loki:3100/api/v1/push"
        basic_auth {
            username = "<your username>"
            password_file = "<your password file>"
        }
    }
}

loki.source.api "loki_push_api" {
    http {
        listen_address = "0.0.0.0"
        listen_port = 9999
    }
    forward_to = [
        loki.write.local.receiver,
    ]
    labels = {
        forwarded = "true",
    }
}