Skip to content

Commit acff070

Browse files
Removed RELP references; fixed formatting, capitalization, etcetera [#161488956]
1 parent f7ce698 commit acff070

File tree

2 files changed

+18
-15
lines changed

2 files changed

+18
-15
lines changed

managing-cf/logging-config.html.md.erb

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,28 @@ owner: Logging and Metrics
77

88
This topic explains how to configure the Cloud Foundry [Loggregator system](../../loggregator/architecture.html).
99

10-
## <a id='scaling'></a> Scaling Loggregator ##
10+
11+
## <a id='scaling'></a> Scaling Loggregator
1112

1213
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.
1314

1415
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.
1516

16-
17-
### Add additional Doppler server instances
17+
### <a id='add-doppler-server'></a> Add Additional Doppler Server Instances
1818

1919
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.
2020

21-
## <a id='syslog-forward'></a> Enabling System Log Forwarding ##
21+
22+
## <a id='syslog-forward'></a> Enabling System Log Forwarding
2223

2324
Cloud Foundry can forward syslog data to an external aggregator using the [syslog-release](https://github.com/cloudfoundry/syslog-release).
2425

2526

26-
## <a id='customizing'></a>Customizing Loggregator Components ##
27+
## <a id='customizing'></a> Customizing Loggregator Components
2728

2829
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.
2930

30-
### Doppler ###
31+
### <a id='doppler'></a> Doppler
3132

3233
<table>
3334
<tr>
@@ -182,7 +183,7 @@ You can customize each Loggregator component by changing its properties in the C
182183
</tr>
183184
</table>
184185

185-
### Traffic Controller ###
186+
### <a id='traffic-controller'></a> Traffic Controller
186187

187188
<table>
188189
<tr>
@@ -286,7 +287,7 @@ You can customize each Loggregator component by changing its properties in the C
286287
</tr>
287288
</table>
288289

289-
### Metron Agent ###
290+
### <a id='metron-agent'></a> Metron Agent
290291

291292
<table>
292293
<tr>
@@ -311,12 +312,12 @@ You can customize each Loggregator component by changing its properties in the C
311312
</tr>
312313
<tr>
313314
<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>
315316
<td><code>tcp</code></td>
316317
</tr>
317318
<tr>
318319
<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>
320321
<td><code>[]</code></td>
321322
</tr>
322323
<tr>
@@ -441,7 +442,7 @@ You can customize each Loggregator component by changing its properties in the C
441442
</tr>
442443
</table>
443444

444-
### Syslog Drain Binder###
445+
### <a id='syslog-drain-binder'></a> Syslog Drain Binder
445446

446447
See [Using Log Management Services](../../devguide/services/log-management.html).
447448

managing-cf/logging.html.md.erb

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ owner: Logging and Metrics
77

88
This section contains information for debugging Cloud Foundry system components.
99

10-
##Component Logging
10+
11+
## <a id='component-logging'></a> Component Logging
1112

1213
The Cloud Foundry components share a common interface for configuring logs. For more information, see the [Cloud
1314
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:
1920
* The job's main logs are written to a file named `<job-name>.log`.
2021
* Any output written directly to the job's stdout and stderr is written to `<job-name>.stdout.log` and `<job-name>.stderr.log`, respectively.
2122

22-
### Database Migrations
23+
### <a id='db-migration'></a> Database Migrations
2324

2425
For the Cloud Controller, database migration logs are written to `db_migrate.stdout.log` and `db_migrate.stderr.log`
2526
in the same directory.
2627

27-
## Log Forwarding
28+
29+
## <a id='log-forwarding'></a> Log Forwarding
2830

2931
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:
3032

3133
* `syslog_daemon_config.address`: the IP address (or DNS name) of a remote system that should receive component logs from this VM
3234
* `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`
3436

3537
For example, to use UDP as the syslog transport, the manifest is similar to the following:
3638
```yaml

0 commit comments

Comments
 (0)