`faro.receiver`

faro.receiver accepts web application telemetry data from the Grafana Faro Web SDK and forwards it to other components for processing.

Note
This component does not work with Grafana Cloud Frontend Observability. For more information, refer to the Choose a component guide.

Usage

faro.receiver "<LABEL>" {
    output {
        logs   = [<LOKI_RECEIVERS>]
        traces = [<OTELCOL_COMPONENTS>]
    }
}

Arguments

You can use the following arguments with faro.receiver:

Name	Type	Description	Default	Required
`extra_log_labels`	`map(string)`	Extra labels to attach to emitted log lines.	`{}`	no
`log_format`	`string`	Export format for the logs.	`"logfmt"`	no

Log format

The following strings are valid log line formats:

"json": Export logs as JSON objects.
"logfmt": Export logs as logfmt lines.

Blocks

You can use the following blocks with faro.receiver:

Block	Description	Required
`output`	Configures where to send collected telemetry data.	yes
`server`	Configures the HTTP server.	no
`server` > `rate_limiting`	Configures rate limiting for the HTTP server.	no
`sourcemaps`	Configures sourcemap retrieval.	no
`sourcemaps` > `cache`	Configures sourcemap caching behavior.	no
`sourcemaps` > `location`	Configures the location for sourcemap retrieval.	no

`output`

Required

The output block specifies where to forward collected logs and traces.

Name	Type	Description	Default	Required
`logs`	`list(LogsReceiver)`	A list of `loki` components to forward logs to.	`[]`	no
`traces`	`list(otelcol.Consumer)`	A list of `otelcol` components to forward traces to.	`[]`	no

`server`

The server block configures the HTTP server managed by the faro.receiver component. Clients using the Grafana Faro Web SDK forward telemetry data to this HTTP server for processing.

Name	Type	Description	Default	Required
`listen_address`	`string`	Address to listen for HTTP traffic on.	`"127.0.0.1"`	no
`listen_port`	`number`	Port to listen for HTTP traffic on.	`12347`	no
`cors_allowed_origins`	`list(string)`	Origins for which cross-origin requests are permitted.	`[]`	no
`api_key`	`secret`	Optional API key to validate client requests with.	`""`	no
`max_allowed_payload_size`	`string`	Maximum size (in bytes) for client requests.	`"5MiB"`	no
`include_metadata`	`bool`	Propagate incoming connection metadata to downstream consumers.	`false`	no

By default, telemetry data is only accepted from applications on the same local network as the browser. To accept telemetry data from a wider set of clients, modify the listen_address attribute to the IP address of the appropriate network interface to use.

The cors_allowed_origins argument determines what origins browser requests may come from. The default value, [], disables CORS support. To support requests from all origins, set cors_allowed_origins to ["*"]. The * character indicates a wildcard.

You can use the following headers for cross-domain requests: Content-Type, Content-Encoding, Idempotency-Key, Traceparent, X-API-Key, X-Faro-Session-Id, or X-Scope-OrgID.

Browser clients can read the Retry-After response header when it’s present.