goji/glogrus2

Logrus logging for Context-based Goji

Goji

Goji is a HTTP request multiplexer, similar to net/http.ServeMux. It compares incoming requests to a list of registered Patterns, and dispatches to the http.Handler that corresponds to the first matching Pattern. Goji also supports Middleware (composable shared functionality applied to every request) and uses the standard context package to store request-scoped values.

Quick Start

package main

import (
        "fmt"
        "net/http"

        "goji.io"
        "goji.io/pat"
)

func hello(w http.ResponseWriter, r *http.Request) {
        name := pat.Param(r, "name")
        fmt.Fprintf(w, "Hello, %s!", name)
}

func main() {
        mux := goji.NewMux()
        mux.HandleFunc(pat.Get("/hello/:name"), hello)

        http.ListenAndServe("localhost:8000", mux)
}

Please refer to Goji's GoDoc Documentation for a full API reference.

Stability

Goji's API was recently updated to use the new net/http and context integration, and is therefore some of its interfaces are in a state of flux. We don't expect any further changes to the API, and expect to be able to announce API stability soon. Goji is suitable for use in production.

Prior to Go 1.7, Goji promised API stability with a different API to the one that is offered today. The author broke this promise, and does not take this breach of trust lightly. While stability is obviously extremely important, the author and community have decided to follow the broader Go community in standardizing on the standard library copy of the context package.

Users of the old API can find that familiar API on the net-context branch. The author promises to maintain both the net-context branch and master for the forseeable future.

Community / Contributing

Goji maintains a mailing list, gojiberries, where you should feel welcome to ask questions about the project (no matter how simple!), to announce projects or libraries built on top of Goji, or to talk about Goji more generally. Goji's author (Carl Jackson) also loves to hear from users directly at his personal email address, which is available on his GitHub profile page.

Contributions to Goji are welcome, however please be advised that due to Goji's stability guarantees interface changes are unlikely to be accepted.

All interactions in the Goji community will be held to the high standard of the broader Go community's Code of Conduct.

glogrus2's Issues

cannot find goji.Handler

after this commit in goji goji/goji@7fb07be

this library could not find goji.Handler

this is what output from go get

# github.com/goji/glogrus2
../../goji/glogrus2/glogrus.go:36: undefined: goji.Handler
../../goji/glogrus2/glogrus.go:71: undefined: goji.Handler
../../goji/glogrus2/glogrus.go:72: undefined: goji.Handler
../../goji/glogrus2/glogrus.go:101: undefined: goji.HandlerFunc

glogrus does not implement http.Flusher even if the underlying http.ResponseWriter does

consider the following test code (mostly copied from this repo's README)

package main

import (
    "fmt"
    "log"
    "net/http"

    "goji.io/pat"

    goji "goji.io"

    "golang.org/x/net/context"

    "github.com/Sirupsen/logrus"
    glogrus "github.com/goji/glogrus2"
)

func a(ctx context.Context, w http.ResponseWriter, r *http.Request) {
    _, ok := w.(http.Flusher)
    fmt.Fprintln(w, ok)
}

func main() {
    broken := goji.NewMux()
    logr := logrus.New()
    logr.Formatter = new(logrus.JSONFormatter)
    broken.UseC(glogrus.NewGlogrus(logr, "my-app-name"))

    broken.HandleFuncC(pat.Get("/"), a)

    working := goji.NewMux()
    working.HandleFuncC(pat.Get("/"), a)

    go func() {
        http.ListenAndServe(":8081", working)
    }()
    log.Fatal(http.ListenAndServe(":8080", broken))
}

the results:

jchen@locke-(master|✔)> curl http://localhost:8081/
true
jchen@locke-(master|✔)> curl http://localhost:8080/
false

Also check out this example which seemingly proves that a struct that embeds an interface cannot be type asserted to another interface that the struct itself doesn't implement even if the embedded struct implements the second interface.

Proposal:

type assert the http.ResponseWriter in wrapWriter and use a new struct that implements http.Flusher, http.CloseNotifierand http.Hijacker if the ResponseWriter does. Similar to this perhaps?