Giter Club home page Giter Club logo

grpc-kit's Introduction

GRPC::Kit

GRPC toolkit for microservices

Installation

Add this line to your application's Gemfile:

gem 'grpc-kit'

And then execute:

$ bundle

Or install it yourself as:

$ gem install grpc-kit

Documentation

GRPC::Kit::Communication::Resilient

Sometimes, GRPC and Google::Cloud raises unavailable error, but you can retry and all works fine. Based on Datastore documentation we implemented a helper for resilient communication.

Example:

pubsub = Google::Cloud::Pubsub.new
topic  = pubsub.create_topic('topic_name')
topic.publish('message') # receives Google::Cloud::UnavailableError

# But you can uses resilient communication
include GRPC::Kit::Communication::Resilient
topic = resilient { topic.publish('message') }

# And you can sets the limit of repetition...
topic = resilient(limit: 5) { topic.publish('message') }

GRPC::Kit::Logger

By default all logs sent to GRPC.logger are ignored. But GRPC::Kit::Logger automatically configures logs to use STDOUT.

GRPC::Kit::Queue::Publisher

To publish a message to topic (creating one if none exists) you only need to configure environment variables for Google::Cloud::Pubsub and use:

GRPC::Kit::Queue::Publisher.publish('topic_name', 'message')

GRPC::Kit::Queue::Worker

Create a class in lib/workers including GRPC::Kit::Queue::Worker:

# lib/workers/my_worker.rb
class MyWorker
  include GRPC::Kit::Queue::Worker

  def initialize(msg)
    @msg = msg
  end

  def call
    puts @msg.data
    @msg.ack!
  end
end

And you can use:

# to list available workers
grpc-kit workers list
# to run a worker
grpc-kit workers runner MyWorker topic_name

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/b2beauty/grpc-kit.

License

The gem is available as open source under the terms of the MIT License.

grpc-kit's People

Contributors

tiagopog avatar vyper avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

grpc-kit's Issues

Resilient worker

Retry worker when receive...

, [2017-03-29T18:29:12.011075 #5] DEBUG -- : Failing with status #<struct Struct::Status code=14, details="{\"created\":\"@1490812152.010328204\",\"description\":\"Endpoint read failed\",\"file\":\"src/core/ext/transport/chttp2/transport/chttp2_transport.c\",\"file_line\":1851,\"grpc_status\":14,\"occurred_during_write\":0,\"referenced_errors\":[{\"created\":\"@1490812152.010323670\",\"description\":\"Secure read failed\",\"file\":\"src/core/lib/security/transport/secure_endpoint.c\",\"file_line\":166,\"referenced_errors\":[{\"created\":\"@1490812152.010316833\",\"description\":\"Socket closed\",\"fd\":15,\"file\":\"src/core/lib/iomgr/tcp_posix.c\",\"file_line\":249,\"target_address\":\"ipv4:172.217.29.106:443\"}]}]}", metadata={}>
```

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.