gruf 2.2.2 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b0e7891457a5fc0c9540a5347060adb81d943c2f
-  data.tar.gz: b6f8e81ec7ad9fda50874fd0dfc34493dd2fabce
+SHA256:
+  metadata.gz: bffd546b0bd27dcd8cd54146065623e73e0396211ae263985a197255bb8ec48a
+  data.tar.gz: 9b0364643ab5c1008a330ed61c8fba4458f9b075c34eea81acb10de4ee70f53d
 SHA512:
-  metadata.gz: 7881d0383409066521a069f99d1a978c67c281a6142eef378e7204dcb394fd7d3e53d0a82453bc36097e611fada3daded6bc6c91a7697a7e924bcbbbef2f6a2f
-  data.tar.gz: 6748606577097d0b5bf6cec7c4afe6254b71f3abd39b40a3a3ca1dde6ac43f43cb592fe14c83e51158e1929f25cb4e442cf2b2afe00f759332fe404558fee6e5
+  metadata.gz: 3ef4637ca552b572f77b270ccdc491c660b62d7c1d8ff85fe67151cf22f09e92f18a9b88b63d31e956411cb46380ba695e0eccc74d47a2095c8fc7d6ebfaf838
+  data.tar.gz: 0f38cc6c69487f1cab2ebc5e07b5a06de20f5e35d0000ad4c80a021288557aaaef2acf58fe254be6dc292ddd2e764976acfdd65578a7a0233c663dea83018eb3

data/CHANGELOG.md

@@ -2,13 +2,108 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+### 2.9.1
+
+- Drop support for Ruby 2.4/2.5 to align with Ruby EOL schedule, supporting 2.6+ only
+- Allow for float/TimeSpec timeout values on clients
+
+### 2.9.0
+
+- Change to racially neutral terminology across library
+  - blacklist->blocklist
+  - master->main branch
+- Explicitly declare development dependencies in gemspec
+- Add script/e2e test for full e2e test in regression suite
+- Explicitly declare [json gem](https://rubygems.org/gems/json) dependency
+- Update to Rubocop 1.4, add in rubocop-rspec for spec tests
+- Add Ruby 2.7, 3.0 support
+
+### 2.8.1
+
+- Fix issue with --suppress-default-interceptors not working [#95]
+- Loosen rake development dependency to >= 10.0 [#97]
+
+### 2.8.0
+
+- Pass the controller request object into the request logging formatters [#92]  
+
+### 2.7.1
+
+- Add `channel_credentials` option to `Gruf::Client` and `default_channel_credentials` option to `Gruf::Configuration` [#85] [#87]
+
+### 2.7.0
+
+- Add hook support for executing code paths before a server is started, and after a server stops
+
+### 2.6.1
+
+- Add frozen_string_literal: true to files, update rubocop to 0.68
+  
+### 2.6.0
+
+- Drop Ruby 2.2 support
+- Abstract gruf controller's send to make it usable in filters 
+- Adjusts configuration reset into a Railtie for Rails systems to ensure proper OOE 
+- Bump rubocop to 0.64, address violations, update activesupport/concurrent-ruby dependencies to have a min version
+
+### 2.5.2
+
+- Log ok/validation responses at DEBUG levels to prevent log stampeding in high-volume environments
+
+### 2.5.1
+
+- Ensure `timeout` is an int when passed as a client option to a gRPC client
+- Add `bound_service` reader to `Gruf::Controllers::Base` for finding the service bound to the given controller
+
+### 2.5.0
+
+- Client exceptions raised now contain mapped subclasses, such as `Gruf::Client::Errors::InvalidArgument`
+- Client exceptions will also now catch StandardError and GRPC::Core errors, and handle them as Internal errors
+- Added SynchronizedClient which prevents multiple calls to the same endpoint with the same params at
+  a given time. This is useful for mitigating thundering herds. To skip this behavior for certain endpoints,
+  pass the `options[:unsynchronized_methods]` param with a list of method names (as symbols).
+
+### 2.4.2
+
+- Added error handling for GRPC::Core::CallError, a low-level error in the grpc library that does not inherit
+  from StandardError. [#59]
+- Removed `Thread.abort\_on\_exception = true`. Exceptions should be handled by gruf or the application,
+  and should not cause the server process to crash. [#59]
+- Added guard for size of trailing metadata attached to grpc call. The default max for http2 trailing metadata
+  in the gRPC C library is 8kb. If we go over that limit (either through custom metadata attached to the
+  error by the application, or via the error payload encoded by the error serializer), the gRPC library
+  will throw RESOURCE\_EXHAUSTED. Gruf now detects this case, and attempts to prevent it by logging the
+  original error and substituting it with an internal error indicating that the metadata was too large. [#60]
+- Truncate stack trace in error payload to help avoid overflowing the trailing metadata. Added backtrace\_limit
+  configuration parameter, which defaults to 10.[#60]
+
+### 2.4.1
+
+- Safer configuration of GRPC::RpcServer. From now on, use `Gruf.rpc_server_options` for the params
+  to be sent to GPRC::RpcServer. Also provide sane defaults for params for GRPC::RpcServer. [#55]
+- Added ability to monitor `RESOURCE_EXHAUSTED` and `UNIMPLEMENTED`. By setting `event_listener_proc` in
+  the Gruf configuration, you will receive a callback when these events occur. The parameter to your
+  callback will be a symbol (`:thread_pool_exhausted` or `:unimplemented`). Others may be added in the future.
+
+### 2.4.0
+
+- Added a hash of error log levels to RequestLogging interceptor, mapping error code to level of logging to use. To
+override the level of logging per error response, provide a map of codes to log level in options, key :log_levels.
+The default is :error log level.
+
+### 2.3.0
+
+- Add Gruf::Interceptors::ClientInterceptor for intercepting outbound client calls
+- Add command-line arguments to the gruf binstub
+- Add ability to specify server hostname via CLI argument
+
 ### 2.2.2
 
-- Added ignore_methods option for RequestLogging interceptor [#45]
+- Add ignore_methods option for RequestLogging interceptor [#45]
 
 ### 2.2.1
 
-- Now changes proc title once server is ready to process incoming requests [#44] 
+- Now changes proc title once server is ready to process incoming requests [#44]
 - Gruf now requires gRPC 1.10.x+ due to various fixes and improvements in the gRPC core libraries
 
 ### 2.2.0
@@ -17,13 +112,13 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### 2.1.1
 
-- Add ability to pass in client stub options into Gruf::Client 
+- Add ability to pass in client stub options into Gruf::Client
 
 ### 2.1.0
 
 - Add ability to list, clear, insert before, insert after, and remove to a server's interceptor
 registry
-- Ensure interceptors and services cannot be adjusted on the server after it starts to 
+- Ensure interceptors and services cannot be adjusted on the server after it starts to
 prevent threading issues
 - [#36], [#37] Adds `response_class`, `request_class`, and `service` accessors to controller request
 
@@ -66,11 +161,11 @@ Gruf 2.0 is a major shift from Gruf 1.0. See [UPGRADING.md](UPGRADING.md) for de
 ### 1.2.4
 
 - Loosen explicit Protobuf dependency now that 3.4.0.2 is released
-- Guard against nil params in logger blacklist
+- Guard against nil params in logger blocklist
 
 ### 1.2.3
 
-- Support nested blacklist parameters in path.to.key format
+- Support nested blocklist parameters in path.to.key format
 
 ### 1.2.2
 
@@ -86,22 +181,22 @@ Gruf 2.0 is a major shift from Gruf 1.0. See [UPGRADING.md](UPGRADING.md) for de
 - Instrumentation hooks now execute similarly to outer_around hooks; they can
   now instrument failures
 - Instrumentation hooks now pass a `RequestContext` object that contains information
-  about the incoming request, instead of relying on instance variables 
+  about the incoming request, instead of relying on instance variables
 - StatsD hook now sends success/failure metrics for endpoints
 - Add ability to turn off sending exception message on uncaught exception.
 - Add configuration to set the error message when an uncaught exception is
   handled by gruf.
-- Add a request logging hook for Rails-style request logging, with optional 
-  parameter logging, blacklists, and formatter support 
+- Add a request logging hook for Rails-style request logging, with optional
+  parameter logging, blocklists, and formatter support
 - Optimizations around Symbol casting within service calls
 
 ### 1.1.0
 
-- Add the ability for call options to the client, which enables deadline setting 
+- Add the ability for call options to the client, which enables deadline setting
 
 ### 1.0.0
 
-- Bump gRPC to 1.4 
+- Bump gRPC to 1.4
 
 ### 0.14.2
 
@@ -130,7 +225,7 @@ Gruf 2.0 is a major shift from Gruf 1.0. See [UPGRADING.md](UPGRADING.md) for de
 ### 0.12.0
 
 - Add ability to run multiple around hooks
-- Fix bug with error handling that caused error messages to repeat across streams 
+- Fix bug with error handling that caused error messages to repeat across streams
 
 ### 0.11.5
 

data/CODE_OF_CONDUCT.md

@@ -1,49 +1,46 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at splittingred@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at engineering@bigcommerce.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -1,8 +1,8 @@
 # gruf - gRPC Ruby Framework
 
-[![Build Status](https://travis-ci.org/bigcommerce/gruf.svg?branch=master)](https://travis-ci.org/bigcommerce/gruf) [![Gem Version](https://badge.fury.io/rb/gruf.svg)](https://badge.fury.io/rb/gruf) [![Documentation](https://inch-ci.org/github/bigcommerce/gruf.svg?branch=master)](https://inch-ci.org/github/bigcommerce/gruf?branch=master)
+[![CircleCI](https://circleci.com/gh/bigcommerce/gruf/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf/tree/main) [![Gem Version](https://badge.fury.io/rb/gruf.svg)](https://badge.fury.io/rb/gruf) [![Documentation](https://inch-ci.org/github/bigcommerce/gruf.svg?branch=main)](https://inch-ci.org/github/bigcommerce/gruf?branch=main)
 
-gruf is a Ruby framework that wraps the [gRPC Ruby library](https://github.com/grpc/grpc/tree/master/src/ruby) to
+gruf is a Ruby framework that wraps the [gRPC Ruby library](https://github.com/grpc/grpc/tree/main/src/ruby) to
 provide a more streamlined integration into Ruby and Ruby on Rails applications.
 
 It provides an abstracted server and client for gRPC services, along with other tools to help get gRPC services in Ruby
@@ -17,372 +17,20 @@ up fast and efficiently at scale. Some of its features include:
   still preserving gRPC BadStatus codes
 * Server and client execution timings in responses
 
-gruf currently has active support for gRPC 1.10.x+. gruf is compatible and tested with Ruby 2.2-2.5. 
-gruf is also not [Rails](https://github.com/rails/rails)-specific, and can be used in any Ruby framework 
-(such as [Grape](https://github.com/ruby-grape/grape), for instance).
+gruf currently has active support for gRPC 1.10.x+. gruf is compatible and tested with Ruby 2.2-2.7.
+gruf is also not [Rails](https://github.com/rails/rails)-specific, and can be used in any Ruby framework
+(such as [Grape](https://github.com/ruby-grape/grape) or [dry-rb](https://dry-rb.org/), for instance).
 
-## Installation
+### Getting Started
 
-```ruby
-gem 'gruf'
-```
-
-Then in an initializer or before use:
-
-```ruby
-require 'gruf'
-```
-
-Make sure to review [UPGRADING.md](https://github.com/bigcommerce/gruf/blob/master/UPGRADING.md)
-if you are upgrading gruf between minor or major versions.
-
-### Client
-
-Add an initializer:
-
-```ruby
-require 'gruf'
-
-Gruf.configure do |c|
-  c.default_client_host = 'grpc.service.com:9003'
-end
-```
-
-If you don't explicitly set `default_client_host`, you will need to pass it into the client options, like so:
-
-```ruby
-client = ::Gruf::Client.new(service: ::Demo::ThingService, options: {hostname: 'grpc.service.com:9003'})
-```
-
-From there, you can instantiate a client given a stub service (say on an SslCertificates proto with a GetSslCertificate call):
-
-```ruby
-require 'gruf'
-
-id = args[:id].to_i.presence || 1
-
-begin
-  client = ::Gruf::Client.new(service: ::Demo::ThingService)
-  response = client.call(:GetMyThing, id: id)
-  puts response.message.inspect
-rescue Gruf::Client::Error => e
-  puts e.error.inspect
-end
-```
-
-Note this returns a response object. The response object can provide `trailing_metadata` as well as a `execution_time`.
-
-### Server
-
-Add an initializer:
-
-```ruby
-require 'gruf'
-
-Gruf.configure do |c|
-  c.server_binding_url = 'grpc.service.com:9003'
-end
-```
-
-Next, setup some handlers based on your proto configurations in `/app/rpc/`. For example, for the Thing service, with a
-GetThingReq/GetThingResp call based on this proto:
-
-```proto
-syntax = "proto3";
-
-package demo;
-
-service Jobs {
-    rpc GetJob(GetJobReq) returns (GetJobResp) { }
-}
-
-message GetJobReq {
-    uint64 id = 1;
-}
-
-message GetJobResp {
-    uint64 id = 1;
-    string name = 2;
-}
-```
-
-You'd have this handler in `/app/rpc/demo/job_controller.rb`
-
-```ruby
-module Demo
-  class JobController < ::Gruf::Controllers::Base
-    bind ::Demo::Jobs::Service
-
-    ##
-    # @return [Demo::GetJobResp] The job response
-    #
-    def get_job
-      thing = Job.find(request.message.id)
-
-      Demo::GetJobResp.new(id: thing.id)
-    rescue
-      fail!(:not_found, :job_not_found, "Failed to find Job with ID: #{request.message.id}")
-    end
-  end
-end
-```
-
-Finally, you can start the server by running:
-
-```bash
-bundle exec gruf
-```
-
-### Basic Authentication
-
-Gruf comes packaged in with a Basic Authentication interceptor. It takes in an array of supported
-username and password pairs (or password-only credentials).
-
-In Server:
-
-```ruby
-Gruf.configure do |c|
-  c.interceptors.use(
-    Gruf::Interceptors::Authentication::Basic,
-    credentials: [{
-      username: 'my-username-here',
-      password: 'my-password-here',
-    },{
-      username: 'another-username',
-      password: 'another-password',
-    },{
-      password: 'a-password-only'
-    }]
-  )
-end
-```
-
-In Client:
-
-```ruby
-require 'gruf'
-
-id = args[:id].to_i.presence || 1
-
-options = {
-  username: ENV.fetch('DEMO_THING_SERVICE_USERNAME'),
-  password: ENV.fetch('DEMO_THING_SERVICE_PASSWORD')
-}
-
-begin
-  client = ::Gruf::Client.new(service: ::Demo::ThingService, options: options)
-  response = client.call(:GetMyThing, id: id)
-  puts response.message.inspect
-rescue Gruf::Client::Error => e
-  puts e.error.inspect
-end
-```
-
-Supporting an array of credentials allow for unique credentials per service, or for easy credential
-rotation with zero downtime.
-
-### SSL Configuration
-
-We don't recommend using TLS for gRPC, but instead using something like [linkerd](https://linkerd.io) for TLS
-encryption between services. If you need it, however, this library supports TLS.
-
-For the client, you'll need to point to the public certificate:
-
-```ruby
-::Gruf::Client.new(
-  service: Demo::ThingService,
-  ssl_certificate: 'x509 public certificate here',
-  # OR
-  ssl_certificate_file: '/path/to/my.crt'
-)
-```
-
-If you want to run a server you'll need both the CRT and the key file if you want to do credentialed auth:
-
-```ruby
-Gruf.configure do |c|
-  c.use_ssl = true
-  c.ssl_crt_file = "#{Rails.root}/config/ssl/#{Rails.env}.crt"
-  c.ssl_key_file = "#{Rails.root}/config/ssl/#{Rails.env}.key"
-end
-```
-
-## Server Interceptors
-
-gruf supports interceptors around the grpc server calls, allowing you to perform actions around your service
-method calls. This can be used to add tracing data, connection resets in the grpc thread pool, further
-instrumentation, and other things.
-
-Adding a hook is as simple as creating a class that extends `Gruf::Interceptor::ServerInterceptor`,
-and a `call` method that yields control to get the method result:
-
-```ruby
-class MyInterceptor < ::Gruf::Interceptors::ServerInterceptor
-  def call
-    yield
-  end
-end
-```
-
-Interceptors have access to the `request` object, which is the `Gruf::Controller::Request` object
-described above.
-
-### Failing in an Interceptor
-
-Interceptors can fail requests with the same method calls as a controller:
-
-```ruby
-class MyFailingInterceptor < ::Gruf::Interceptors::ServerInterceptor
-  def call
-    result = yield # this returns the protobuf message
-    unless result.dont_hijack
-      # we'll assume this "dont_hijack" attribute exists on the message for this example
-      fail!(:internal, :hijacked, 'Hijack all the things!')
-    end
-    result
-  end
-end
-```
-
-Similarly, you can raise `GRPC::BadStatus` calls to trigger similar errors without accompanying metadata.
-
-### Configuring Interceptors
-
-From there, the interceptor can be added to the server manually (if not executing via `bundle exec gruf`):
-
-```ruby
-server = Gruf::Server.new
-server.add_interceptor(MyInterceptor, option_foo: 'value 123')
-```
-
-Or, alternatively, the more common method of passing them into the `interceptors` configuration hash:
-
-```ruby
-Gruf.configure do |c|
-  c.interceptors.use(MyInterceptor, option_foo: 'value 123')
-end
-```
-
-Interceptors each wrap the call and are run recursively within each other. This means that if you have
-three interceptors - `Interceptor1`, `Interceptor2`, and `Interceptor3` - they will run in FIFO
-(first in, first out) order. `Interceptor1` will run, yielding to `Interceptor2`,
-which will then yield to `Interceptor3`, which will then yield to your service method call,
-ending the chain.
-
-You can utilize the `insert_before` and `insert_after` methods to maintain order:
-
-```ruby
-Gruf.configure do |c|
-  c.interceptors.use(Interceptor1)
-  c.interceptors.use(Interceptor2)
-  c.interceptors.insert_before(Interceptor2, Interceptor3) # 3 will now happen before 2
-  c.interceptors.insert_after(Interceptor1, Interceptor4) # 4 will now happen after 1
-end
-```
-
-By default, the ActiveRecord Connection Reset interceptor and Output Metadata Timing interceptor
-are loaded into gruf unless explicitly told not to via the `use_default_interceptors` configuration
-parameter.
-
-## Instrumentation
-
-gruf comes out of the box with a couple of instrumentation interceptors packed in:
-output metadata timings and StatsD support.
-
-### Output Metadata Timing
-
-Enabled by default, this will push timings for _successful responses_ through the response output
-metadata back to the client.
-
-### StatsD
-
-The StatsD support is not enabled by default. To enable it, you'll want to do:
-
-```ruby
-Gruf.configure do |c|
-  c.interceptors.use(
-    Gruf::Interceptors::Instrumentation::Statsd,
-    client: ::Statsd.new('my.statsd.host', 8125),
-    prefix: 'my_application_prefix.rpc'
-  )
-end
-```
-
-This will measure counts and timings for each endpoint.
-
-### Request Logging
-
-Gruf 1.2+ comes built with request logging out of the box; you'll get Rails-style logs with your
-gRPC calls:
-
-```
-# plain
-I, [2017-07-14T09:50:54.200506 #70571]  INFO -- : [GRPC::Ok] (thing_service.get_thing) [0.348ms]
-# logstash
-I, [2017-07-14T09:51:03.299050 #70595]  INFO -- : {"message":"[GRPC::Ok] (thing_service.get_thing) [0.372ms]","service":"thing_service","method":"thing_service.get_thing","grpc_status":"GRPC::Ok"}
- ```
-
-It supports formatters (including custom ones) that you can use to specify the formatting of the logging:
-
-```ruby
-Gruf.configure do |c|
-  c.interceptors.use(
-    Gruf::Interceptors::Instrumentation::RequestLogging::Interceptor,
-    formatter: :logstash
-  )
-end
-```
-
-It comes with a few more options as well:
-
-| Option | Description | Default |
-| ------ | ----------- | ------- |
-| formatter | The formatter to use. By default `:plain` and `:logstash` are supported. | `:logstash` |
-| log_parameters | If set to true, will log parameters in the response | `false` |
-| blacklist | An array of parameter key names to redact from logging, in path.to.key format | `[]` |
-| redacted_string | The string to use for redacted parameters. | `REDACTED` |
-| ignore_methods | An array of method names to ignore from logging. E.g. `['namespace.health.check']` | `[]` |
-
-It's important to maintain a safe blacklist should you decide to log parameters; gruf does no
-parameter sanitization on its own. We also recommend blacklisting parameters that may contain
-very large values (such as binary or json data).
-
-## Plugins
-
-You can build your own hooks and middleware for gruf; here's a list of known open source gems for
-gruf that you can use today:
-
-* [gruf-zipkin](https://github.com/bigcommerce/gruf-zipkin) - Provides a [Zipkin](https://zipkin.io)
-integration
-* [gruf-circuit-breaker](https://github.com/bigcommerce/gruf-circuit-breaker) - Circuit breaker
-support for services
-* [gruf-profiler](https://github.com/bigcommerce/gruf-profiler) - Profiles and provides memory usage
-reports for clients and services
-* [gruf-commander](https://github.com/bigcommerce/gruf-commander) - Request/command-style validation and
-execution patterns for services
+Please see the [gruf wiki](https://github.com/bigcommerce/gruf/wiki) for detailed information on getting started
+using gruf.
 
 ## Demo Rails App
 
 There is a [demonstration Rails application here](https://github.com/bigcommerce/gruf-demo) you can
 view and clone that shows how to integrate Gruf into an existing Rails application.
 
-## Roadmap
-
-### Gruf 3.0
-
-* Utilize the new core Ruby interceptors in gRPC 1.7
-* Support client interceptors
-* Change configuration to an injectable object to ensure thread safety on chained server/client interactions
-* Move all references to `Gruf.` configuration into injectable parameters
-* Redo server configuration to be fully injectable
-* Move client calls to their native method implementation
-
-## Companies Using Gruf
-
-Using gruf and want to show your support? Let us know and we'll add your name here.
-
-* [BigCommerce](https://www.bigcommerce.com/)
-
 ## License
 
 Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved

data/bin/gruf

@@ -25,15 +25,5 @@ end
 load 'config/environment.rb' if defined?(Rails)
 require 'gruf'
 
-begin
-  server = Gruf::Server.new(Gruf.server_options)
-  Gruf.services.each { |s| server.add_service(s) }
-  server.start!
-rescue => e
-  msg = "FATAL ERROR: #{e.message} #{e.backtrace.join("\n")}"
-  if Gruf.logger
-    Gruf.logger.fatal msg
-  else
-    Logger.new(STDOUT).fatal msg
-  end
-end
+cli = Gruf::Cli::Executor.new
+cli.run