ecs-logging 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43b9e37dc57c2eadf7ea3e27ba6ee4060d94e814dc4921e1262702927b9a8a12
-  data.tar.gz: a255a92fc7cf973b266ecc8e8eec64f599cba52c45b033c15920280ef590fd2d
+  metadata.gz: 1915b7e8e0bb7478ec5f730ab0362392f09f820ac12d79fd3474f87e207a05a3
+  data.tar.gz: e4100217b49ec650f2594176976f8f452a64cf26e7b807b99e1baca6fc47cbb0
 SHA512:
-  metadata.gz: 0d47468fc499ebd03c1335a55a2d7c4f0b0dac14a92865d6a847c9c7dc10035ba067ae2c5c9a5469545483dc62d4f3f0429ac2232bbf054a64e97da258f87863
-  data.tar.gz: 37353532f52a56192916c791871eed288b57001a44df012f2a582cfb06f78c3dbe535f0fe478071e0a7dded74896679163f9d5b8388d7709e0504578b1cda7ef
+  metadata.gz: 27e97608af308c9efed7211c0a50cef1f9832a6aa57ac4eb4c80d01d25d9b3cd28b3a01fb73cbbb88ee9a314ffa5c5cc45bdd8eddd645d7752741f21d10f43ed
+  data.tar.gz: 15abf89d399284aaad1517508358a8a5b34da28bdf1b442164be2f905a790eaa44b49978c7ab7285024e50b3c035e9f155b846da6acb85e5dea6b39a9042042e

data/.ci/Jenkinsfile

@@ -46,11 +46,11 @@ pipeline {
         axes {
           axis {
             name 'RUBY_VERSION'
-            values 'ruby:2.7', 'ruby:2.6', 'ruby:2.5', 'ruby:2.4', 'ruby:2.3', 'jruby:9.2', 'jruby:9.1'
+            values 'ruby:2.7', 'ruby:2.6', 'ruby:2.5', 'ruby:2.4', 'ruby:2.3', 'jruby:9.2'
           }
           axis {
             name 'FRAMEWORK'
-            values 'rails-6.0', 'rails-5.2', 'rails-5.1', 'sinatra-2.0'
+            values 'rails-6.1', 'rails-6.0', 'rails-5.2', 'sinatra-2.0'
           }
         }
         stages {

data/.gitignore

@@ -16,3 +16,6 @@ Gemfile.lock
 
 # junit reports folder
 spec/junit-reports
+
+# Doc build files
+html_docs

data/CHANGELOG.asciidoc

@@ -35,6 +35,13 @@ endif::[]
 [[release-notes-0.x]]
 === ECS logging Ruby 0.x
 
+[[release-notes-0.2.1]]
+==== 0.2.1 (2021-01-13)
+
+===== Fixed
+
+- Calling severity methods without a progname {pull}13[#13]
+
 [[release-notes-0.2.0]]
 ==== 0.2.0 (2020-12-09)
 

data/Dockerfile

@@ -34,7 +34,7 @@ RUN gem update --system && \
       gem install bundler:$BUNDLER_VERSION
 
 # Use unpatched, system version for more speed over less security
-RUN gem install nokogiri -- --use-system-libraries
+RUN gem install nokogiri -v 1.10.10 -- --use-system-libraries
 
 WORKDIR /app
 

data/README.md

@@ -10,115 +10,9 @@ See [ecs-logging](https://github.com/elastic/ecs-logging) for other ECS logging
 
 **Please note** that this library is in a <strong>pre-1.0</strong> version and backwards-incompatible changes might be introduced in future releases. While we strive to comply to [semver](https://semver.org/), we can not guarantee to avoid breaking changes in minor releases.
 
-## Installation
+## Documentation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'ecs-logging'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install ecs-logging
-
-## Usage
-
-`Ecs::Logger` is a subclass of Ruby's own [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) and responds to the same methods.
-
-```ruby
-require 'ecs/logger'
-
-logger = Ecs::Logger.new($stdout)
-logger.info('my informative message')
-logger.warn { 'be aware that…' }
-logger.error('a_progname') { 'oh no!' }
-```
-
-Logs the following JSON to `$stdout`:
-
-```ndjson
- {"@timestamp":"2020-11-24T13:32:21.329Z","log.level":"INFO","message":"very informative","ecs.version":"1.4.0"}
- {"@timestamp":"2020-11-24T13:32:21.330Z","log.level":"WARN","message":"be aware that…","ecs.version":"1.4.0"}
- {"@timestamp":"2020-11-24T13:32:21.331Z","log.level":"ERROR","message":"oh no!","ecs.version":"1.4.0","process.title":"a_progname"}
-```
-
-Additionally, it allows for adding additional keys to messages, eg:
-
-```ruby
-logger.info('ok', labels: { my_label: 'value' }, 'trace.id': 'abc-xyz')
-```
-
-Logs:
-
-```json
-{
-  "@timestamp":"2020-11-24T13:32:21.331Z",
-  "log.level":"ERROR",
-  "message":"oh no!",
-  "ecs.version":"1.4.0",
-  "labels":{"my_label":"value"},
-  "trace.id":"abc-xyz"
-}
-```
-
-To include info about where the log was called, call the methods with `include_origin: true`, like:
-
-```ruby
-logger.warn('Hello!', include_origin: true)
-```
-
-Resulting in
-
-```json
-{
-  "@timestamp":"2020-11-24T13:32:21.331Z",
-  "log.level":"WARN",
-  "message":"Hello!",
-  "ecs.version":"1.4.0",
-  "log.origin": {
-    "file.line": 123,
-    "file.name": "my_file.rb",
-    "function": "call"
-  }
-}
-```
-
-## Usage with Rack
-
-```ruby
-use EcsLogging::Middleware, $stdout
-```
-
-Example output:
-
-```json
-{
-  "@timestamp":"2020-12-07T13:44:04.568Z",
-  "log.level":"INFO",
-  "message":"GET /",
-  "ecs.version":"1.4.0",
-  "client":{
-    "address":"127.0.0.1"
-  },
-  "http":{
-    "request":{
-      "method":"GET",
-      "body.bytes":"0"
-    }
-  },
-  "url":{
-    "domain":"example.org",
-    "path":"/",
-    "port":"80",
-    "scheme":"http"
-  }
-}
-```
+Ready to get started? Documentation is at [elastic.co](https://www.elastic.co/guide/en/ecs-logging/ruby/current/index.html).
 
 ## License
 

data/docs/index.asciidoc

@@ -0,0 +1,16 @@
+:ecs-repo-dir:  {ecs-logging-root}/docs/
+
+include::{docs-root}/shared/versions/stack/current.asciidoc[]
+include::{docs-root}/shared/attributes.asciidoc[]
+
+ifdef::env-github[]
+NOTE: For the best reading experience,
+please view this documentation at https://www.elastic.co/guide/en/ecs-logging/ruby/current/index.html[elastic.co]
+endif::[]
+
+= ECS Logging Ruby Reference
+
+ifndef::env-github[]
+include::./intro.asciidoc[Introduction]
+include::./setup.asciidoc[Set up]
+endif::[]

data/docs/intro.asciidoc

@@ -0,0 +1,10 @@
+[[intro]]
+== Introduction
+
+ECS loggers are formatter/encoder plugins for your favorite logging libraries.
+They make it easy to format your logs into ECS-compatible JSON.
+
+TIP: Want to learn more about ECS, ECS logging, and other available language plugins?
+See the {ecs-logging-ref}/intro.html[ECS logging guide].
+
+Ready to jump into `ecs-logging-ruby`? <<setup,Get started>>.

data/docs/setup.asciidoc

@@ -0,0 +1,145 @@
+[[setup]]
+== Get started
+
+[float]
+[[setup-step-1]]
+=== Step 1: Set up application logging
+
+[float]
+==== Add the dependency
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'ecs-logging'
+----
+
+Execute with:
+
+[source,cmd]
+----
+bundle install
+----
+
+Alternatively, you can install the package yourself with:
+
+[source,cmd]
+----
+gem install ecs-logging
+----
+
+[float]
+==== Configure
+
+`Ecs::Logger` is a subclass of Ruby's own https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html[`Logger`]
+and responds to the same methods.
+
+For example:
+
+[source,ruby]
+----
+require 'ecs_logging/logger'
+
+logger = EcsLogging::Logger.new($stdout)
+logger.info('my informative message')
+logger.warn { 'be aware that…' }
+logger.error('a_progname') { 'oh no!' }
+----
+
+Logs the following JSON to `$stdout`:
+
+[source,json]
+----
+{"@timestamp":"2020-11-24T13:32:21.329Z","log.level":"INFO","message":"very informative","ecs.version":"1.4.0"}
+ {"@timestamp":"2020-11-24T13:32:21.330Z","log.level":"WARN","message":"be aware that…","ecs.version":"1.4.0"}
+ {"@timestamp":"2020-11-24T13:32:21.331Z","log.level":"ERROR","message":"oh no!","ecs.version":"1.4.0","process.title":"a_progname"}
+----
+
+Additionally, it allows for adding additional keys to messages.
+
+For example:
+
+[source,ruby]
+----
+logger.info('ok', labels: { my_label: 'value' }, 'trace.id': 'abc-xyz')
+----
+
+Logs the following:
+
+[source,json]
+----
+{
+  "@timestamp":"2020-11-24T13:32:21.331Z",
+  "log.level":"ERROR",
+  "message":"oh no!",
+  "ecs.version":"1.4.0",
+  "labels":{"my_label":"value"},
+  "trace.id":"abc-xyz"
+}
+----
+
+To include info about where the log was called, call the methods with `include_origin: true`,
+like `logger.warn('Hello!', include_origin: true)`. This logs:
+
+[source,json]
+----
+{
+  "@timestamp":"2020-11-24T13:32:21.331Z",
+  "log.level":"WARN",
+  "message":"Hello!",
+  "ecs.version":"1.4.0",
+  "log.origin": {
+    "file.line": 123,
+    "file.name": "my_file.rb",
+    "function": "call"
+  }
+}
+----
+
+[float]
+==== Rack configuration
+
+[source,ruby]
+----
+use EcsLogging::Middleware, $stdout
+----
+
+Example output:
+
+[source,json]
+----
+{
+  "@timestamp":"2020-12-07T13:44:04.568Z",
+  "log.level":"INFO",
+  "message":"GET /",
+  "ecs.version":"1.4.0",
+  "client":{
+    "address":"127.0.0.1"
+  },
+  "http":{
+    "request":{
+      "method":"GET",
+      "body.bytes":"0"
+    }
+  },
+  "url":{
+    "domain":"example.org",
+    "path":"/",
+    "port":"80",
+    "scheme":"http"
+  }
+}
+----
+
+[float]
+[[setup-step-2]]
+=== Step 2: Enable APM log correlation (optional)
+If you are using the Elastic APM Ruby agent,
+{apm-ruby-ref}/log-correlation.html[enable log correlation].
+
+[float]
+[[setup-step-3]]
+=== Step 3: Configure Filebeat
+
+include::{ecs-repo-dir}/setup.asciidoc[tag=configure-filebeat]

data/lib/ecs_logging/logger.rb

@@ -57,7 +57,7 @@ module EcsLogging
     end
 
     %w[unknown fatal error warn info debug].each do |severity|
-      define_method(severity) do |progname, include_origin: false, **extras, &block|
+      define_method(severity) do |progname = nil, include_origin: false, **extras, &block|
         if include_origin && origin = origin_from_caller(caller)
           extras[:"log.origin"] = origin
         end

data/lib/ecs_logging/version.rb

@@ -18,5 +18,5 @@
 # frozen_string_literal: true
 
 module EcsLogging
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecs-logging
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2021-01-13 00:00:00.000000000 Z
 dependencies: []
 description: Write a longer description or delete this line.
 email:
@@ -36,6 +36,9 @@ files:
 - bin/dev
 - docker-compose.yml
 - docker/entrypoint.sh
+- docs/index.asciidoc
+- docs/intro.asciidoc
+- docs/setup.asciidoc
 - ecs-logging.gemspec
 - lib/ecs-logging.rb
 - lib/ecs_logging.rb