lokilogger 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d31b9a0ca62456df630504045404e80c8fdc08376afc0d6eb420457d9b0745b
+  data.tar.gz: '0283cd8fe736ecf933699b54d60f31a3e973d232c8794e8cdebff560624d7802'
+SHA512:
+  metadata.gz: 338a081fc21929144d234674eb0cdaf64baf35e8fec2b9f84cf01f58acae1039ef6c9a6fcde6257126aee677ea21a6e4123f30246b9c020711d636955414d36f
+  data.tar.gz: eee408bb6e620234d75bee583aad338ae1200ce04d185027600bcd3d3ac4ac1bacd168002fc09abdfe52fca48baaee7d0a47d041351b1d29f3ae0f996370c33f

data/LICENSE.adoc

@@ -0,0 +1,23 @@
+-= MIT License
+
+MIT License
+
+Copyright (c) 2023 Nils Bartels
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.adoc

@@ -0,0 +1,128 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= lokilogger
+
+toc::[]
+
+== Features
+
+Lokilogger is a gem to push logs to Grafana Loki. Some features:
+
+- Push logs to Grafana Loki (either your own or Grafana Cloud)
+- Push logs asynchronously
+
+== Requirements
+
+. link:https://www.ruby-lang.org[Ruby]
+. link:https://grafana.com/oss/loki/[Grafana Loki]
+
+== Setup
+
+To install, run:
+
+[source,bash]
+----
+gem install lokilogger
+----
+
+You can also add the gem directly to your project:
+
+[source,bash]
+----
+bundle add lokilogger
+----
+
+Once the gem is installed, you only need to require it:
+
+[source,ruby]
+----
+require "lokilogger"
+----
+
+== Rails
+
+First off, regarding Ruby on Rails:
+
+You can use Lokilogger within a Rails application. It has basic no-op implementations to make it compatible.
+However, you are strongly adviced not use Lokilogger as your default logger in Rails.
+
+Rails does not implement calls to Logger within Async do blocks and therefor calls to e.g. Lokilogger.info() will be executed synchronously.
+That call will wait for the Loki Backend to respond. If you are using Grafana Cloud this means that any request that would produce some kind of
+log message will wait for Grafana Cloud to respond. If you really want to use Lokilogger as Rails default logger please make sure
+to have a Loki instance on the same network with low latency.
+
+== Usage
+
+Start by creating a new logger instance:
+
+[source,ruby]
+----
+# pass url, username, password
+logger = Lokilogger.new({url:, log_level: 0, version: "v1", username:, password:, tags: {foo: "bar"}})
+----
+
+If you need proxy or custom TLS settings, you can optionally pass as well:
+
+- ssl_options (link:https://lostisland.github.io/faraday/#/customization/ssl-options[Faraday docs on ssl options])
+- proxy_options (link:https://lostisland.github.io/faraday/#/customization/proxy-options[Farady docs on proxy options])
+
+then it's straight forward:
+
+[source,ruby]
+----
+Async do
+  logger.debug("some debug", {useless: "tag"})
+  logger.info("an info", {useless: "tag"})
+  logger.warn("a warning", {useless: "tag"})
+  logger.error("an error", {useless: "tag"})
+  logger.fatal("a fatal", {useless: "tag"})
+  logger.unknown("into the unknown", {useless: "tag"})
+end
+----
+
+The second argument is extra_tags. This way you can pass custom tags per message. Be aware, that those cannot be nested.
+
+To set the default log level:
+
+[source,ruby]
+----
+logger.level = 1
+----
+
+Please see example/log.rb for an example implementation.
+
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone 
+cd LokiLogger
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bin/rake
+----
+
+== link:./LICENSE.adoc[License]
+
+== Credits
+
+* Built with link:https://alchemists.io/projects/gemsmith[Gemsmith].
+* Really useful help by Stefan Piep.

data/lib/lokilogger/client.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "async/http/faraday"
+require "faraday"
+require "lokilogger/error"
+
+module Lokilogger
+  # the client
+  class Client
+    def initialize config
+      @config = config
+      check_config
+
+      ssl_options = @config[:ssl_options].nil? ? nil : @config[:ssl_options]
+      proxy_options = @config[:proxy_options].nil? ? nil : @config[:proxy_options]
+      request_options = {timeout: 10, open_timeout: 10, read_timeout: 10, write_timeout: 10}
+
+      Faraday.default_adapter = :async_http
+      @conn = Faraday.new url: @config[:url], headers: {"Content-Type" => "application/json"}, ssl: ssl_options, proxy: proxy_options, request: request_options do |builder|
+        builder.request :authorization, :basic, @config[:username], @config[:password]
+      end
+    end
+
+    def check_config
+      fail ConfigError, "missing/malformed url in config" if !@config[:url] || @config[:url] !~ %r{^(http|https)://}
+      fail ConfigError, "missing version in config" unless @config[:version]
+      fail ConfigError, "missing auth username in config" unless @config[:username]
+      fail ConfigError, "missing auth password in config" unless @config[:password]
+      fail ConfigError, "missing tags in config" unless @config[:tags]
+      fail ConfigError, "missing log_level in config" unless @config[:log_level]
+    end
+
+    def log_level
+      @config[:log_level]
+    end
+
+    def log_level= log_level
+      @config[:log_level] = log_level
+    end
+
+    def request severity, message, extra_tags
+      now = Time.now
+      rational_seconds = now.to_r
+      timestamp = (rational_seconds * (10**9)).to_i.to_s
+
+      tags = @config[:tags]
+      tags = tags.merge extra_tags unless extra_tags.nil?
+      tags = tags.merge({severity:})
+
+      Async do
+        @conn.post "/loki/api/#{@config[:version]}/push" do |req|
+          body = {streams: [{stream: tags, values: [[timestamp, message]]}]}.to_json
+
+          req.body = body
+        end
+      rescue Faraday::Error => error
+        puts error.response[:status]
+        puts error.response[:body]
+      end
+    end
+  end
+end

data/lib/lokilogger/error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Lokilogger
+  # the default error
+  class Error < StandardError
+  end
+
+  # something is wrong with the config
+  class ConfigError < Error
+  end
+end

data/lib/lokilogger/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Main namespace.
+module Lokilogger
+  VERSION = "0.5.0"
+end

data/lib/lokilogger.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+Zeitwerk::Loader.new.then do |loader|
+  loader.tag = File.basename __FILE__, ".rb"
+  loader.push_dir __dir__
+  loader.setup
+end
+
+# Main namespace.
+module Lokilogger
+  def self.loader registry = Zeitwerk::Registry
+    @loader ||= registry.loaders.find { |loader| loader.tag == File.basename(__FILE__, ".rb") }
+  end
+
+  def self.new config
+    @client = Lokilogger::Client.new config
+    self
+  end
+
+  def self.debug(*args)
+    message "debug", args
+  end
+
+  def self.debug?
+    true
+  end
+
+  def self.info(*args)
+    message "info", args
+  end
+
+  def self.info?
+    true
+  end
+
+  def self.warn(*args)
+    message "warn", args
+  end
+
+  def self.warn?
+    true
+  end
+
+  def self.error(*args)
+    message "error", args
+  end
+
+  def self.error?
+    true
+  end
+
+  def self.fatal(*args)
+    message "fatal", args
+  end
+
+  def self.fatal?
+    true
+  end
+
+  def self.unknown(*args)
+    message "unknown", args
+  end
+
+  def self.unknown?
+    true
+  end
+
+  def self.level= level
+    @client.log_level = level
+  end
+
+  def self.level
+    @client.log_level
+  end
+
+  def self.formatter
+  end
+
+  def self.formatter=(*args)
+  end
+
+  def self.message(severity, *args)
+    message = args[0][0]
+    extra_tags = args[0][1] if args[0].count > 1
+
+    @client.request severity, message, extra_tags
+  end
+end

data/lokilogger.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path "lib", __dir__
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
+require "lokilogger/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "lokilogger"
+  spec.version = Lokilogger::VERSION
+  spec.authors = ["Nils Bartels"]
+  spec.email = ["rubygems@nils.bartels.xyz"]
+  spec.homepage = "https://gitlab.com/sukunai/lokilogger"
+  spec.summary = "Log asynchronously to Grafana Loki"
+  spec.license = "MIT"
+
+  spec.metadata = {"label" => "lokilogger", "rubygems_mfa_required" => "true"}
+
+  #spec.signing_key = Gem.default_key_path
+  #spec.cert_chain = [Gem.default_cert_path]
+
+  spec.required_ruby_version = "~> 3.2"
+  spec.add_dependency "async", "~> 2.6", ">= 2.6.5"
+  spec.add_dependency "async-http-faraday", "~> 0.12.0"
+  spec.add_dependency "faraday", "~> 2.7", ">= 2.7.12"
+  spec.add_dependency "refinements", "~> 11.0"
+  spec.add_dependency "zeitwerk", "~> 2.6"
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: lokilogger
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Nils Bartels
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.5
+- !ruby/object:Gem::Dependency
+  name: async-http-faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.12
+- !ruby/object:Gem::Dependency
+  name: refinements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description:
+email:
+- rubygems@nils.bartels.xyz
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.adoc
+files:
+- LICENSE.adoc
+- README.adoc
+- lib/lokilogger.rb
+- lib/lokilogger/client.rb
+- lib/lokilogger/error.rb
+- lib/lokilogger/version.rb
+- lokilogger.gemspec
+homepage: https://gitlab.com/sukunai/lokilogger
+licenses:
+- MIT
+metadata:
+  label: lokilogger
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Log asynchronously to Grafana Loki
+test_files: []