Chapter 1: Introduction

[Note] Note: This document is also available in other formats

A PDF version of this document along with all current and older documentation in PDF format can be found at https://my.clavister.com.

It is also available as a single HTML page.

This guide is a reference for all log messages generated by the Clavister cOS Stream. It is designed to be a valuable information source for both management and troubleshooting.

1.1. Log Message Structure

All log messages have a common design with attributes that include category, severity and recommended actions. These attributes enable the easy filtering of log messages, either within the system prior to sending them to a log receiver, or as part of analysis that takes place after the logging and storage of messages on an external log server.

The following information is provided for each specific log message:

Name

The name of the log message, which is the message's main category followed by "_" followed by a short string in which each new word begins with a capital letter.

ID

The ID is a string of digits which uniquely identifies the log message.

[Note] Note
The Name and the ID of the log message form the title of the section describing the log message.

Log Categories

Log messages belong to categories, where each category maps to a specific subsystem. For instance, the IPSEC category includes some hundreds of log messages, all related to IPSec VPN activities. A log message can belong to more than one category and each message has a main category.

In this guide, categories are listed as sections in Chapter 2, Log Message Reference and each section includes log messages with that category as their main category.

Log Message
A brief explanation of the event that took place.
Default Log Severity

The default severity level for this log message. For a list of severity levels, please see section Section 1.2, Severity levels.

SNMP Trap Category

The category of an associated SNMP Trap.

SNMP Trap MIB Name

The name of an associated SNMP Trap in the trap MIB.

SNMP Trap MIB OID

The OID of an associated SNMP Trap in the trap MIB.

Parameters

The parameter values that are included in the log message.

Explanation

A detailed explanation of the event.

Note that this information is only featured in this reference guide, and is never actually included in the log message.

Gateway Action

A short string, 1-3 words separated by _, of what action the system will take. If the log message is purely informative, this is set to "None".

Action Description

Describes what is actually meant by the specified gateway action. Note that this piece of information is only featured in this reference guide, and is never actually included in the log message.

Proposed Action

A detailed proposal of what the administrator can do if this log message is received. If the log message is purely informative, this is set to "None".

Note that this information is only featured in this reference guide, and is never actually included in the log message.