Skip to content

Commit

Permalink
Bump to version 2.0.0
Browse files Browse the repository at this point in the history
- Update build.sbt
- Update release notes
  • Loading branch information
stevedlawrence committed Apr 14, 2023
1 parent 5cd0a05 commit a5de164
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 23 deletions.
62 changes: 40 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,50 @@
Syslog Protocol DFDL Schema
====
Support for:
- RFC-5424
- RFC-3164
- Cisco
- ESXi
Includes support for the following syslog variants:

There are two root elements to choose from:
- RFC-5424 (`syslog-rfc5424.dfdl.xsd`)
- RFC-3164 (`syslog-rfc3164.dfdl.xsd`)
- Cisco (`syslog-cisco.dfdl.xsd`)
- ESXi (`syslog-esxi.dfdl.xsd`)

Syslog - straight RFC 5423 logging
Each file defines the format of a specific variant as well as a root element
that can be used to parse only that variant.

SolarwindsSyslog - The combined Solarwinds Syslog
format which supports all the above-listed formats.
To support all possible variants, the `syslog.dfdl.xsd` file defines a `Syslog`
root element.

This schema works with the Daffodil DFDL implementation.
It uses dfdl:inputValueCalc and dfdl:outputValueCalc in
the Facility and Severity elements.
To support all possible variants from a Solarwinds log forwarder, which inserts
data immediately after the priority value, the `syslog-solarwinds.dfdl.xsd`
file defines a `SolarwindsSyslog` root element.

A portable version works also with IBM DFDL.
This doesn't parse the Prival information into
Facility and Severity, but is otherwise identical.
## Portability

Change History
This schema is known to work with the Daffodil DFDL implementation. It uses
dfdl:inputValueCalc and dfdl:outputValueCalc in the Facility and Severity
elements, which do not work with IBM DFDL.

* 0.1.0: Initial support for RFC-5424, RFC-3164 and Cisco
* 0.1.1: Support for ESXi
* 0.1.2: Support for Solarwinds as well as standard Syslog in same schema.
* 1.0.0: Portable variant that works with IBM DFDL.
Removed version number from namespace URI.
Changed branding from Tresys to Owl.
However, the `common.dfdl.xsd` file can be modified to enable support for IBM
DFDL. See the documentation annotations in the `PriorityValue` groups for
details on the needed adjustments. Additionally, `encodingErrorPolicy` must be
changed from "replace" to "error" when used with IBM DFDL

## Release Notes

### 2.0.0
- Modifies Syslog element to support all variants at once
- New schemas support parsing only individual variants
- Removes IBM DFDL portability, but provides details to make it portable

### 1.0.0
- Portable variant that works with IBM DFDL.
- Removed version number from namespace URI.
- Changed branding from Tresys to Owl.

### 0.1.2
- Support for Solarwinds as well as standard Syslog in same schema.

### 0.1.1
- Support for ESXi

### 0.1.0:
- Initial support for RFC-5424, RFC-3164 and Cisco
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name := "dfdl-syslog"

organization := "com.owlcyberdefense"

version := "1.0.0"
version := "2.0.0"

scalaVersion := "2.12.11"

Expand Down

0 comments on commit a5de164

Please sign in to comment.