Skip to content

loggr-forwarder-agent job from loggregator-agent/7.7.0

Github source: 3675fc3c or master branch

Properties

deployment

Name of deployment (added as tag on all outgoing v1 envelopes)

Default
""

downstream_ingress_port_glob

Files matching the glob are expected to contain ports of downstream consumers that will be bound to 127.0.0.1:{port} with the provided mTLS configuration. The forwarder assumes the downstream server is serving Loggregator’s V2 IngressService. See code.cloudfoundry.org/loggregator-api.

Default
/var/vcap/jobs/*/config/ingress_port.yml

logging

format

timestamp

Format for timestamp in component logs. Valid values are ‘deprecated’ and ‘rfc3339’.

Default
deprecated

metrics

ca_cert

TLS CA cert to verify requests to metrics endpoint.

cert

TLS certificate for metrics server signed by the metrics CA

debug

Enables go_ and process_ metrics along with a pprof endpoint

Default
false

key

TLS private key for metrics server signed by the metrics CA

port

Port the agent uses to serve metrics and debug information

Default
14823

pprof_port

If debug metrics is enabled, pprof will start at this port, ideally set to something other then 0

Default
0

server_name

The server name used in the scrape configuration for the metrics endpoint

port

Port the agent is serving gRPC via mTLS

Default
3458

tags

Collection of tags to add on all outgoing v2 envelopes. Bosh deployment, job, index and IP will be merged with this property if they are not provided

Default
{}
Example
deployment: cf

tls

ca_cert

TLS loggregator root CA certificate. It is required for key/cert verification.

cert

TLS certificate for forwarder signed by the loggregator CA

cipher_suites

An ordered list of supported SSL cipher suites. Allowed cipher suites are TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 and TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384.

Default
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256:TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

key

TLS private key for forwarder signed by the loggregator CA

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/loggr-forwarder-agent/ directory (learn more).

  • config/bpm.yml (from bpm.yml.erb)
  • config/certs/forwarder.crt (from forwarder.crt.erb)
  • config/certs/forwarder.key (from forwarder.key.erb)
  • config/certs/loggregator_ca.crt (from loggregator_ca.crt.erb)
  • config/certs/metrics.crt (from metrics.crt.erb)
  • config/certs/metrics.key (from metrics.key.erb)
  • config/certs/metrics_ca.crt (from metrics_ca.crt.erb)
  • config/prom_scraper_config.yml (from prom_scraper_config.yml.erb)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.