Skip to content

Commit

Permalink
chore: updating notes on default listening port
Browse files Browse the repository at this point in the history
  • Loading branch information
thezackm committed Dec 16, 2021
1 parent 8fe2695 commit c7750cf
Showing 1 changed file with 9 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -82,12 +82,16 @@ Set up your network devices so they send syslog data to New Relic One.
<td>Inbound</td>
<td>Source devices for syslog data</td>
<td>Docker host</td>
<td>514 (default)</td>
<td>5143 (default)</td>
<td>UDP</td>
</tr>
</tbody>
</table>

<Callout variant="tip">
It is important to note that the default listening port for **ktranslate** is `5143 (TCP/UDP)`. If you need to use the default syslog port of `514` (or any other port) you can do so by providing a new listening endpoint during Docker runtime. e.g.: `-syslog="0.0.0.0:514`
</Callout>

## Set up network syslog monitoring in New Relic One [#setup-network-syslog-monitoring]

1. From a Linux host with Docker installed, download the **ktranslate** image from [dockerhub](https://hub.docker.com/) by running
Expand All @@ -109,15 +113,15 @@ Set up your network devices so they send syslog data to New Relic One.
syslogDevice:
device_name: edge-router
device_ip: 10.10.1.254
flow_only: true
ping_only: true
# Optional user tags
user_tags:
owning_team: net_eng
environment: production
```

<Callout variant="tip">
If you're already monitoring SNMP data devices that send network syslog, you don't need to add them in your `snmp-base.yaml` file a second time.
If you're already monitoring SNMP data devices that send network syslog, you don't need to add them in your `snmp-base.yaml` file a second time. The `ping_only` attribute used in the configuration file can optionally be replaced with `flow_only` to remove response time monitoring and only collect syslog messages from the host.
</Callout>

4. Run `ktranslate` to listen for network syslog by running:
Expand All @@ -133,6 +137,8 @@ Set up your network devices so they send syslog data to New Relic One.
-metrics=jchf \
-tee_logs=true \
-service_name=syslog \
## Optional: To override the default listening port of "0.0.0.0:5143":
## -syslog="<ip_address>:<port>"
nr1.syslog
```

Expand Down

0 comments on commit c7750cf

Please sign in to comment.