> ## Documentation Index
> Fetch the complete documentation index at: https://docs.controlplane.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Syslog

## Overview

[Syslog](https://www.rfc-editor.org/rfc/rfc3164) is a protocol used for sending and storing log messages across networked devices and systems.

With Syslog, you can collect and analyze log messages, monitor system and network activity, set up centralized log management, and automate responses to critical events. This enhances operational visibility and ensures the reliability and stability of your applications and infrastructure.

Follow the steps below to configure log shipping to Syslog.

## Step 1 - Prerequisites

* **Syslog Endpoint**: A reachable hostname for your Syslog server.
* **Port**: Standard Syslog uses port `514` (TCP).

## Step 2 - Configure External Logging

External logging can be configured by using either the [UI Console](#enable-logging-using-the-ui-console) or [CLI](#enable-logging-using-the-cli).

### Enable Logging using the UI Console

1. From the Control Plane Console UI, click on `Org` in the left menu.
2. Click `External Logs` in the middle context menu.
3. Select `Syslog` and fill out the required fields.
4. Click `Save`.
5. After the configuration is complete, log entries will begin forwarding to your Syslog Server within a few minutes.

### Enable Logging using the CLI

The external logging configuration can be created / updated using the CLI's `cpln org patch ORG_NAME -f FILE.yaml` command.

Below is an example of an [Org](/reference/org) manifest (in YAML). Edit and save the YAML as a file and use it as an input to the CLI's `cpln org patch ORG_NAME -f FILE.yaml` command.

* Substitute: ORG\_NAME, HOST\_NAME, PORT, and possibly the severity.

```yaml YAML theme={null}
kind: org
name: ORG_NAME
spec:
  logging:
    syslog:
      format: rfc3164
      host: HOST_NAME
      mode: tcp
      port: PORT
      severity: 6
```