• Stars
    star
    138
  • Rank 264,508 (Top 6 %)
  • Language
    Erlang
  • License
    Apache License 2.0
  • Created almost 7 years ago
  • Updated 7 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Erlang grpc on chatterbox

grpcbox

Tests codecov Hex.pm Hex.pm

Library for creating grpc services (client and server) in Erlang, based on the chatterbox http2 library.

Features

  • Unary, client stream, server stream and bidirectional rpcs
  • Client load balancing
  • Interceptors
  • Health check service
  • Reflection service
  • OpenCensus interceptors for stats and tracing
  • Plugin for generating clients and behaviour type specs for service server implementation

Implementing a Service Server

The quickest way to play around is with the test service and client that is used by grpcbox. Simply pull up a shell with, rebar3 as test shell and the route guide service will start on port 8080 and you'll have the client, routeguide_route_guide_client, in the path.

The easiest way to get started on your own project is using the plugin, grpcbox_plugin:

{deps, [grpcbox]}.

{grpc, [{protos, "protos"},
        {gpb_opts, [{module_name_suffix, "_pb"}]}]}.

{plugins, [grpcbox_plugin]}.

Currently grpcbox and the plugin are a bit picky and the gpb options will always include [use_packages, maps, {i, "."}, {o, "src"}].

Assuming the protos directory of your application has the route_guide.proto found in this repo, protos/route_guide.proto, the output from running the plugin will be:

$ rebar3 grpc gen
===> Writing src/route_guide_pb.erl
===> Writing src/grpcbox_route_guide_bhvr.erl

A behaviour is used because it provides a way to generate the interface and types without being where the actual implementation is also done. This way if a change happens to the proto you can regenerate the interface without any issues with the implementation of the service, simply then update the implementation callbacks to match the changed interface.

Runtime configuration for grpcbox can be done in sys.config, specifying the compiled proto modules to use for finding the services available, which services to actually enable for requests and what module implements them, acceptor pool and http server settings. See interop/config/sys.config for a working example.

In the interop config the portion for defining services to handle requests for is:

{grpcbox, [{servers, [#{grpc_opts => #{service_protos => [test_pb],
                                       services => #{'grpc.testing.TestService' => grpc_testing_test_service}}}]},
...

test_pb is the gpb generated module that exports get_service_names/0. The results of that function are used to construct the metadata needed for handling requests. The services map gives the module to call for handling methods of a service. If a service is not defined in that map it will result in the grpc error code 12, Unimplemented.

The services will be started when the application starts assuming the services are all configured in the sys.config and it is loaded. To manually start a service use either grpcbox:start_server/1 which will start a grpcbox_service_sup supervisor under the grpcbox_services_simple_sup simple one for one supervisor, or get a child spec grpcbox:server_child_spec(ServerOpts, GrpcOpts, ListenOpts, PoolOpts, TransportOpts) to include the service supervisor in your own supervision tree.

Unary RPC

Unary RPCs receive a single request and return a single response. The RPC GetFeature takes a single Point and returns the Feature at that point:

rpc GetFeature(Point) returns (Feature) {}

The callback generated by the grpcbox_plugin will look like:

-callback get_feature(ctx:ctx(), route_guide_pb:point()) ->
    {ok, route_guide_pb:feature(), ctx:ctx(} | grpcbox_stream:grpc_error_response().

And the implementation is as simple as an Erlang function that takes the arguments Ctx, the context of this current request, and a Point map, returning a Feature map:

get_feature(Ctx, Point) ->
    Feature = #{name => find_point(Point, data()),
                location => Point},
    {ok, Feature, Ctx}.

Streaming Output

Instead of returning a single feature the server can stream a response of multiple features by defining the RPC to have a stream Feature return:

rpc ListFeatures(Rectangle) returns (stream Feature) {}

In this case the callback still receives a map argument but also a grpcbox_stream argument:

-callback list_features(route_guide_pb:rectangle(), grpcbox_stream:t()) ->
    ok | {error, term()}.

The GrpcStream variable is passed to grpcbox_stream:send/2 for returning an individual feature over the stream to the client. The stream is ended by the server when the function completes.

list_features(_Message, GrpcStream) ->
    grpcbox_stream:send(#{name => <<"Tour Eiffel">>,
                                        location => #{latitude => 3,
                                                      longitude => 5}}, GrpcStream),
    grpcbox_stream:send(#{name => <<"Louvre">>,
                          location => #{latitude => 4,
                                        longitude => 5}}, GrpcStream),
    ok.

Streaming Input

The client can also stream a sequence of messages:

rpc RecordRoute(stream Point) returns (RouteSummary) {}

In this case the callback receives a reference() instead of a direct value from the client:

-callback record_route(reference(), grpcbox_stream:t()) ->
    {ok, route_guide_pb:route_summary()} | {error, term()}.

The process the callback is running in will receive the individual messages on the stream as tuples {reference(), route_guide_pb:point()}. The end of the stream is sent as the message {reference(), eos} at which point the function can return the response:

record_route(Ref, GrpcStream) ->
    record_route(Ref, #{t_start => erlang:system_time(1),
                            acc => []}, GrpcStream).

record_route(Ref, Data=#{t_start := T0, acc := Points}, GrpcStream) ->
    receive
        {Ref, eos} ->
            {ok, #{elapsed_time => erlang:system_time(1) - T0,
                   point_count => length(Points),
                   feature_count => count_features(Points),
                   distance => distance(Points)}, GrpcStream};
        {Ref, Point} ->
            record_route(Ref, Data#{acc => [Point | Points]}, GrpcStream)
    end.

Streaming In and Out

A bidrectional streaming RPC is defined when both input and output are streams:

rpc RouteChat(stream RouteNote) returns (stream RouteNote) {}
-callback route_chat(reference(), grpcbox_stream:t()) ->
    ok | {error, term()}.

The sequence of input messages will again be sent to the callback's process as Erlang messages and any output messages are sent to the client with grpcbox_stream:

route_chat(Ref, GrpcStream) ->
    route_chat(Ref, [], GrpcStream).

route_chat(Ref, Data, GrpcStream) ->
    receive
        {Ref, eos} ->
            ok;
        {Ref, #{location := Location} = P} ->
            Messages = proplists:get_all_values(Location, Data),
            [grpcbox_stream:send(Message, GrpcStream) || Message <- Messages],
            route_chat(Ref, [{Location, P} | Data], GrpcStream)
    end.

Interceptors

Unary Interceptor

A unary interceptor can be any function that accepts a context, decoded request body, server info map and the method function:

some_unary_interceptor(Ctx, Request, ServerInfo, Fun) ->
    %% do some interception stuff
    Fun(Ctx, Request).

The interceptor is configured in the grpc_opts set in the environment or passed to the supervisor start_child function. An example from the test suite sets grpc_opts in the application environment:

#{service_protos => [route_guide_pb],
  unary_interceptor => fun(Ctx, Req, _, Method) ->
                         Method(Ctx, #{latitude => 30,
                                       longitude => 90})
                       end}
Streaming Interceptor
Middleware

There is a provided interceptor grpcbox_chain_interceptor which accepts a list of interceptors to apply in order, with the final interceptor calling the method handler. An example from the test suite adds a trailer in each interceptor to show the chain working:

#{service_protos => [route_guide_pb],
  unary_interceptor =>
    grpcbox_chain_interceptor:unary([fun ?MODULE:one/4,
                                     fun ?MODULE:two/4,
                                     fun ?MODULE:three/4])}

Tracing

The provided interceptor grpcbox_trace supports the OpenCensus wire protocol using opencensus-erlang. It will use the trace_id, span_id and any options or tags from the trace context.

Configure as an interceptor:

#{service_protos => [route_guide_pb],
  unary_interceptor => {grpcbox_trace, unary}}

Or as a middleware in the chain interceptor:

#{service_protos => [route_guide_pb],
  unary_interceptor =>
    grpcbox_chain_interceptor:unary([..., 
                                     fun grpcbox_trace:unary/4, 
                                     ...])}

See opencensus-erlang for details on configuring reporters.

Statistics

Statistics are collected by implementing a stats handler module. A handler for OpenCensus stats (be sure to include OpenCensus as a dependency and make sure it starts on boot) is provided and can be enabled for the server with a config option:

{grpcbox, [{servers, [#{grpc_opts => #{stats_handler => grpcbox_oc_stats_handler
                                       ...}}]}]}

For the client the stats handler is a per-channel configuration, see the Defining Channels section below.

You can verify it is working by enabling the stdout exporter:

 {opencensus, [{stat, [{exporters, [{oc_stat_exporter_stdout, []}]}]}]}

For actual use, an exporter for Prometheus is available.

Details on all the metrics that are collected can be found in the OpenCensus gRPC Stats specification.

Metadata

Metadata is sent in headers and trailers.

Using a Service Client

For each service in the protos passed to rebar3 gprc gen it will generate a <service>_client module containing a function for each method in the service.

Defining Channels

Channels maintain connections to grpc servers and offer client side load balancing between servers with various methods, round robin, random, hash.

If no channel is specified in the options to a rpc call the default_channel is used. Setting the default to connect to localhost on port 8080 in your sys.config would look like:

{client, #{channels => [{default_channel, [{http, "localhost", 8080, []}], #{}}]}}

The empty map at the end can contain configuration for the load balancing algorithm, interceptors, statistics handling and compression:

#{balancer => round_robin | random | hash | direct | claim,
  encoding => identity | gzip | deflate | snappy | atom(),
  stats_handler => grpcbox_oc_stats_handler,
  unary_interceptor => term(),
  stream_interceptor => term()} 

The default balancer is round robin and encoding is identity (no compression). Encoding can also be passed in the options map to individual requests.

Calling Unary Client RPC

The RouteGuide service has a single unary method, GetFeature, in the client we have a function get_feature/2:

Point = #{latitude => 409146138, longitude => -746188906},
{ok, Feature, HeadersAndTrailers} = routeguide_route_guide_client:get_feature(Point).

Client Streaming RPC

{ok, S} = routeguide_route_guide_client:record_route(),
ok = grpcbox_client:send(S, #{latitude => 409146138, longitude => -746188906}),
ok = grpcbox_client:send(S, #{latitude => 234818903, longitude => -823423910}),
ok = grpcbox_client:close_send(S),
{ok, #{point_count := 2} = grpcbox_client:recv_data(S)).

Client with Server Streaming RPC

Rectangle = #{hi => #{latitude => 1, longitude => 2},
              lo => #{latitude => 3, longitude => 5}},
{ok, S} = routeguide_route_guide_client:list_features(Rectangle),
{ok, #{<<":status">> := <<"200">>}} = grpcbox_client:recv_headers(S),
{ok, #{name := _} = grpcbox_client:recv_data(S),
{ok, #{name := _}} = grpcbox_client:recv_data(S),
{ok, _} = grpcbox_client:recv_trailers(S).

Bidirectional RPC

{ok, S} = routeguide_route_guide_client:route_chat(),
ok = grpcbox_client:send(S, #{location => #{latitude => 1, longitude => 1}, message => <<"hello there">>}),
ok = grpcbox_client:send(S, #{location => #{latitude => 1, longitude => 1}, message => <<"hello there">>}),
{ok, #{message := <<"hello there">>}} = grpcbox_client:recv_data(S)),
ok = grpcbox_client:send(S, #{location => #{latitude => 1, longitude => 1}, message => <<"hello there">>}),
{ok, #{message := <<"hello there">>}}, grpcbox_client:close_and_recv(S)).

Context

Client calls optionally accept a context as the first argument. Contexts are used to set and propagate deadlines and OpenCensus tags.

Ctx = ctx:with_deadline_after(300, seconds),
Point = #{latitude => 409146138, longitude => -746188906},
{ok, Feature, HeadersAndTrailers} = routeguide_route_guide_client:get_feature(Ctx, Point).

CT Tests

To run the Common Test suite:

$ rebar3 ct

Interop Tests

The interop rebar3 profile builds with an implementation of the test.proto for grpc interop testing:

For testing grpcbox's server:

$ rebar3 as interop shell

With the shell running the tests can then be run from a script:

$ interop/run_server_tests.sh

The script by default uses the Go test client that can be installed with the following:

$ go get -u github.com/grpc/grpc-go/interop
$ go build -o $GOPATH/bin/go-grpc-interop-client github.com/grpc/grpc-go/interop/client

For testing the grpcbox client you can use the Go test server. But first, add _ "google.golang.org/grpc/encoding/gzip" to server.go imports or else the gzip tests will fail. Then simply build and run it:

$ go build -o $GOPATH/bin/go-grpc-interop-server github.com/grpc/grpc-go/interop/server
$ $GOPATH/bin/go-grpc-interop-server -port 8080

And run the interop client test suite:

rebar3 as interop ct

More Repositories

1

epmdless

Distributed Erlang without the EPMD
Erlang
174
star
2

erlastic_search

An Erlang app for communicating with Elastic Search's rest interface.
Erlang
162
star
3

kuberl

Erlang Kubernetes client
Erlang
53
star
4

erl_tidy

Automatically format Erlang code.
Erlang
46
star
5

epubnub

Erlang PubNub API
Erlang
28
star
6

OpaDo

Opa port of the TodoMVC app
Opa
23
star
7

rebar3_run

Run a release with one simple command
Makefile
23
star
8

augle

Auth + Google = Augle
Erlang
22
star
9

grafana-operator

Grafana Operator creates and manages Grafana deployments on Kubernetes.
Go
18
star
10

eCloudEdit

A port of CloudEdit to use Webmachine instead of Rails
JavaScript
16
star
11

sctp_dist

Erlang
16
star
12

epmdlessless

Erlang
15
star
13

ramler

Erlang generators for RAML
Erlang
14
star
14

erlup

Erlang toolchain installer
Rust
14
star
15

pg_types

Erlang library for encoding and decoding postgres data types
Erlang
13
star
16

eindexer

Simple search engine written in Erlang
Erlang
12
star
17

throttle

Library for checking if a process is overloaded
Erlang
11
star
18

rebar3_erlydtl_plugin

Rebar3 Erlydtl Plugin
Erlang
11
star
19

rebar3.org

Rebar3.org
CSS
10
star
20

ctx

Erlang context library
Erlang
10
star
21

vanguard

Discover Cadre in the Vanguard
Erlang
10
star
22

dynamo_heroku_demo

Sample Heroku app for Elixir web framework Dynamo
Elixir
10
star
23

providers

Providers provide.
Erlang
10
star
24

jsonlog

A custom formatter for the Erlang logger that converts logs to json
Erlang
10
star
25

beerenthusiasts

Beer Enthusiasts is the easiest way to share, discuss and discover new recipes for homebrewing beer. Built using Erlang, Yaws, Nitrogen and CouchDB.
JavaScript
10
star
26

grpcbox_plugin

Rebar3 plugin for generating grpcbox behaviours
Erlang
9
star
27

erls

Build and manage multiple Erlang versions
Rust
9
star
28

egit_sshd

SSH dameon for hosting git repos
Erlang
7
star
29

docker_compose_cth

Erlang Common Test Hook for starting docker-compose services before running test suites
Erlang
7
star
30

heroku_weber_example

Weber example for Heroku
Elixir
7
star
31

rebar_docker

rebar3 plugin for generating docker images
Erlang
7
star
32

elna

Erlang HTTP 1.1 and 2 server using Elli and Chatterbox
Erlang
6
star
33

heroku-buildpack-opa

Opa buildpack for Heroku
Shell
6
star
34

otel_getting_started

Erlang
6
star
35

mirrormaster

Hex mirror and private repo
Erlang
6
star
36

kakapo

riak_core based router
Erlang
6
star
37

wts

Warping the Timestamps
Erlang
6
star
38

erlangdc2013

Erlang on Heroku Workshop ErlangDC 2013
Erlang
5
star
39

rebar3_tests

Rebar3 ShellTestRunner tests
Erlang
5
star
40

chatterbox_tiles

Erlang
5
star
41

mmmbot

Erlang Irc bot
Erlang
5
star
42

epubnub_chat

And example for using epubnub to talk to the example chat app on http://www.pubnub.com/blog/build-real-time-web-apps-easy
Erlang
5
star
43

rebar_alias

Rebar3 plugin for defining aliases
Erlang
5
star
44

elli_chatterbox

Combine Elli and Chatterbox into one http monster
Erlang
4
star
45

cs542-prims-algorithm

CS542 Project: Implementation of Prim's Algorithm
Erlang
4
star
46

dwight

Hermes' son
Erlang
4
star
47

webmachine_examples

Webmachine Examples
Erlang
4
star
48

rebar_publish

Publish apps
Erlang
4
star
49

postgres_pool_example

Erlang Postgres Connection Pool Example
Erlang
4
star
50

cowboy_template

Cowboy app template
Erlang
4
star
51

erlchestrate

Erlang client for orchestrate.io
Erlang
4
star
52

rebar3_elixirc

Erlang
4
star
53

logfmt-erlang

Logfmt log parsing for Erlang
Erlang
4
star
54

odoric

Odoric
Erlang
3
star
55

elli_template

Elli template for Rebar3
Erlang
3
star
56

opa_pubnub_plugin

Opa plugin for client side interaction with PubNub
JavaScript
3
star
57

rebar3_ex_compiler

Example rebar3 compile provider
Erlang
3
star
58

ceug_4_2012

Chicago Erlang User Group April, 2012 Presentation on Cowboy and Batman.js
3
star
59

CEUG

Chicago Erlang User Group Demos
JavaScript
3
star
60

session_8

ErlangCamp Session 8
Erlang
3
star
61

riak_pb_msgcodegen

Erlang
3
star
62

roll_dice

Dice rolling OpenTelemetry Erlang example
Erlang
2
star
63

erlanger_evolution

The evolution of an erlang programmer. From non-OTP to OTP.
Erlang
2
star
64

rebar3_orb

Orb for building and testing rebar3 projects in CircleCI
2
star
65

lambda_jam_2013

Lambda Jam 2013 Presentation
Ruby
2
star
66

erl_new

Script for Erlang templates
Shell
2
star
67

ember_template

Erlang Ember App Template
JavaScript
1
star
68

lambda_jam_2013_maze

Maze
Erlang
1
star
69

heroku-buildpack-erlang-dialyzer

Run Dialyzer on your project and host the results
Shell
1
star
70

seresye.agner

Seresye package
1
star
71

gen_leader_zk

Erlang
1
star
72

eMmmbot

New mmmbot web interface and backend
JavaScript
1
star
73

county

Sheriff patrols the County
Erlang
1
star
74

reports

JavaScript
1
star
75

erlangdc2013_workshop

Workshop for ErlangDC2013
Ruby
1
star
76

orchestrate-erlang-client

A super simple (more planned) Erlang client to query the Orchestrate.io service.
Erlang
1
star
77

elenchus

JavaScript
1
star
78

dep_tracking

Dependency tracking example for rebar3
Erlang
1
star
79

mashape-erlang-client-library

Mashape Erlang client library
Erlang
1
star
80

jqheroku

Webapp to fetch json from a url and run a jsonpath against it
Erlang
1
star
81

erlware_commons.agner

Erlware Commons agner package
1
star
82

beamup

Install and control active BEAM languages
Rust
1
star