Git Product home page Git Product logo

mjolnir's Introduction

Mjolnir

Codacy Badge Codacy Badge Build Status Go Report Card

Mjolnir is Namely's common Go packages. It contains packages for things like health checks, database utils, logging, etc.

Logging

The Logger returns an interceptor that will set a *logrus.Entry on the context.

Errors

The logger makes calls to your gRPC endpoints assuming they return a protobuf response or an error.

out, err := handler(ctx, req)

When building gRPC Services, sometimes you may want return user friendly protobuf error responses, and other times you may want to return generic internal errors (e.g. when your DB write fails).

If your proto Error is set up like:

message Error {
  string key = 1;
  string message = 2;
}

Then included in this repo is the ability to customize error responses to fit both conditions. Both KeyedErr and FieldErr can be passed around like standard errors because they implement the error interface.

For example, say you have a standard Get User endpoint. In an error condition you decide to return a friendly "user not found" message if the user doesn't exist, or otherwise a generic internal server error (your client doesn't need to know about internal errors!).

Then you can build your proto error response with something like:

  var ErrUserNotFound = &KeyedErr{
      ErrorKey: "not_found",
      Message:  "user not found",
  }
  
  &proto.Error{
       Key:     ErrUserNotFound.Key(),
       Message: ErrUserNotFound.Error(),
   },

And otherwise a generic response like:

var grpcError = data.NewFieldErr(
    &logrus.Fields{
        "error":  err,
    },
)

mjolnir's People

Contributors

bobbytables avatar dthagard avatar ehudc avatar gxb5443 avatar jaeminsung avatar jcburley avatar macat avatar mdkess avatar nnarh avatar therealplato avatar xvf avatar

Stargazers

 avatar  avatar  avatar

Watchers

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

Forkers

isabella232

mjolnir's Issues

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.