Skip to content

loggr-syslog-binding-cache job from loggregator-agent/8.1.2

Github source: d483b391 or master branch

Properties

aggregate_drains

Syslog server URLs that will receive the logs from all sources

Default
""
Example
|+
  deprecated format: "syslog-tls://some-drain-1,syslog-tls://some-drain-1"

  new format:
  aggregate_drains:
  -  url: syslog-tls://some-drain-1:1000
     cert: |
        cert
     key: |
        key
     CA: |
        ca

api

batch_size

The batch size the syslog will request the Cloud Controller for bindings.

Default
1000

disable_keep_alives

Configures if the polling connection to API is reused or not.

Default
true

override_url

Use to override the default use of cloud_controller bosh link as the URL most commonly change to cloud_controller_ng.service.cf.internal rather than the bosh specific address

polling_interval

The interval at which the syslog will poll the Cloud Controller for bindings.

Default
1m

tls

ca_cert

When the syslog communicates with the Cloud Controller it must validate the Cloud Controller’s certificate was signed by a trusted CA. This is the CA trusted by the syslog for that communication.

cert

This certificate is sent to the Cloud Controller when initiating a connection. It must be signed by a CA that is trusted by the Cloud Controller.

cn

When the syslog communicates with the Cloud Controller it must validate the Cloud Controller’s common name (CN) or subject alternative names (SANs) against the hostname or IP address used to initiate the connection. Most of the time this should be the hostname defined in api.url.

key

This is the private key for the certificate sent to the Cloud Controller when initiating a connection.

default_drain_metadata

Whether metadata is included in structured data by default

Default
true

enabled

Syslog binding cache is enabled on VM

Default
true

external_port

The port where the cache serves bindings

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
14828

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

tls

ca_cert

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

cert

TLS certificate for binding-cache 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

cn

The common name the cache will use to validate certs

key

TLS private key for binding-cache 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-syslog-binding-cache/ directory (learn more).

  • config/aggregate_drains.yml (from aggregate_drains.yml.erb)
  • config/bpm.yml (from bpm.yml.erb)
  • config/certs/api_ca.crt (from api_ca.crt.erb)
  • config/certs/api_client.crt (from api_client.crt.erb)
  • config/certs/api_client.key (from api_client.key.erb)
  • config/certs/binding_cache.crt (from binding_cache.crt.erb)
  • config/certs/binding_cache.key (from binding_cache.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.