Home

This is the table of contents for the manual for using gruf. Please refer to the sections below.

Server

• [Server: Installation]
• [Server: Generating Stubs]
• [Server: Creating Controllers]
• [Server: Running Gruf and Command Line Options]
• [Server: Authentication]
• [Server: Interceptors]
• [Server: Hooks]
• [Server: Instrumentation and Logging]

Client

• [Client: Installation]
• [Client: Making Your First Call]
• [Client: Interceptors]
• [Client: Synchronized Calls]

Testing

There is a gem specifically for easy testing with RSpec: gruf-rspec. Take a look at its README for more information.

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-lightstep - Provides a seamless LightStep integration
• gruf-zipkin - Provides a Zipkin integration
• gruf-newrelic - Easy New Relic integration
• gruf-commander - Request/command-style validation and execution patterns for services
• gruf-profiler - Profiles and provides memory usage reports for clients and services
• gruf-circuit-breaker - Circuit breaker support for services