Skip to content

adapter job from cf-syslog-drain/6.1

Github source: 5f95eab or master branch

Properties

metric_emitter

interval

The interval that metrics are emitted to metron.

Default
1m

scalablesyslog

adapter

bosh_dns

Enable Bosh DNS. Disabling this implies Consul DNS.

Default
false
health

The port for the adapter health endpoint.

Default
8080
keepalive

The duration for sending keepalive packets for TCP and TLS syslog drains. Setting this to zero disables keepalives.

Default
30s
logs
addr

The address of the Reverse Log Proxy (RLP) if Bosh DNS is not enabled.

Default
reverse-log-proxy.service.cf.internal:8082
max_bindings

The maximum number of bindings that can be serviced by an adapter.

Default
500
metrics_to_syslog_enabled

By setting this value to true, the adapter will support writing metrics into a syslog drain. Note, this feature requires Loggregator v101 or higher.

Default
true
port

The port for the adapter to listen on gRPC.

Default
4443
pprof

The port for pprof on the adapter.

Default
0
syslog_dial_timeout

The timeout duration for dialing syslog drains.

Default
5s
syslog_io_timeout

The timeout duration for writing to syslog drains.

Default
1m
syslog_skip_cert_verify

This disables TLS verification when connecting to a HTTPS or a Syslog TLS drain.

Default
false
tls
ca

When the adapter accepts connections via gRPC it must validate the clients’ certificates were signed by a trusted CA. This is the CA trusted by the adapter.

cert

This certificate is sent to gRPC clients when they initiate a connection. It must be signed by a CA that is trusted by the client.

cn

The common name for the adapters TLS certificate.

key

This is the private key for the certificate sent to gRPC clients when they initiate a connection.

adapter_rlp

tls
ca

When the adapter communicates with the RLP it must validate the RLP’s certificates were signed by a trusted CA. This is the CA trusted by the adapter for that communication.

cert

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

cn

When the adapter communicates with the RLP it must validate the RLP’s common name (CN) or subject alternative names (SANs) against the hostname or IP address used to initiate the connection. Since we use a custom CN for RLP this must be set to that value for validation to be successful.

key

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

metric_ingress_addr

The address used to send metric data to metron.

Default
localhost:3458

metric_ingress_cn

When the adapter communicates with metron it must validate metron’s common name (CN) or subject alternative names (SANs) against the hostname or IP address used to initiate the connection. Since we use a custom CN for metron this must be set to that value for validation to be successful.

Default
metron

Templates

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

  • bin/ctl (from ctl.erb)
  • bin/drain (from drain.erb)
  • bin/environment.sh (from environment.sh.erb)
  • certs/adapter.crt (from adapter.crt.erb)
  • certs/adapter.key (from adapter.key.erb)
  • certs/adapter_rlp.crt (from adapter_rlp.crt.erb)
  • certs/adapter_rlp.key (from adapter_rlp.key.erb)
  • certs/ca.crt (from ca.crt.erb)
  • certs/rlp_ca.crt (from rlp_ca.crt.erb)

Packages

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