Skip to content

Commit

Permalink
Version bump, documentation updates, changelog [ci-skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
dwbutler committed Jan 11, 2018
1 parent f78d9a2 commit 28d4988
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 6 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
## Master
## 0.26.0

- Allow user configuration of the logger class. [#129](https://github.com/dwbutler/logstash-logger/pull/129)
- Fix: Allow type to be a string for multi_logger and syslog. [#131](https://github.com/dwbutler/logstash-logger/pull/131)
- Fix: Cancelled events are being logged. [#133](https://github.com/dwbutler/logstash-logger/issues/133)
- Fix: Expose method to reset logger state. [#138](https://github.com/dwbutler/logstash-logger/pull/138)
- Use specific AWS SDK gems. [#136](https://github.com/dwbutler/logstash-logger/pull/136)
- Adds support for using the default AWS credential provider chain. [#141](https://github.com/dwbutler/logstash-logger/pull/141)

## 0.25.1

Expand Down
41 changes: 37 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -568,10 +568,10 @@ config.logstash.backoff = 1

Add the aws-sdk gem to your Gemfile:

# aws-sdk < 3.0
# aws-sdk >= 3.0
gem 'aws-sdk-kinesis'

# aws-sdk >= 3.0
# aws-sdk < 3.0
gem 'aws-sdk'

```ruby
Expand All @@ -596,10 +596,10 @@ config.logstash.aws_secret_access_key = 'ASKASKHLD1234123412341234'

Add the aws-sdk gem to your Gemfile:

# aws-sdk < 3.0
# aws-sdk >= 3.0
gem 'aws-sdk-firehose'

# aws-sdk >= 3.0
# aws-sdk < 3.0
gem 'aws-sdk'

```ruby
Expand Down Expand Up @@ -710,6 +710,36 @@ def track_load_balancer_session_id
end
```

## Cleaning up resources when forking

If your application forks (as is common with many web servers) you will need to
manage cleaning up resources on your LogStashLogger instances. The instance method
`#reset` is available for this purpose. Here is sample configuration for
several common web servers used with Rails:

Passenger:
```ruby
::PhusionPassenger.on_event(:starting_worker_process) do |forked|
Rails.logger.reset
end
```

Puma:
```ruby
# In config/puma.rb
on_worker_boot do
Rails.logger.reset
end
```

Unicorn
```ruby
# In config/unicorn.rb
after_fork do |server, worker|
Rails.logger.reset
end
```

## Ruby Compatibility

Verified to work with:
Expand Down Expand Up @@ -837,6 +867,9 @@ logger = LogStashLogger.new('localhost', 5228, :tcp)
* [Sergey Pyankov](https://github.com/esergion)
* [Alec Hoey](https://github.com/alechoey)
* [Alexey Krasnoperov](https://github.com/AlexeyKrasnoperov)
* [Gabriel de Oliveira](https://github.com/gdeoliveira)
* [Vladislav Syabruk](https://github.com/SeTeM)
* [Matus Vacula](https://github.com/matus-vacula)

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion lib/logstash-logger/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module LogStashLogger
VERSION = "0.25.1"
VERSION = "0.26.0"
end

1 comment on commit 28d4988

@syabruk
Copy link
Contributor

@syabruk syabruk commented on 28d4988 Jan 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dwbutler, thanks for fixing the typo from #136

Please sign in to comment.