You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: managing-cf/logging-config.html.md.erb
+12-11Lines changed: 12 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -7,27 +7,28 @@ owner: Logging and Metrics
7
7
8
8
This topic explains how to configure the Cloud Foundry [Loggregator system](../../loggregator/architecture.html).
9
9
10
-
## <aid='scaling'></a> Scaling Loggregator ##
10
+
11
+
## <aid='scaling'></a> Scaling Loggregator
11
12
12
13
Cloud Foundry system components and apps constantly generate log and metrics data. The [Metron](../../loggregator/architecture.html#metron) agent running on each component or application VM collects and sends this data out to [Doppler](../../loggregator/architecture.html#doppler) components, which temporarily buffer the data before periodically forwarding it to the [Traffic Controller](../../loggregator/architecture.html#traffic-controller). The Traffic Controller then serves the aggregated data stream through the Firehose WebSocket endpoint.
13
14
14
15
When the log and metrics data input to a Doppler exceeds its buffer size for a given interval, data can be lost. You can take several actions to minimize this loss.
15
16
16
-
17
-
### Add additional Doppler server instances
17
+
### <aid='add-doppler-server'></a> Add Additional Doppler Server Instances
18
18
19
19
You can increase the number of Doppler servers by increasing the `instances` property for the `doppler_z1` and `doppler_z2` jobs in your Cloud Foundry BOSH deployment manifest.
20
20
21
-
## <aid='syslog-forward'></a> Enabling System Log Forwarding ##
21
+
22
+
## <aid='syslog-forward'></a> Enabling System Log Forwarding
22
23
23
24
Cloud Foundry can forward syslog data to an external aggregator using the [syslog-release](https://github.com/cloudfoundry/syslog-release).
You can customize each Loggregator component by changing its properties in the CF deployment manifest. The following details some of the most commonly used changes.
29
30
30
-
### Doppler ###
31
+
### <aid='doppler'></a> Doppler
31
32
32
33
<table>
33
34
<tr>
@@ -182,7 +183,7 @@ You can customize each Loggregator component by changing its properties in the C
@@ -286,7 +287,7 @@ You can customize each Loggregator component by changing its properties in the C
286
287
</tr>
287
288
</table>
288
289
289
-
### Metron Agent ###
290
+
### <aid='metron-agent'></a>Metron Agent
290
291
291
292
<table>
292
293
<tr>
@@ -311,12 +312,12 @@ You can customize each Loggregator component by changing its properties in the C
311
312
</tr>
312
313
<tr>
313
314
<td>syslog_daemon_config.transport</td>
314
-
<td>Transport to use when forwarding logs. Accepts the following values: <code>tcp</code>, <code>udp</code>, or <code>relp</code></td>
315
+
<td>Transport to use when forwarding logs. Accepts the following values: <code>tcp</code>or <code>udp</code></td>
315
316
<td><code>tcp</code></td>
316
317
</tr>
317
318
<tr>
318
319
<td>syslog_daemon_config.fallback_addresses</td>
319
-
<td>IP addresses of fallback servers to use if primary syslog server is unavailable. Only </code>tcp</code>and <code>relp</code>supported. Each list entry must consist of address, transport, and port keys.</td>
320
+
<td>IP addresses of fallback servers to use if primary syslog server is unavailable. Only </code>tcp</code> supported. Each list entry must consist of address, transport, and port keys.</td>
320
321
<td><code>[]</code></td>
321
322
</tr>
322
323
<tr>
@@ -441,7 +442,7 @@ You can customize each Loggregator component by changing its properties in the C
The Cloud Foundry components share a common interface for configuring logs. For more information, see the [Cloud
13
14
Controller](http://github.com/cloudfoundry/cloud_controller_ng#logs), or for
@@ -19,18 +20,19 @@ In `cf-release`, the components are all configured in a similar way:
19
20
* The job's main logs are written to a file named `<job-name>.log`.
20
21
* Any output written directly to the job's stdout and stderr is written to `<job-name>.stdout.log` and `<job-name>.stderr.log`, respectively.
21
22
22
-
### Database Migrations
23
+
### <aid='db-migration'></a>Database Migrations
23
24
24
25
For the Cloud Controller, database migration logs are written to `db_migrate.stdout.log` and `db_migrate.stderr.log`
25
26
in the same directory.
26
27
27
-
## Log Forwarding
28
+
29
+
## <aid='log-forwarding'></a> Log Forwarding
28
30
29
31
Each BOSH job in `cf-release` includes a job named `metron_agent`. Metron itself acts as a forwarding agent for Doppler within the Loggregator metric system, but it also includes a [template](https://github.com/cloudfoundry/loggregator/blob/develop/jobs/metron_agent/templates/syslog_forwarder.conf.erb) for configuring the `rsyslogd` daemon to forward logs to a remote machine. The [`syslog_daemon_config`](https://github.com/cloudfoundry/loggregator/blob/develop/jobs/metron_agent/spec) properties include:
30
32
31
33
* `syslog_daemon_config.address`: the IP address (or DNS name) of a remote system that should receive component logs from this VM
32
34
* `syslog_daemon_config.port`: the port on which the log recipient is listening
33
-
* `syslog_daemon_config.transport`: the protocol over which logs should be sent (one of `tcp`, `udp` or `relp`); defaults to `tcp`
35
+
* `syslog_daemon_config.transport`: the protocol over which logs should be sent (one of `tcp`or `udp`); defaults to `tcp`
34
36
35
37
For example, to use UDP as the syslog transport, the manifest is similar to the following:
0 commit comments