Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ecraft/logging_library
Logging library
https://github.com/ecraft/logging_library
gem logging ruby uxfactory-server
Last synced: 3 months ago
JSON representation
Logging library
- Host: GitHub
- URL: https://github.com/ecraft/logging_library
- Owner: ecraft
- License: mit
- Created: 2017-01-13T12:45:51.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-03-19T12:40:45.000Z (almost 5 years ago)
- Last Synced: 2024-10-14T12:37:09.991Z (3 months ago)
- Topics: gem, logging, ruby, uxfactory-server
- Language: Ruby
- Homepage:
- Size: 45.9 KB
- Stars: 0
- Watchers: 12
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.org/ecraft/logging_library) [](https://badge.fury.io/rb/logging_library)
# LoggingLibrary
This library provides logging support for your application or framework, with an opinionated default configuration in terms of log
format, etc.
It is compatible with both JRuby and MRI.
Wraps the functionality of [mixlog-log](https://github.com/chef/mixlib-log).
## Installation
Add this line to your application's `Gemfile`:
```ruby
gem 'logging_library'
```
And then execute:
$ bundle install
## Usage
```ruby
require 'logging_library'
class MyClass
include LoggingLibrary::Loggable
def load_data_from_database
logger.info('Starting to load data from database')
# DEBUG-level messages are not printed by default; see logger#level= if you
# want to customize the log level.
logger.debug("Running as user #{current_user}")
# If you use blocks to wrap log messages, they'll only execute if needed
logger.debug { "Score for all participants: #{expensive_operation}" }
end
def current_user
'john_doe'
end
def expensive_operation
sleep 5
9_000
end
end
```
## Environment variables
- `LOGGING_LIBRARY_DISABLE_TIMESTAMPS` - set this to any value to disable
timestamping which is otherwise performed on log entries when running in
interactive/TTY mode. This setting can be useful in scenarios where you
would otherwise get double timestamps on each line.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then,
run `rake spec` to run the tests. You can also run `bin/console` for an
interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`.
To release a new version, update the version number in `version.rb`, and then
run `bundle exec rake release`, which will create a git tag for the version,
push git commits and tags, and push the `.gem` file to
[rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at
https://github.com/ecraft/logging_library. This project is intended to
be a safe, welcoming space for collaboration, and contributors are expected to
adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
conduct.
### Documentation
We strive to write API documentation inline in [YARD](http://yardoc.org) format.
Generate API documentation using `yardoc` or `rake yard`.
Preview API documentation locally with
```
bundle exec yard server -r
```
### Releasing a new version
- Bump the version in `version.rb`
- Create the tag:
```
$ git release v1.0.x`
```
- Build the gemfile and push it to Rubygems.org:
```shell
$ bundle exec rake build release
```
- Generate the changelog (`cargo install changelog-rs && changelog-rs .`) and copy the relevant lines to [the releases page](https://github.com/ecraft/logging_library/releases).
### License
MIT