SYSLOG_DRAIN.md

Syslog Drain

Each service plan defined at the settings file can have a single syslog drain. If defined, Cloud Foundry would drain events and logs to the service for the bound applications.

As defined at the Application Log Streaming, a syslog_drain permission is required for events and logs to be automatically wired to applications.

Properties format

Each service plan defined at the settings file might contain the following properties:

Field	Required	Type	Description
syslog_drain_port	N	String	Container port to be exposed (format: port</protocol>).
syslog_drain_protocol	N	String	Syslog protocol (syslog, syslog-tls, https).

Example

This example will create a plan that will provision a logstash service container (Dockerfile) and it will expose the syslog drain container port 514/tcp. When an application is bound to the service, it will receive a syslog drain URL following this pattern: syslog-tls://<HOST IP>:#<HOST PORT MAPPED TO CONTAINER PORT 514/tcp>. Cloud Foundry will automatically drain all the application events and logs to this URL.

plans:
  - id: '5218782d-7fab-4534-92b8-434204d88c7b'
    name: 'free'
    container:
      backend: 'docker'
      image: 'frodenas/logstash'
    syslog_drain_port: '514/tcp'
    syslog_drain_protocol: 'syslog-tls'