mee-rfc5424 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: d766783fd7ee29bd314f93b9e3d40848a5165f28
4
- data.tar.gz: a27afcc5b2cd2a7a5d5cc82bbaceb0933f6a60bf
3
+ metadata.gz: 40a4ca6ae1923a3fecf2879dc2bb22f27f28159d
4
+ data.tar.gz: a1ef9ed122936a0d5e94002018a286e6a1dc92a2
5
5
  SHA512:
6
- metadata.gz: fb473eb11cddf493b358268b1caa0f8e0cacea99c63d1e5092eb020df3e13670fa18177f7b1b6aec9bfd809267dd885047c0ff59bd7553f359db766913988472
7
- data.tar.gz: aa2ea0a52bbc9d5da728d6c2caf7cfa85732cb5d9cdea7584481a607b4a3c4b81381c6e5428490d99e5f6009ee154e04e61aa04e06e67e4fa89ac30f00d1c7fa
6
+ metadata.gz: 9c9cecdd347e198f7dec7e819da57872e1b063ff30f83cef47ec097374d0ab913cd672260f850ced4e2b67462a9d6ebfb83571610e0e3ebfe6057d393ac4dd94
7
+ data.tar.gz: 4ab8eeab50477a97c577e24d004cdfbfb2a4a6bad90d3c763d57ebda31bd9f968e033ac62dc62965f4a1813d94b06e80bf35cddf43776739e5735b6995544117
data/README.md CHANGED
@@ -1,8 +1,6 @@
1
- # Mee::Rfc5424
1
+ # MEE::Rfc5424
2
2
 
3
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mee/rfc5424`. To experiment with that code, run `bin/console` for an interactive prompt.
4
-
5
- TODO: Delete this and the text above, and describe your gem
3
+ Ruby loggger capable of logging against Syslog (RFC5424) over TCP and Syslog over TLS. Logs may be in either non-transparent newline framing or octet counting framing.
6
4
 
7
5
  ## Installation
8
6
 
@@ -22,7 +20,21 @@ Or install it yourself as:
22
20
 
23
21
  ## Usage
24
22
 
25
- TODO: Write usage instructions here
23
+ By default the loggers will use transparent octet counting.
24
+
25
+ ### TCP Syslog connection
26
+
27
+ ```ruby
28
+ logger = MEE::RFC5424.tcp( 'syslog.host', 514 )
29
+ logger.info { "TCP logging message" }
30
+ ```
31
+
32
+ ### TLS Syslog connection
33
+
34
+ ```ruby
35
+ logger = MEE::RFC5424.tls( 'syslog.host', 10242 )
36
+ logger.info { "TLS message logging" }
37
+ ```
26
38
 
27
39
  ## Development
28
40
 
@@ -34,3 +46,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
34
46
 
35
47
  Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mee-rfc5424.
36
48
 
49
+ ## Licensing
50
+
51
+ Licensed under the temrs of the MIT license
@@ -1,5 +1,5 @@
1
1
  module MEE
2
2
  module RFC5424
3
- VERSION = "0.1.0"
3
+ VERSION = "0.1.1"
4
4
  end
5
5
  end
@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
8
8
  spec.version = MEE::RFC5424::VERSION
9
9
  spec.authors = ["Mark Eschbach"]
10
10
  spec.email = ["meschbach@gmail.com"]
11
+ spec.license = "MIT"
11
12
 
12
13
  spec.summary = %q{Utilities for dealing with RFC5424}
13
14
  spec.description = %q{Initial scope is to produce loggers for TLS compliant to RFC5424.}
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mee-rfc5424
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Mark Eschbach
@@ -85,7 +85,8 @@ files:
85
85
  - lib/mee/rfc5424/version.rb
86
86
  - mee-rfc5424.gemspec
87
87
  homepage: https://github.com/meschbach/ruby-rfc5424
88
- licenses: []
88
+ licenses:
89
+ - MIT
89
90
  metadata: {}
90
91
  post_install_message:
91
92
  rdoc_options: []