Documentation Grafana Alloy Reference Components otelcol otelcol.receiver.faro

otelcol.receiver.faro

otelcol.receiver.faro accepts telemetry data from the Grafana Faro Web SDK and forwards it to other otelcol.* components.

You can specify multiple otelcol.receiver.faro components by giving them different labels.

Usage

alloy Copy

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

Arguments

You can use the following arguments with otelcol.receiver.faro:

By default, otelcol.receiver.faro listens for HTTP connections on localhost. To expose the HTTP server to other machines on your network, configure endpoint with the IP address to listen on, or 0.0.0.0:8080 to listen on all network interfaces.

Blocks

You can use the following blocks with otelcol.receiver.faro:

The > symbol indicates deeper levels of nesting. For example, tls > tpm refers to a tpm block defined inside a tls block.

output

cors

The cors block configures CORS settings for an HTTP server.

The following arguments are supported:

The allowed_headers argument specifies which headers are acceptable from a CORS request. The following headers are always implicitly allowed:

• Accept
• Accept-Language
• Content-Type
• Content-Language

If allowed_headers includes "*", all headers are permitted.

debug_metrics

tls

The tls block configures TLS settings used for a server. If the tls block isn’t provided, TLS won’t be used for connections to the server.

tpm

The tpm block configures retrieving the TLS key_file from a trusted device.

The following arguments are supported:

Name	Type	Description	Default	Required
auth	string	The authorization value used to authenticate the TPM device.	""	no
enabled	bool	Load the tls.key_file from TPM.	false	no
owner_auth	string	The owner authorization value used to authenticate the TPM device.	""	no
path	string	Path to the TPM device or Unix domain socket.	""	no

The trusted platform module (TPM) configuration can be used for loading TLS key from TPM. Currently only TSS2 format is supported.

The path attribute is not supported on Windows.

Example

alloy Copy

otelcol.example.component "<LABEL>" {
    ...
    tls {
        ...
        key_file = "my-tss2-key.key"
        tpm {
            enabled = true
            path = "/dev/tpmrm0"
        }
    }
}

In the above example, the private key my-tss2-key.key in TSS2 format will be loaded from the TPM device /dev/tmprm0.

Exported fields

otelcol.receiver.faro doesn’t export any fields.

Component health

otelcol.receiver.faro is only reported as unhealthy if given an invalid configuration.

Debug information

otelcol.receiver.faro doesn’t expose any component-specific debug information.

Examples

This example forwards received telemetry through a batch processor before finally sending it to an OTLP-capable endpoint:

alloy Copy

otelcol.receiver.faro "default" {
  output {
    logs   = [otelcol.processor.batch.default.input]
    traces = [otelcol.processor.batch.default.input]
  }
}

otelcol.processor.batch "default" {
  output {
    logs   = [otelcol.exporter.faro.default.input]
    traces = [otelcol.exporter.faro.default.input]
  }
}

otelcol.exporter.faro "default" {
  client {
    endpoint = "<FARO_COLLECTOR_ADDRESS>"
  }
}

Replace the following:

• <FARO_COLLECTOR_ADDRESS>: The address of the Faro-compatible server to send data to.

Enable TLS

You can configure otelcol.receiver.faro to use TLS for added security:

alloy Copy

otelcol.receiver.faro "default" {
  endpoint = "localhost:8443"
  
  tls {
    cert_file = "/path/to/cert.pem"
    key_file  = "/path/to/key.pem"
  }
  
  output {
    logs   = [otelcol.processor.batch.default.input]
    traces = [otelcol.processor.batch.default.input]
  }
}

Enable authentication

You can create a otelcol.receiver.faro component that requires authentication for requests. This is useful for limiting who can push data to the server.

alloy Copy

otelcol.receiver.faro "default" {
  auth     = otelcol.auth.basic.creds.handler
  
  output {
    logs   = [otelcol.processor.batch.default.input]
    traces = [otelcol.processor.batch.default.input]
  }
}

otelcol.auth.basic "creds" {
  username = sys.env("FARO_USERNAME")
  password = sys.env("FARO_PASSWORD")
}

Configure CORS

You can configure CORS settings to allow web applications to send telemetry data from browsers:

alloy Copy

otelcol.receiver.faro "default" {
  cors {
    allowed_origins = ["https://my-webapp.example.com", "https://staging.example.com"]
    allowed_headers = ["Content-Type", "X-Custom-Header"]
    max_age         = 3600
  }
  
  output {
    logs   = [otelcol.processor.batch.default.input]
    traces = [otelcol.processor.batch.default.input]
  }
}

Compatible components

otelcol.receiver.faro can accept arguments from the following components:

• Components that export OpenTelemetry otelcol.Consumer