Simple Cloud Logging

Very simple library to write log files.

I tested this library in the following operative systems:

• Ubuntu 18.4,
• Ubuntu 20.4,
• Windows Server 2008,
• Windows Server 2012.

Email to me if you want to collaborate.

Outline

1. Installation
2. Getting Started
3. Nested Logging
4. Persistent Logging
5. Dummy Logging

1. Installation

gem install simple_cloud_logging

2. Getting Started

Create a new file:

touch ~/example.rb

require 'simple_cloud_logging'

logger = BlackStack::BaseLogger.new(nil)

logger.logs("Get random number... ")
@n = rand(10)
logger.done

logger.logs("Check if #{@n.to_s}>=5... ")
if @n>=5
  logger.yes
else
  logger.no
end

ruby ~/example.rb

20191105204211:Declare variable... done
20191105204211:Check if 5>5... no

3. Nested Logging

require 'simple_cloud_logging'

logger = BlackStack::BaseLogger.new(nil)

logger.logs("Declare array of array of numbers... ")
@a = [[1,2,3],[4,5,6],[7,8,9,10]] 
logger.done

logger.logs("Process array of array elements... ")
@a.each { |b|
  logger.logs("Process array of numbers... ")
  b.each { |n|
    logger.logs("Check if #{n.to_s}>5... ")
    if n>5
      logger.yes
    else
      logger.no
    end
  }
  logger.done
}
logger.done

ruby ~/example.rb

20191105204410:Declare array of array of numbers... done
20191105204410:Process array of array elements...
 > Process array of numbers...
 >  > Check if 1>5... no
 >  > Check if 2>5... no
 >  > Check if 3>5... no
 > done

 > Process array of numbers...
 >  > Check if 4>5... no
 >  > Check if 5>5... no
 >  > Check if 6>5... yes
 > done

 > Process array of numbers...
 >  > Check if 7>5... yes
 >  > Check if 8>5... yes
 >  > Check if 9>5... yes
 >  > Check if 10>5... yes
 > done
done

4. Persistent Logging

Use the LocalLogger class instead BaseLogger.

logger = BlackStack::LocalLogger.new('./example.log')

5. Dummy Logging

The methods of the DummyLogger class just do nothing.

You can choose between LocalLogger or DummyLogger depending if you want to write log or not, dynamically.

DummyLogger is used to pass or not a logger to a function, for deep-nested logging.

Example:

class FooClass
    attr_accessor :logger

    def initialize(the_logger=nil)
        self.logger=the_logger
        self.logger = BlackStack::DummyLogger.new(nil) if self.logger.nil? # assign a dummy logger that just generate output on the screen
    end

    def do_something()
      self.logger.logs 'This log line will show up in the console only if the logger is not a DummyLogger instance...'
      # do something here
      self.logger.done
    end
end # class FooClass

Versioning

We use SemVer for versioning. For the versions available, see the last ruby gem.

Authors

• Leandro Daniel Sardi - Initial work - LeandroSardi

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Further Work

1. HTML/Javascript widget to connect any server via SSH and pull the log lines to a web dashboard.