Syslog

KumoScale software supports configuring a Syslog server to log KumoScale events. Once configured, all configuration commands sent to the KumoScale cluster, and all of the alerts generated by the cluster, will be sent to the Syslog server. The KumoScale Provisioner service reads the Syslog configuration from the KumoScale storage nodes, collects event data from the connected application hosts, and sends these to the Syslog server.

Deploying a Syslog Server

To set up a Syslog server, you need to define and deploy information using the Syslog CR provided with KumoScale software as follows:

  • Create the Syslog CR.
  • Configure a Syslog

At this point the Syslog server is set up on the KumoScale storage cluster.

Create the Syslog Custom Resource

KumoScale software provides a Syslog CR file you can use to define your own CR.

  • Make a copy of kioxia.com_v1_telemetry_cr.yaml for editing, and save to a separate directory (e.g., deploy/crds/myapp_syslog_cr.yaml).
  • Update yaml with values for the parameters listed in Syslog Parameters.

Syslog Parameters

The following information is needed to add a Syslog server to a KumoScale cluster:

Syslog Parameter

Description

Optional/Required

url

The host url of the server in the format of: <protocol>://<ip/host>:<port>.

Required

tls

Whether or not a secure connection should be used with TLS/SSL (the default is false).

Optional

certFileName

The certificate filename (when used, TLS is true).

Required when tls=True

Example Syslog CR

apiVersion: kumoscale.kioxia.com/v1

kind: Syslog

metadata:

name: syslog1

spec:

syslog:

   url: udp://172.28.141.30:10514

   useTls: false

Configure Syslog

To set up the Syslog server with name = syslog1 defined in the CR file myapp_syslog_cr.yaml, enter the following:

kubectl create -f myapp_syslog_cr.yaml

To verify the Syslog service, use the command below

kubectl get syslog

Once syslog is configured for the storage cluster, you can also use

kubectl describe storagenodes

All storage nodes should report syslog under the STATUS section.

A KumoScale software alarm is triggered if a Syslog server cannot be reached.

Syslog Message Format

Header

The header is configured according to the Syslog section in Syslog Request for Comments (RFC) 5424:

Field

Description/Comments

PRI

A calculation regarding the severity and priority. It is implemented according to the definition in the Syslog RFC, where Facility = 1.

Host Name

The KumoScale ID

Application Name

“KumoScale”

Timestamp

The sending timestamp

Body

Field

Description / Comments

The MSG

The Syslog message.

For instance: ‘User xxx executed command yyy’ for a command or the event description (for an event).

MSG Body

A map of pairs: SD-ID, SD-PARAM>

(SD=Structured Data) of the command ID, input, and output, or event ID and entity name (for an event).

Next: Logging, Monitoring & Alerting