From 91dd3b19f69bfbeefb22c66f75ea3321f2f97bb8 Mon Sep 17 00:00:00 2001 From: Christine Dodrill Date: Wed, 13 Dec 2017 10:43:58 -0800 Subject: convert to go buildpack --- vendor/github.com/Xe/gopreload/.gitignore | 1 + vendor/github.com/Xe/gopreload/LICENSE | 19 ++ vendor/github.com/Xe/gopreload/README.md | 51 +++ .../github.com/Xe/gopreload/cmd/pluginizer/main.go | 56 ++++ .../github.com/Xe/gopreload/database/mysql/main.go | 5 + .../Xe/gopreload/database/postgres/main.go | 5 + .../Xe/gopreload/database/sqlite3/main.go | 5 + vendor/github.com/Xe/gopreload/manhole/README.md | 56 ++++ vendor/github.com/Xe/gopreload/manhole/server.go | 22 ++ vendor/github.com/Xe/gopreload/sample/main.go | 55 ++++ .../Xe/gopreload/sample/runtimeStatLogs/main.go | 36 ++ vendor/github.com/Xe/jsonfeed/.travis.yml | 17 + vendor/github.com/Xe/jsonfeed/LICENSE | 363 +++++++++++++++++++++ vendor/github.com/Xe/jsonfeed/README.md | 8 + vendor/github.com/Xe/jsonfeed/jsonfeed.go | 237 ++------------ vendor/github.com/Xe/jsonfeed/jsonfeed_test.go | 43 +++ vendor/github.com/Xe/jsonfeed/testdata/feed.json | 21 ++ vendor/github.com/Xe/ln/LICENSE | 25 ++ vendor/github.com/Xe/ln/README.md | 29 ++ vendor/github.com/Xe/ln/action.go | 11 + vendor/github.com/Xe/ln/context.go | 38 +++ vendor/github.com/Xe/ln/doc.go | 25 ++ vendor/github.com/Xe/ln/ex/doc.go | 7 + vendor/github.com/Xe/ln/ex/gotrace.go | 68 ++++ vendor/github.com/Xe/ln/ex/http.go | 36 ++ vendor/github.com/Xe/ln/ex/l2met.go | 25 ++ vendor/github.com/Xe/ln/example/http.go | 51 +++ vendor/github.com/Xe/ln/filter.go | 15 +- vendor/github.com/Xe/ln/formatter.go | 5 +- vendor/github.com/Xe/ln/logger.go | 95 ++++-- vendor/github.com/Xe/ln/logger_test.go | 111 +++++++ 31 files changed, 1301 insertions(+), 240 deletions(-) create mode 100644 vendor/github.com/Xe/gopreload/.gitignore create mode 100644 vendor/github.com/Xe/gopreload/LICENSE create mode 100644 vendor/github.com/Xe/gopreload/README.md create mode 100644 vendor/github.com/Xe/gopreload/cmd/pluginizer/main.go create mode 100644 vendor/github.com/Xe/gopreload/database/mysql/main.go create mode 100644 vendor/github.com/Xe/gopreload/database/postgres/main.go create mode 100644 vendor/github.com/Xe/gopreload/database/sqlite3/main.go create mode 100644 vendor/github.com/Xe/gopreload/manhole/README.md create mode 100644 vendor/github.com/Xe/gopreload/manhole/server.go create mode 100644 vendor/github.com/Xe/gopreload/sample/main.go create mode 100644 vendor/github.com/Xe/gopreload/sample/runtimeStatLogs/main.go create mode 100644 vendor/github.com/Xe/jsonfeed/.travis.yml create mode 100644 vendor/github.com/Xe/jsonfeed/LICENSE create mode 100644 vendor/github.com/Xe/jsonfeed/README.md create mode 100644 vendor/github.com/Xe/jsonfeed/jsonfeed_test.go create mode 100644 vendor/github.com/Xe/jsonfeed/testdata/feed.json create mode 100644 vendor/github.com/Xe/ln/LICENSE create mode 100644 vendor/github.com/Xe/ln/README.md create mode 100644 vendor/github.com/Xe/ln/action.go create mode 100644 vendor/github.com/Xe/ln/context.go create mode 100644 vendor/github.com/Xe/ln/doc.go create mode 100644 vendor/github.com/Xe/ln/ex/doc.go create mode 100644 vendor/github.com/Xe/ln/ex/gotrace.go create mode 100644 vendor/github.com/Xe/ln/ex/http.go create mode 100644 vendor/github.com/Xe/ln/ex/l2met.go create mode 100644 vendor/github.com/Xe/ln/example/http.go create mode 100644 vendor/github.com/Xe/ln/logger_test.go (limited to 'vendor/github.com/Xe') diff --git a/vendor/github.com/Xe/gopreload/.gitignore b/vendor/github.com/Xe/gopreload/.gitignore new file mode 100644 index 0000000..140f8cf --- /dev/null +++ b/vendor/github.com/Xe/gopreload/.gitignore @@ -0,0 +1 @@ +*.so diff --git a/vendor/github.com/Xe/gopreload/LICENSE b/vendor/github.com/Xe/gopreload/LICENSE new file mode 100644 index 0000000..82248fe --- /dev/null +++ b/vendor/github.com/Xe/gopreload/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2017 Christine Dodrill + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/vendor/github.com/Xe/gopreload/README.md b/vendor/github.com/Xe/gopreload/README.md new file mode 100644 index 0000000..32a3e5d --- /dev/null +++ b/vendor/github.com/Xe/gopreload/README.md @@ -0,0 +1,51 @@ +gopreload +========= + +An emulation of the linux libc `LD_PRELOAD` except for use with Go plugins for +the addition of instrumentation and debugging utilities. + +## Pluginizer + +`pluginizer` is a bit of glue that makes it easier to turn underscore imports +into plugins: + +```console +$ go get github.com/Xe/gopreload/cmd/pluginizer +$ pluginizer -help +Usage of pluginizer: + -dest string + destination package to generate + -pkg string + package to underscore import +$ pluginizer -pkg github.com/lib/pq -dest github.com/Xe/gopreload/database/postgres +To build this plugin: + $ go build -buildmode plugin -o /path/to/output.so github.com/Xe/gopreload/database/postgres +``` + +### Database drivers + +I have included plugin boilerplate autogenned versions of the sqlite, postgres +and mysql database drivers. + +## Manhole + +[`manhole`][manhole] is an example of debugging and introspection tooling that has +been useful when debugging past issues with long-running server processes. + +## Security Implications + +This package assumes that programs run using it are never started with environment +variables that are set by unauthenticated users. Any errors in loading the plugins +will be logged using the standard library logger `log` and ignored. + +This has about the same security implications as [`LD_PRELOAD`][ld-preload] does in most +Linux distributions, but the risk is minimal compared to the massive benefit for +being able to have arbitrary background services all be able to be dug into using +the same tooling or being able to have metric submission be completely separated +from the backend metric creation. Common logging setup processes can be _always_ +loaded, making the default logger settings into the correct settings. + +--- + +[manhole]: https://github.com/Xe/gopreload/tree/master/manhole +[ld-preload]: https://rafalcieslak.wordpress.com/2013/04/02/dynamic-linker-tricks-using-ld_preload-to-cheat-inject-features-and-investigate-programs/ diff --git a/vendor/github.com/Xe/gopreload/cmd/pluginizer/main.go b/vendor/github.com/Xe/gopreload/cmd/pluginizer/main.go new file mode 100644 index 0000000..67195a8 --- /dev/null +++ b/vendor/github.com/Xe/gopreload/cmd/pluginizer/main.go @@ -0,0 +1,56 @@ +package main + +import ( + "flag" + "fmt" + "log" + "os" + "path/filepath" + + _ "github.com/Xe/gopreload" +) + +var ( + pkgName = flag.String("pkg", "", "package to underscore import") + destPkgName = flag.String("dest", "", "destination package to generate") +) + +const codeTemplate = `//+build go1.8 + +package main + +import _ "$PACKAGE_PATH"` + +func main() { + flag.Parse() + + if *pkgName == "" || *destPkgName == "" { + log.Fatal("must set -pkg and -dest") + } + + srcDir := filepath.Join(os.Getenv("GOPATH"), "src", *destPkgName) + + err := os.MkdirAll(srcDir, os.ModePerm) + if err != nil { + log.Fatal(err) + } + + fout, err := os.Create(srcDir + "/main.go") + if err != nil { + log.Fatal(err) + } + defer fout.Close() + + codeBody := os.Expand(codeTemplate, func(s string) string { + if s == "PACKAGE_PATH" { + return *pkgName + } + + return "no idea man" + }) + + fmt.Fprintln(fout, codeBody) + + fmt.Println("To build this plugin: ") + fmt.Println(" $ go build -buildmode plugin -o /path/to/output.so " + *destPkgName) +} diff --git a/vendor/github.com/Xe/gopreload/database/mysql/main.go b/vendor/github.com/Xe/gopreload/database/mysql/main.go new file mode 100644 index 0000000..49042a9 --- /dev/null +++ b/vendor/github.com/Xe/gopreload/database/mysql/main.go @@ -0,0 +1,5 @@ +//+build go1.8 + +package main + +import _ "github.com/go-sql-driver/mysql" diff --git a/vendor/github.com/Xe/gopreload/database/postgres/main.go b/vendor/github.com/Xe/gopreload/database/postgres/main.go new file mode 100644 index 0000000..41efb5b --- /dev/null +++ b/vendor/github.com/Xe/gopreload/database/postgres/main.go @@ -0,0 +1,5 @@ +//+build go1.8 + +package main + +import _ "github.com/lib/pq" diff --git a/vendor/github.com/Xe/gopreload/database/sqlite3/main.go b/vendor/github.com/Xe/gopreload/database/sqlite3/main.go new file mode 100644 index 0000000..7478b61 --- /dev/null +++ b/vendor/github.com/Xe/gopreload/database/sqlite3/main.go @@ -0,0 +1,5 @@ +//+build go1.8 + +package main + +import _ "github.com/mattn/go-sqlite3" diff --git a/vendor/github.com/Xe/gopreload/manhole/README.md b/vendor/github.com/Xe/gopreload/manhole/README.md new file mode 100644 index 0000000..4540449 --- /dev/null +++ b/vendor/github.com/Xe/gopreload/manhole/README.md @@ -0,0 +1,56 @@ +# manhole + +An opinionated HTTP manhole into Go processes. + +## Assumptions This Package Makes + +- Make each server instance have a unique HTTP port that is randomized by default. + This makes it very hard to accidentally route this manhole to the outside world. + If more assurance is required I personally suggest using [yubikey totp][yktotp], + but do research. +- Application code does not touch [`http.DefaultServeMux`][default-servemux]'. This is so that + administative control rods can be dynamically flipped in the case they are + needed. +- [pprof][pprof] endpoints added to `http.DefaultServeMux`. This allows easy + access to [pprof runtime tracing][pprof-tracing] to debug issues on long-running + applications like HTTP services. +- Make the manhole slightly inconvenient to put into place in production. This + helps make sure that this tool remains a debugging tool and not a part of a + long-term production rollout. + +## Usage + +Compile this as a plugin: + +```console +$ go get -d github.com/Xe/gopreload/manhole +$ go build -buildmode plugin -o manhole.so github.com/Xe/gopreload/manhole +``` + +Then add [`gopreload`][gopreload] to your application: + +```go +// gopreload.go +package main + +/* + This file is separate to make it very easy to both add into an application, but + also very easy to remove. +*/ + +import _ "github.com/Xe/gopreload" +``` + +And at runtime add the `manhole.so` file you created earlier to the target system +somehow and add the following environment variable to its run configuration: + +```sh +GO_PRELOAD=/path/to/manhole.so +``` + +--- + +[pprof]: https://godoc.org/net/http/pprof +[default-servemux]: https://godoc.org/net/http#pkg-variables +[yktotp]: https://github.com/GeertJohan/yubigo +[gopreload]: https://github.com/Xe/gopreload diff --git a/vendor/github.com/Xe/gopreload/manhole/server.go b/vendor/github.com/Xe/gopreload/manhole/server.go new file mode 100644 index 0000000..1d542bc --- /dev/null +++ b/vendor/github.com/Xe/gopreload/manhole/server.go @@ -0,0 +1,22 @@ +package main + +import ( + "log" + "net" + "net/http" + _ "net/http/pprof" + "net/rpc" +) + +func init() { + l, err := net.Listen("tcp", "127.0.0.2:0") + if err != nil { + log.Printf("manhole: cannot bind to 127.0.0.2:0: %v", err) + return + } + + log.Printf("manhole: Now listening on http://%s", l.Addr()) + + rpc.HandleHTTP() + go http.Serve(l, nil) +} diff --git a/vendor/github.com/Xe/gopreload/sample/main.go b/vendor/github.com/Xe/gopreload/sample/main.go new file mode 100644 index 0000000..b36bef2 --- /dev/null +++ b/vendor/github.com/Xe/gopreload/sample/main.go @@ -0,0 +1,55 @@ +package main + +import ( + "fmt" + "math/rand" + "net/http" + "runtime" + "time" + + _ "github.com/Xe/gopreload" + "github.com/Xe/ln" +) + +func main() { + http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { + spew() + + ln.Log(ln.F{"action": "gc_spew", "who": r.RemoteAddr}) + + fmt.Fprintln(w, "done") + }) + + http.ListenAndServe(":9184", nil) +} + +func makeBuffer() []byte { + return make([]byte, rand.Intn(5000000)+5000000) +} + +func spew() { + pool := make([][]byte, 20) + + var m runtime.MemStats + makes := 0 + for _ = range make([]struct{}, 50) { + b := makeBuffer() + makes += 1 + i := rand.Intn(len(pool)) + pool[i] = b + + time.Sleep(time.Millisecond * 250) + + bytes := 0 + + for i := 0; i < len(pool); i++ { + if pool[i] != nil { + bytes += len(pool[i]) + } + } + + runtime.ReadMemStats(&m) + fmt.Printf("%d,%d,%d,%d,%d,%d\n", m.HeapSys, bytes, m.HeapAlloc, + m.HeapIdle, m.HeapReleased, makes) + } +} diff --git a/vendor/github.com/Xe/gopreload/sample/runtimeStatLogs/main.go b/vendor/github.com/Xe/gopreload/sample/runtimeStatLogs/main.go new file mode 100644 index 0000000..ac530e0 --- /dev/null +++ b/vendor/github.com/Xe/gopreload/sample/runtimeStatLogs/main.go @@ -0,0 +1,36 @@ +package main + +import ( + "runtime" + "time" + + "github.com/Xe/ln" +) + +func init() { + ln.Log(ln.F{ + "action": "started_up", + "every": "20_seconds", + "what": "gc_metrics", + }) + + go func() { + for { + time.Sleep(20 * time.Second) + gatherMetrics() + } + }() +} + +func gatherMetrics() { + stats := &runtime.MemStats{} + runtime.ReadMemStats(stats) + + ln.Log(ln.F{ + "gc-collections": stats.NumGC, + "gc-stw-pause-total": stats.PauseTotalNs, + "live-object-count": stats.Mallocs - stats.Frees, + "heap-bytes": stats.Alloc, + "stack-bytes": stats.StackInuse, + }) +} diff --git a/vendor/github.com/Xe/jsonfeed/.travis.yml b/vendor/github.com/Xe/jsonfeed/.travis.yml new file mode 100644 index 0000000..e872c60 --- /dev/null +++ b/vendor/github.com/Xe/jsonfeed/.travis.yml @@ -0,0 +1,17 @@ +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/ + +language: go + +go: + - 1.8.1 + +before_install: + - go get -t -v ./... + +script: + - go test -race -coverprofile=coverage.txt -covermode=atomic + +after_success: + - bash <(curl -s https://codecov.io/bash) diff --git a/vendor/github.com/Xe/jsonfeed/LICENSE b/vendor/github.com/Xe/jsonfeed/LICENSE new file mode 100644 index 0000000..e87a115 --- /dev/null +++ b/vendor/github.com/Xe/jsonfeed/LICENSE @@ -0,0 +1,363 @@ +Mozilla Public License, version 2.0 + +1. Definitions + +1.1. "Contributor" + + means each individual or legal entity that creates, contributes to the + creation of, or owns Covered Software. + +1.2. "Contributor Version" + + means the combination of the Contributions of others (if any) used by a + Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + + means Source Code Form to which the initial Contributor has attached the + notice in Exhibit A, the Executable Form of such Source Code Form, and + Modifications of such Source Code Form, in each case including portions + thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + a. that the initial Contributor has attached the notice described in + Exhibit B to the Covered Software; or + + b. that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the terms of + a Secondary License. + +1.6. "Executable Form" + + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + + means a work that combines Covered Software with other material, in a + separate file or files, that is not Covered Software. + +1.8. "License" + + means this document. + +1.9. "Licensable" + + means having the right to grant, to the maximum extent possible, whether + at the time of the initial grant or subsequently, any and all of the + rights conveyed by this License. + +1.10. "Modifications" + + means any of the following: + + a. any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered Software; or + + b. any new file in Source Code Form that contains any Covered Software. + +1.11. "Patent Claims" of a Contributor + + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the License, + by the making, using, selling, offering for sale, having made, import, + or transfer of either its Contributions or its Contributor Version. + +1.12. "Secondary License" + + means either the GNU General Public License, Version 2.0, the GNU Lesser + General Public License, Version 2.1, the GNU Affero General Public + License, Version 3.0, or any later versions of those licenses. + +1.13. "Source Code Form" + + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that controls, is + controlled by, or is under common control with You. For purposes of this + definition, "control" means (a) the power, direct or indirect, to cause + the direction or management of such entity, whether by contract or + otherwise, or (b) ownership of more than fifty percent (50%) of the + outstanding shares or beneficial ownership of such entity. + + +2. License Grants and Conditions + +2.1. Grants + + Each Contributor hereby grants You a world-wide, royalty-free, + non-exclusive license: + + a. under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + + b. under Patent Claims of such Contributor to make, use, sell, offer for + sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + + The licenses granted in Section 2.1 with respect to any Contribution + become effective for each Contribution on the date the Contributor first + distributes such Contribution. + +2.3. Limitations on Grant Scope + + The licenses granted in this Section 2 are the only rights granted under + this License. No additional rights or licenses will be implied from the + distribution or licensing of Covered Software under this License. + Notwithstanding Section 2.1(b) above, no patent license is granted by a + Contributor: + + a. for any code that a Contributor has removed from Covered Software; or + + b. for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + + c. under Patent Claims infringed by Covered Software in the absence of + its Contributions. + + This License does not grant any rights in the trademarks, service marks, + or logos of any Contributor (except as may be necessary to comply with + the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + + No Contributor makes additional grants as a result of Your choice to + distribute the Covered Software under a subsequent version of this + License (see Section 10.2) or under the terms of a Secondary License (if + permitted under the terms of Section 3.3). + +2.5. Representation + + Each Contributor represents that the Contributor believes its + Contributions are its original creation(s) or it has sufficient rights to + grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + + This License is not intended to limit any rights You have under + applicable copyright doctrines of fair use, fair dealing, or other + equivalents. + +2.7. Conditions + + Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in + Section 2.1. + + +3. Responsibilities + +3.1. Distribution of Source Form + + All distribution of Covered Software in Source Code Form, including any + Modifications that You create or to which You contribute, must be under + the terms of this License. You must inform recipients that the Source + Code Form of the Covered Software is governed by the terms of this + License, and how they can obtain a copy of this License. You may not + attempt to alter or restrict the recipients' rights in the Source Code + Form. + +3.2. Distribution of Executable Form + + If You distribute Covered Software in Executable Form then: + + a. such Covered Software must also be made available in Source Code Form, + as described in Section 3.1, and You must inform recipients of the + Executable Form how they can obtain a copy of such Source Code Form by + reasonable means in a timely manner, at a charge no more than the cost + of distribution to the recipient; and + + b. You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter the + recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + + You may create and distribute a Larger Work under terms of Your choice, + provided that You also comply with the requirements of this License for + the Covered Software. If the Larger Work is a combination of Covered + Software with a work governed by one or more Secondary Licenses, and the + Covered Software is not Incompatible With Secondary Licenses, this + License permits You to additionally distribute such Covered Software + under the terms of such Secondary License(s), so that the recipient of + the Larger Work may, at their option, further distribute the Covered + Software under the terms of either this License or such Secondary + License(s). + +3.4. Notices + + You may not remove or alter the substance of any license notices + (including copyright notices, patent notices, disclaimers of warranty, or + limitations of liability) contained within the Source Code Form of the + Covered Software, except that You may alter any license notices to the + extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + + You may choose to offer, and to charge a fee for, warranty, support, + indemnity or liability obligations to one or more recipients of Covered + Software. However, You may do so only on Your own behalf, and not on + behalf of any Contributor. You must make it absolutely clear that any + such warranty, support, indemnity, or liability obligation is offered by + You alone, and You hereby agree to indemnify every Contributor for any + liability incurred by such Contributor as a result of warranty, support, + indemnity or liability terms You offer. You may include additional + disclaimers of warranty and limitations of liability specific to any + jurisdiction. + +4. Inability to Comply Due to Statute or Regulation + + If it is impossible for You to comply with any of the terms of this License + with respect to some or all of the Covered Software due to statute, + judicial order, or regulation then You must: (a) comply with the terms of + this License to the maximum extent possible; and (b) describe the + limitations and the code they affect. Such description must be placed in a + text file included with all distributions of the Covered Software under + this License. Except to the extent prohibited by statute or regulation, + such description must be sufficiently detailed for a recipient of ordinary + skill to be able to understand it. + +5. Termination + +5.1. The rights granted under this License will terminate automatically if You + fail to comply with any of its terms. However, if You become compliant, + then the rights granted under this License from a particular Contributor + are reinstated (a) provisionally, unless and until such Contributor + explicitly and finally terminates Your grants, and (b) on an ongoing + basis, if such Contributor fails to notify You of the non-compliance by + some reasonable means prior to 60 days after You have come back into + compliance. Moreover, Your grants from a particular Contributor are + reinstated on an ongoing basis if such Contributor notifies You of the + non-compliance by some reasonable means, this is the first time You have + received notice of non-compliance with this License from such + Contributor, and You become compliant prior to 30 days after Your receipt + of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent + infringement claim (excluding declaratory judgment actions, + counter-claims, and cross-claims) alleging that a Contributor Version + directly or indirectly infringes any patent, then the rights granted to + You by any and all Contributors for the Covered Software under Section + 2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user + license agreements (excluding distributors and resellers) which have been + validly granted by You or Your distributors under this License prior to + termination shall survive termination. + +6. Disclaimer of Warranty + + Covered Software is provided under this License on an "as is" basis, + without warranty of any kind, either expressed, implied, or statutory, + including, without limitation, warranties that the Covered Software is free + of defects, merchantable, fit for a particular purpose or non-infringing. + The entire risk as to the quality and performance of the Covered Software + is with You. Should any Covered Software prove defective in any respect, + You (not any Contributor) assume the cost of any necessary servicing, + repair, or correction. This disclaimer of warranty constitutes an essential + part of this License. No use of any Covered Software is authorized under + this License except under this disclaimer. + +7. Limitation of Liability + + Under no circumstances and under no legal theory, whether tort (including + negligence), contract, or otherwise, shall any Contributor, or anyone who + distributes Covered Software as permitted above, be liable to You for any + direct, indirect, special, incidental, or consequential damages of any + character including, without limitation, damages for lost profits, loss of + goodwill, work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses, even if such party shall have been + informed of the possibility of such damages. This limitation of liability + shall not apply to liability for death or personal injury resulting from + such party's negligence to the extent applicable law prohibits such + limitation. Some jurisdictions do not allow the exclusion or limitation of + incidental or consequential damages, so this exclusion and limitation may + not apply to You. + +8. Litigation + + Any litigation relating to this License may be brought only in the courts + of a jurisdiction where the defendant maintains its principal place of + business and such litigation shall be governed by laws of that + jurisdiction, without reference to its conflict-of-law provisions. Nothing + in this Section shall prevent a party's ability to bring cross-claims or + counter-claims. + +9. Miscellaneous + + This License represents the complete agreement concerning the subject + matter hereof. If any provision of this License is held to be + unenforceable, such provision shall be reformed only to the extent + necessary to make it enforceable. Any law or regulation which provides that + the language of a contract shall be construed against the drafter shall not + be used to construe this License against a Contributor. + + +10. Versions of the License + +10.1. New Versions + + Mozilla Foundation is the license steward. Except as provided in Section + 10.3, no one other than the license steward has the right to modify or + publish new versions of this License. Each version will be given a + distinguishing version number. + +10.2. Effect of New Versions + + You may distribute the Covered Software under the terms of the version + of the License under which You originally received the Covered Software, + or under the terms of any subsequent version published by the license + steward. + +10.3. Modified Versions + + If you create software not governed by this License, and you want to + create a new license for such software, you may create and use a + modified version of this License if you rename the license and remove + any references to the name of the license steward (except to note that + such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary + Licenses If You choose to distribute Source Code Form that is + Incompatible With Secondary Licenses under the terms of this version of + the License, the notice described in Exhibit B of this License must be + attached. + +Exhibit A - Source Code Form License Notice + + This Source Code Form is subject to the + terms of the Mozilla Public License, v. + 2.0. If a copy of the MPL was not + distributed with this file, You can + obtain one at + http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular file, +then You may include the notice in a location (such as a LICENSE file in a +relevant directory) where a recipient would be likely to look for such a +notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice + + This Source Code Form is "Incompatible + With Secondary Licenses", as defined by + the Mozilla Public License, v. 2.0. + diff --git a/vendor/github.com/Xe/jsonfeed/README.md b/vendor/github.com/Xe/jsonfeed/README.md new file mode 100644 index 0000000..27f7cb5 --- /dev/null +++ b/vendor/github.com/Xe/jsonfeed/README.md @@ -0,0 +1,8 @@ +# JSONFeed - Go Package to parse JSON Feed streams + +[![Build Status](https://travis-ci.org/st3fan/jsonfeed.svg?branch=master)](https://travis-ci.org/st3fan/jsonfeed) [![Go Report Card](https://goreportcard.com/badge/github.com/st3fan/jsonfeed)](https://goreportcard.com/report/github.com/st3fan/jsonfeed) [![codecov](https://codecov.io/gh/st3fan/jsonfeed/branch/master/graph/badge.svg)](https://codecov.io/gh/st3fan/jsonfeed) + + +*Stefan Arentz, May 2017* + +Work in progress. Minimal package to parse JSON Feed streams. Please file feature requests. diff --git a/vendor/github.com/Xe/jsonfeed/jsonfeed.go b/vendor/github.com/Xe/jsonfeed/jsonfeed.go index d3af9d1..913880d 100644 --- a/vendor/github.com/Xe/jsonfeed/jsonfeed.go +++ b/vendor/github.com/Xe/jsonfeed/jsonfeed.go @@ -2,10 +2,6 @@ // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at http://mozilla.org/MPL/2.0/ -/* -Package jsonfeed is a set of types and convenience functions for reading and -parsing JSON Feed version 1 as defined here: https://jsonfeed.org/version/1 -*/ package jsonfeed import ( @@ -14,224 +10,59 @@ import ( "time" ) -// CurrentVersion will point to the current specification of JSON feed -// that this package implements. const CurrentVersion = "https://jsonfeed.org/version/1" -// Item is a single article or link in a JSON Feed. type Item struct { - // ID is unique for that item for that feed over time. If an item - // is ever updated, the id should be unchanged. New items should - // never use a previously-used id. If an id is presented as a number - // or other type, a JSON Feed reader must coerce it to a string. - // Ideally, the id is the full URL of the resource described by the - // item, since URLs make great unique identifiers. - ID string `json:"id"` - - // URL is the URL of the resource described by the item. It’s the - // permalink. This may be the same as the id — but should be present - // regardless. - URL string `json:"url,omitempty"` - - // ExternalURL is the URL of a page elsewhere. This is especially - // useful for linkblogs. If url links to where you’re talking about - // a thing, then this links to the thing you’re talking about. - ExternalURL string `json:"external_url,omitempty"` - - // Title (optional, string) is plain text. Microblog items in - // particular may omit titles. - Title string `json:"title,omitempty"` - - // ContentHTML and ContentText are each optional strings — but one - // or both must be present. This is the HTML or plain text of the - // item. Important: the only place HTML is allowed in this format - // is in content_html. A Twitter-like service might use content_text, - // while a blog might use content_html. Use whichever makes sense - // for your resource. (It doesn’t even have to be the same for each - // item in a feed.) - ContentHTML string `json:"content_html,omitempty"` - ContentText string `json:"content_text,omitempty"` - - // Summary is a plain text sentence or two describing the item. - // This might be presented in a timeline, for instance, where a - // detail view would display all of ContentHTML or ContentText. - Summary string `json:"summary,omitempty"` - - // Image is the URL of the main image for the item. This image - // may also appear in the content_html — if so, it’s a hint to - // the feed reader that this is the main, featured image. Feed - // readers may use the image as a preview (probably resized as - // a thumbnail and placed in a timeline). - Image string `json:"image,omitempty"` - - // BannerImage is the URL of an image to use as a banner. Some - // blogging systems (such as Medium) display a different banner - // image chosen to go with each post, but that image wouldn’t - // otherwise appear in the content_html. A feed reader with a - // detail view may choose to show this banner image at the top - // of the detail view, possibly with the title overlaid. - BannerImage string `json:"banner_image,omitempty"` - - // DatePublished specifies the date of this Item's publication. - DatePublished time.Time `json:"date_published,omitempty"` - - // DateModified specifies the date of this Item's last modification - // (if applicable) - DateModified time.Time `json:"date_modified,omitempty"` - - // Author has the same structure as the top-level author. If not - // specified in an item, then the top-level author, if present, - // is the author of the item. - Author *Author `json:"author,omitempty"` - - // Tags can have any plain text values you want. Tags tend to be - // just one word, but they may be anything. Note: they are not - // the equivalent of Twitter hashtags. Some blogging systems and - // other feed formats call these categories. - Tags []string `json:"tags,omitempty"` - - // Attachments (optional, array) lists related resources. Podcasts, - // for instance, would include an attachment that’s an audio or - // video file. - Attachments []Attachment `json:"attachments,omitempty"` + ID string `json:"id"` + URL string `json:"url"` + ExternalURL string `json:"external_url"` + Title string `json:"title"` + ContentHTML string `json:"content_html"` + ContentText string `json:"content_text"` + Summary string `json:"summary"` + Image string `json:"image"` + BannerImage string `json:"banner_image"` + DatePublished time.Time `json:"date_published"` + DateModified time.Time `json:"date_modified"` + Author Author `json:"author"` + Tags []string `json:"tags"` } -// Author specifies the feed author. The author object has several members. -// These are all optional, but if you provide an author object, then at -// least one is required. type Author struct { - // Name is the author's name. - Name string `json:"name,omitempty"` - - // URL is the URL of a site owned by the author. It could be a - // blog, micro-blog, Twitter account, and so on. Ideally the linked-to - // page provides a way to contact the author, but that’s not - // required. The URL could be a mailto: link, though we suspect - // that will be rare. - URL string `json:"url,omitempty"` - - // Avatar is the URL for an image for the author. As with icon, - // it should be square and relatively large — such as 512 x 512 — - // and should use transparency where appropriate, since it may - // be rendered on a non-white background. - Avatar string `json:"avatar,omitempty"` + Name string `json:"name"` + URL string `json:"url"` + Avatar string `json:"avatar"` } -// Hub describes endpoints that can be used to subscribe to real-time -// notifications from the publisher of this feed. Each object has a type -// and url, both of which are required. type Hub struct { Type string `json:"type"` URL string `json:"url"` } -// Attachment is a related resource to an Item. If the Feed describes a -// podcast, this would refer to the episodes of said podcast. type Attachment struct { - // URL specifies the location of the attachment. - URL string `json:"url"` - - // MIMEType specifies the type of the attachment, such as "audio/mpeg". - MIMEType string `json:"mime_type"` - - // Title is a name for the attachment. Important: if there are multiple - // attachments, and two or more have the exact same title (when title - // is present), then they are considered as alternate representations - // of the same thing. In this way a podcaster, for instance, might - // provide an audio recording in different formats. - Title string `json:"title,omitifempty"` - - // SizeInBytes specifies the attachment filesize in bytes. - SizeInBytes int64 `json:"size_in_bytes,omitempty"` - - // DurationInSeconds specifies how long the attachment takes to listen - // to or watch. - DurationInSeconds int64 `json:"duration_in_seconds,omitempty"` + URL string `json:"url"` + MIMEType string `json:"mime_type"` + Title string `json:"title"` + SizeInBytes int64 `json:"size_in_bytes"` + DurationInSeconds int64 `json:"duration_in_seconds"` } -// Feed is a list that may change over time, and the individual items in the -// list may change. -// -// Think of a blog or microblog, Twitter or Facebook timeline, set of commits -// to a repository, or even a server log. These are all lists, and each could -// be described by a Feed. -// -// A JSON Feed starts with some info at the top: it says where the Feed comes -// from, and may say who created it and so on. type Feed struct { - // Version is the URL of the version of the format the Feed uses. - Version string `json:"version"` - - // Title is the name of the Feed, which will often correspond to the - // name of the website (blog, for instance), though not necessarily. - Title string `json:"title"` - - // HomePageURL is the URL of the resource that the Feed describes. - // This resource may or may not actually be a “home” page, but it - // should be an HTML page. If a Feed is published on the public web, - // this should be considered as required. But it may not make sense - // in the case of a file created on a desktop computer, when that - // file is not shared or is shared only privately. - // - // This field is strongly reccomended, but not required. - HomePageURL string `json:"home_page_url,omitempty"` - - // FeedURL is the URL of the Feed, and serves as the unique identifier - // for the Feed. As with home_page_url, this should be considered - // required for Feeds on the public web. - // - // This field is strongly reccomended, but not required. - FeedURL string `json:"feed_url,omitempty"` - - // Description provides more detail, beyond the title, on what the Feed - // is about. A Feed reader may display this text. - Description string `json:"description,omitempty"` - - // UserComment is a description of the purpose of the Feed. This is for - // the use of people looking at the raw JSON, and should be ignored by - // Feed readers. - UserComment string `json:"user_comment,omitempty"` - - // NextURL is the URL of a Feed that provides the next n items, where - // n is determined by the publisher. This allows for pagination, but - // with the expectation that reader software is not required to use it - // and probably won’t use it very often. next_url must not be the same - // as Feed_url, and it must not be the same as a previous next_url - // (to avoid infinite loops). - NextURL string `json:"next_url,omitempty"` - - // Icon is the URL of an image for the Feed suitable to be used in a - // timeline, much the way an avatar might be used. It should be square - // and relatively large — such as 512 x 512 — so that it can be scaled-down - // and so that it can look good on retina displays. It should use transparency - // where appropriate, since it may be rendered on a non-white background. - Icon string `json:"icon,omitempty"` - - // Favicon is the URL of an image for the Feed suitable to be used in a - // source list. It should be square and relatively small, but not smaller - // than 64 x 64 (so that it can look good on retina displays). As with icon, - // this image should use transparency where appropriate, since it may be - // rendered on a non-white background. - Favicon string `json:"favicon,omitempty"` - - // Author specifies the Feed author. - Author Author `json:"author,omitempty"` - - // Expired specifies if the Feed will never update again. A Feed for a - // temporary event, such as an instance of the Olympics, could expire. - // If the value is true, then it’s expired. Any other value, or the - // absence of expired, means the Feed may continue to update. - Expired bool `json:"expired,omitempty"` - - // Hubs describes endpoints that can be used to subscribe to real-time - // notifications from the publisher of this Feed. - Hubs []Hub `json:"hubs,omitempty"` - - // Items is the list of Items in this Feed. - Items []Item `json:"items"` + Version string `json:"version"` + Title string `json:"title"` + HomePageURL string `json:"home_page_url"` + FeedURL string `json:"feed_url"` + Description string `json:"description"` + UserComment string `json:"user_comment"` + NextURL string `json:"next_url"` + Icon string `json:"icon"` + Favicon string `json:"favicon"` + Author Author `json:"author"` + Expired bool `json:"expired"` + Hubs []Hub `json:"hubs"` + Items []Item `json:"items"` } -// Parse reads a JSON feed object out of a reader. func Parse(r io.Reader) (Feed, error) { var feed Feed decoder := json.NewDecoder(r) diff --git a/vendor/github.com/Xe/jsonfeed/jsonfeed_test.go b/vendor/github.com/Xe/jsonfeed/jsonfeed_test.go new file mode 100644 index 0000000..29d9165 --- /dev/null +++ b/vendor/github.com/Xe/jsonfeed/jsonfeed_test.go @@ -0,0 +1,43 @@ +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/ + +package jsonfeed_test + +import ( + "os" + "testing" + "time" + + "github.com/st3fan/jsonfeed" + "github.com/stretchr/testify/assert" +) + +func Test_ParseSimple(t *testing.T) { + r, err := os.Open("testdata/feed.json") + assert.NoError(t, err, "Could not open testdata/feed.json") + + feed, err := jsonfeed.Parse(r) + assert.NoError(t, err, "Could not parse testdata/feed.json") + + assert.Equal(t, "https://jsonfeed.org/version/1", feed.Version) + assert.Equal(t, "JSON Feed", feed.Title) + assert.Equal(t, "JSON Feed is a ...", feed.Description) + assert.Equal(t, "https://jsonfeed.org/", feed.HomePageURL) + assert.Equal(t, "https://jsonfeed.org/feed.json", feed.FeedURL) + assert.Equal(t, "This feed allows ...", feed.UserComment) + assert.Equal(t, "https://jsonfeed.org/graphics/icon.png", feed.Favicon) + assert.Equal(t, "Brent Simmons and Manton Reece", feed.Author.Name) + + assert.Equal(t, 1, len(feed.Items)) + + assert.Equal(t, "https://jsonfeed.org/2017/05/17/announcing_json_feed", feed.Items[0].ID) + assert.Equal(t, "https://jsonfeed.org/2017/05/17/announcing_json_feed", feed.Items[0].URL) + assert.Equal(t, "Announcing JSON Feed", feed.Items[0].Title) + assert.Equal(t, "

We ...", feed.Items[0].ContentHTML) + + datePublished, err := time.Parse("2006-01-02T15:04:05-07:00", "2017-05-17T08:02:12-07:00") + assert.NoError(t, err, "Could not parse timestamp") + + assert.Equal(t, datePublished, feed.Items[0].DatePublished) +} diff --git a/vendor/github.com/Xe/jsonfeed/testdata/feed.json b/vendor/github.com/Xe/jsonfeed/testdata/feed.json new file mode 100644 index 0000000..ad4bbe1 --- /dev/null +++ b/vendor/github.com/Xe/jsonfeed/testdata/feed.json @@ -0,0 +1,21 @@ +{ + "version": "https://jsonfeed.org/version/1", + "title": "JSON Feed", + "description": "JSON Feed is a ...", + "home_page_url": "https://jsonfeed.org/", + "feed_url": "https://jsonfeed.org/feed.json", + "user_comment": "This feed allows ...", + "favicon": "https://jsonfeed.org/graphics/icon.png", + "author": { + "name": "Brent Simmons and Manton Reece" + }, + "items": [ + { + "id": "https://jsonfeed.org/2017/05/17/announcing_json_feed", + "url": "https://jsonfeed.org/2017/05/17/announcing_json_feed", + "title": "Announcing JSON Feed", + "content_html": "

We ...", + "date_published": "2017-05-17T08:02:12-07:00" + } + ] +} diff --git a/vendor/github.com/Xe/ln/LICENSE b/vendor/github.com/Xe/ln/LICENSE new file mode 100644 index 0000000..7202b64 --- /dev/null +++ b/vendor/github.com/Xe/ln/LICENSE @@ -0,0 +1,25 @@ +Copyright (c) 2015, Andrew Gwozdziewycz +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +1. Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright +notice, this list of conditions and the following disclaimer in the +documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/vendor/github.com/Xe/ln/README.md b/vendor/github.com/Xe/ln/README.md new file mode 100644 index 0000000..61fc941 --- /dev/null +++ b/vendor/github.com/Xe/ln/README.md @@ -0,0 +1,29 @@ +# ln: The Natural Logger for Go + +`ln` provides a simple interface to logging, and metrics, and +obviates the need to utilize purpose built metrics packages, like +`go-metrics` for simple use cases. + +The design of `ln` centers around the idea of key-value pairs, which +can be interpreted on the fly, but "Filters" to do things such as +aggregated metrics, and report said metrics to, say Librato, or +statsd. + +"Filters" are like WSGI, or Rack Middleware. They are run "top down" +and can abort an emitted log's output at any time, or continue to let +it through the chain. However, the interface is slightly different +than that. Rather than encapsulating the chain with partial function +application, we utilize a simpler method, namely, each plugin defines +an `Apply` function, which takes as an argument the log event, and +performs the work of the plugin, only if the Plugin "Applies" to this +log event. + +If `Apply` returns `false`, the iteration through the rest of the +filters is aborted, and the log is dropped from further processing. + +## Current Status: Initial Development / Concept + +## Copyright + +(c) 2015, Andrew Gwozdziewycz, BSD Licensed. See LICENSE for more +info. diff --git a/vendor/github.com/Xe/ln/action.go b/vendor/github.com/Xe/ln/action.go new file mode 100644 index 0000000..54f8954 --- /dev/null +++ b/vendor/github.com/Xe/ln/action.go @@ -0,0 +1,11 @@ +package ln + +// Action is a convenience helper for logging the "action" being performed as +// part of a log line. +// +// It is a convenience wrapper for the following: +// +// ln.Log(ctx, fer, f, ln.Action("writing frozberry sales reports to database")) +func Action(act string) Fer { + return F{"action": act} +} diff --git a/vendor/github.com/Xe/ln/context.go b/vendor/github.com/Xe/ln/context.go new file mode 100644 index 0000000..0ea3229 --- /dev/null +++ b/vendor/github.com/Xe/ln/context.go @@ -0,0 +1,38 @@ +package ln + +import ( + "context" +) + +type ctxKey int + +const ( + fKey = iota +) + +// WithF stores or appends a given F instance into a context. +func WithF(ctx context.Context, f F) context.Context { + pf, ok := FFromContext(ctx) + if !ok { + return context.WithValue(ctx, fKey, f) + } + + pf.Extend(f) + + return context.WithValue(ctx, fKey, pf) +} + +// FFromContext fetches the `F` out of the context if it exists. +func FFromContext(ctx context.Context) (F, bool) { + fvp := ctx.Value(fKey) + if fvp == nil { + return nil, false + } + + f, ok := fvp.(F) + if !ok { + return nil, false + } + + return f, true +} diff --git a/vendor/github.com/Xe/ln/doc.go b/vendor/github.com/Xe/ln/doc.go new file mode 100644 index 0000000..ab81c3c --- /dev/null +++ b/vendor/github.com/Xe/ln/doc.go @@ -0,0 +1,25 @@ +/* +Package ln is the Natural Logger for Go + +`ln` provides a simple interface to logging, and metrics, and +obviates the need to utilize purpose built metrics packages, like +`go-metrics` for simple use cases. + +The design of `ln` centers around the idea of key-value pairs, which +can be interpreted on the fly, but "Filters" to do things such as +aggregated metrics, and report said metrics to, say Librato, or +statsd. + +"Filters" are like WSGI, or Rack Middleware. They are run "top down" +and can abort an emitted log's output at any time, or continue to let +it through the chain. However, the interface is slightly different +than that. Rather than encapsulating the chain with partial function +application, we utilize a simpler method, namely, each plugin defines +an `Apply` function, which takes as an argument the log event, and +performs the work of the plugin, only if the Plugin "Applies" to this +log event. + +If `Apply` returns `false`, the iteration through the rest of the +filters is aborted, and the log is dropped from further processing. +*/ +package ln diff --git a/vendor/github.com/Xe/ln/ex/doc.go b/vendor/github.com/Xe/ln/ex/doc.go new file mode 100644 index 0000000..932ed42 --- /dev/null +++ b/vendor/github.com/Xe/ln/ex/doc.go @@ -0,0 +1,7 @@ +/* +Package ex is a set of extensions and middleware for ln. + +This package will (inevitably) have a lot of third-party dependencies and +as such might be broken apart into other packages in the future. +*/ +package ex diff --git a/vendor/github.com/Xe/ln/ex/gotrace.go b/vendor/github.com/Xe/ln/ex/gotrace.go new file mode 100644 index 0000000..5579879 --- /dev/null +++ b/vendor/github.com/Xe/ln/ex/gotrace.go @@ -0,0 +1,68 @@ +package ex + +import ( + "context" + "log" + + "github.com/Xe/ln" + "golang.org/x/net/trace" +) + +type goEventLogger struct { + ev trace.EventLog +} + +// NewGoEventLogger will log ln information to a given trace.EventLog instance. +func NewGoEventLogger(ev trace.EventLog) ln.Filter { + return &goEventLogger{ev: ev} +} + +func (gel *goEventLogger) Apply(ctx context.Context, e ln.Event) bool { + data, err := ln.DefaultFormatter.Format(ctx, e) + if err != nil { + log.Printf("wtf: error in log formatting: %v", err) + return false + } + + if everr := e.Data["err"]; everr != nil { + gel.ev.Errorf("%s", string(data)) + return true + } + + gel.ev.Printf("%s", string(data)) + return true +} + +func (gel *goEventLogger) Close() { gel.ev.Finish() } +func (gel *goEventLogger) Run() {} + +type sst string + +func (s sst) String() string { return string(s) } + +func goTraceLogger(ctx context.Context, e ln.Event) bool { + sp, ok := trace.FromContext(ctx) + if !ok { + return true // no trace in context + } + + data, err := ln.DefaultFormatter.Format(ctx, e) + if err != nil { + log.Printf("wtf: error in log formatting: %v", err) + return false + } + + if everr := e.Data["err"]; everr != nil { + sp.SetError() + } + + sp.LazyLog(sst(string(data)), false) + + return true +} + +// NewGoTraceLogger will log ln information to a golang.org/x/net/trace.Trace +// if it is present in the context of ln calls. +func NewGoTraceLogger() ln.Filter { + return ln.FilterFunc(goTraceLogger) +} diff --git a/vendor/github.com/Xe/ln/ex/http.go b/vendor/github.com/Xe/ln/ex/http.go new file mode 100644 index 0000000..c5715a3 --- /dev/null +++ b/vendor/github.com/Xe/ln/ex/http.go @@ -0,0 +1,36 @@ +package ex + +import ( + "net" + "net/http" + "time" + + "github.com/Xe/ln" +) + +func HTTPLog(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + host, _, _ := net.SplitHostPort(r.RemoteAddr) + f := ln.F{ + "remote_ip": host, + "x_forwarded_for": r.Header.Get("X-Forwarded-For"), + "path": r.URL.Path, + } + ctx := ln.WithF(r.Context(), f) + st := time.Now() + + next.ServeHTTP(w, r.WithContext(ctx)) + + af := time.Now() + f["request_duration"] = af.Sub(st) + + ws, ok := w.(interface { + Status() int + }) + if ok { + f["status"] = ws.Status() + } + + ln.Log(r.Context(), f) + }) +} diff --git a/vendor/github.com/Xe/ln/ex/l2met.go b/vendor/github.com/Xe/ln/ex/l2met.go new file mode 100644 index 0000000..e2a7f19 --- /dev/null +++ b/vendor/github.com/Xe/ln/ex/l2met.go @@ -0,0 +1,25 @@ +package ex + +import ( + "time" + + "github.com/Xe/ln" +) + +// This file deals with formatting of [l2met] style metrics. +// [l2met]: https://r.32k.io/l2met-introduction + +// Counter formats a value as a metrics counter. +func Counter(name string, value int) ln.Fer { + return ln.F{"count#" + name: value} +} + +// Gauge formats a value as a metrics gauge. +func Gauge(name string, value int) ln.Fer { + return ln.F{"gauge#" + name: value} +} + +// Measure formats a value as a metrics measure. +func Measure(name string, ts time.Time) ln.Fer { + return ln.F{"measure#" + name: time.Since(ts)} +} diff --git a/vendor/github.com/Xe/ln/example/http.go b/vendor/github.com/Xe/ln/example/http.go new file mode 100644 index 0000000..7fb98a3 --- /dev/null +++ b/vendor/github.com/Xe/ln/example/http.go @@ -0,0 +1,51 @@ +// +build ignore + +package main + +import ( + "context" + "flag" + "net/http" + "time" + + "github.com/Xe/ln" + "github.com/Xe/ln/ex" + "github.com/facebookgo/flagenv" + "golang.org/x/net/trace" +) + +var ( + port = flag.String("port", "2145", "http port to listen on") + tracingFamily = flag.String("trace-family", "ln example", "tracing family to use for x/net/trace") +) + +func main() { + flagenv.Parse() + flag.Parse() + + ln.DefaultLogger.Filters = append(ln.DefaultLogger.Filters, ex.NewGoTraceLogger()) + + http.HandleFunc("/", handleIndex) + http.ListenAndServe(":"+*port, middlewareSpan(ex.HTTPLog(http.DefaultServeMux))) +} + +func middlewareSpan(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + sp := trace.New(*tracingFamily, "HTTP request") + defer sp.Finish() + ctx, cancel := context.WithTimeout(r.Context(), 30*time.Second) + defer cancel() + + ctx = trace.NewContext(ctx, sp) + + next.ServeHTTP(w, r.WithContext(ctx)) + }) +} + +func handleIndex(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + + ln.Log(ctx, ln.Action("index"), ln.F{"there_is": "no_danger"}) + + http.Error(w, "There is no danger citizen", http.StatusOK) +} diff --git a/vendor/github.com/Xe/ln/filter.go b/vendor/github.com/Xe/ln/filter.go index 586efef..4f2d006 100644 --- a/vendor/github.com/Xe/ln/filter.go +++ b/vendor/github.com/Xe/ln/filter.go @@ -1,23 +1,24 @@ package ln import ( + "context" "io" "sync" ) // Filter interface for defining chain filters type Filter interface { - Apply(Event) bool + Apply(ctx context.Context, e Event) bool Run() Close() } // FilterFunc allows simple functions to implement the Filter interface -type FilterFunc func(e Event) bool +type FilterFunc func(ctx context.Context, e Event) bool // Apply implements the Filter interface -func (ff FilterFunc) Apply(e Event) bool { - return ff(e) +func (ff FilterFunc) Apply(ctx context.Context, e Event) bool { + return ff(ctx, e) } // Run implements the Filter interface @@ -45,8 +46,8 @@ func NewWriterFilter(out io.Writer, format Formatter) *WriterFilter { } // Apply implements the Filter interface -func (w *WriterFilter) Apply(e Event) bool { - output, err := w.Formatter.Format(e) +func (w *WriterFilter) Apply(ctx context.Context, e Event) bool { + output, err := w.Formatter.Format(ctx, e) if err == nil { w.Lock() w.Out.Write(output) @@ -63,4 +64,4 @@ func (w *WriterFilter) Run() {} func (w *WriterFilter) Close() {} // NilFilter is safe to return as a Filter, but does nothing -var NilFilter = FilterFunc(func(e Event) bool { return true }) +var NilFilter = FilterFunc(func(_ context.Context, e Event) bool { return true }) diff --git a/vendor/github.com/Xe/ln/formatter.go b/vendor/github.com/Xe/ln/formatter.go index ecd4743..70313fc 100644 --- a/vendor/github.com/Xe/ln/formatter.go +++ b/vendor/github.com/Xe/ln/formatter.go @@ -2,6 +2,7 @@ package ln import ( "bytes" + "context" "fmt" "time" ) @@ -13,7 +14,7 @@ var ( // Formatter defines the formatting of events type Formatter interface { - Format(Event) ([]byte, error) + Format(ctx context.Context, e Event) ([]byte, error) } // DefaultFormatter is the default way in which to format events @@ -36,7 +37,7 @@ func NewTextFormatter() Formatter { } // Format implements the Formatter interface -func (t *TextFormatter) Format(e Event) ([]byte, error) { +func (t *TextFormatter) Format(_ context.Context, e Event) ([]byte, error) { var writer bytes.Buffer writer.WriteString("time=\"") diff --git a/vendor/github.com/Xe/ln/logger.go b/vendor/github.com/Xe/ln/logger.go index cdfe89e..79a9a63 100644 --- a/vendor/github.com/Xe/ln/logger.go +++ b/vendor/github.com/Xe/ln/logger.go @@ -1,7 +1,7 @@ package ln import ( - "fmt" + "context" "os" "time" @@ -30,14 +30,28 @@ func init() { DefaultLogger = &Logger{ Filters: defaultFilters, } - } // F is a key-value mapping for structured data. type F map[string]interface{} +// Extend concatentates one F with one or many Fer instances. +func (f F) Extend(other ...Fer) { + for _, ff := range other { + for k, v := range ff.F() { + f[k] = v + } + } +} + +// F makes F an Fer +func (f F) F() F { + return f +} + +// Fer allows any type to add fields to the structured logging key->value pairs. type Fer interface { - F() map[string]interface{} + F() F } // Event represents an event @@ -48,8 +62,7 @@ type Event struct { } // Log is the generic logging method. -func (l *Logger) Log(xs ...interface{}) { - var bits []interface{} +func (l *Logger) Log(ctx context.Context, xs ...Fer) { event := Event{Time: time.Now()} addF := func(bf F) { @@ -62,18 +75,14 @@ func (l *Logger) Log(xs ...interface{}) { } } - // Assemble the event - for _, b := range xs { - if bf, ok := b.(F); ok { - addF(bf) - } else if fer, ok := b.(Fer); ok { - addF(F(fer.F())) - } else { - bits = append(bits, b) - } + for _, f := range xs { + addF(f.F()) } - event.Message = fmt.Sprint(bits...) + ctxf, ok := FFromContext(ctx) + if ok { + addF(ctxf) + } if os.Getenv("LN_DEBUG_ALL_EVENTS") == "1" { frame := callersFrame() @@ -85,19 +94,19 @@ func (l *Logger) Log(xs ...interface{}) { event.Data["_filename"] = frame.filename } - l.filter(event) + l.filter(ctx, event) } -func (l *Logger) filter(e Event) { +func (l *Logger) filter(ctx context.Context, e Event) { for _, f := range l.Filters { - if !f.Apply(e) { + if !f.Apply(ctx, e) { return } } } // Error logs an error and information about the context of said error. -func (l *Logger) Error(err error, xs ...interface{}) { +func (l *Logger) Error(ctx context.Context, err error, xs ...Fer) { data := F{} frame := callersFrame() @@ -113,12 +122,37 @@ func (l *Logger) Error(err error, xs ...interface{}) { xs = append(xs, data) - l.Log(xs...) + l.Log(ctx, xs...) } // Fatal logs this set of values, then exits with status code 1. -func (l *Logger) Fatal(xs ...interface{}) { - l.Log(xs...) +func (l *Logger) Fatal(ctx context.Context, xs ...Fer) { + xs = append(xs, F{"fatal": true}) + + l.Log(ctx, xs...) + + os.Exit(1) +} + +// FatalErr combines Fatal and Error. +func (l *Logger) FatalErr(ctx context.Context, err error, xs ...Fer) { + xs = append(xs, F{"fatal": true}) + + data := F{} + frame := callersFrame() + + data["_lineno"] = frame.lineno + data["_function"] = frame.function + data["_filename"] = frame.filename + data["err"] = err + + cause := errors.Cause(err) + if cause != nil { + data["cause"] = cause.Error() + } + + xs = append(xs, data) + l.Log(ctx, xs...) os.Exit(1) } @@ -126,16 +160,21 @@ func (l *Logger) Fatal(xs ...interface{}) { // Default Implementation // Log is the generic logging method. -func Log(xs ...interface{}) { - DefaultLogger.Log(xs...) +func Log(ctx context.Context, xs ...Fer) { + DefaultLogger.Log(ctx, xs...) } // Error logs an error and information about the context of said error. -func Error(err error, xs ...interface{}) { - DefaultLogger.Error(err, xs...) +func Error(ctx context.Context, err error, xs ...Fer) { + DefaultLogger.Error(ctx, err, xs...) } // Fatal logs this set of values, then exits with status code 1. -func Fatal(xs ...interface{}) { - DefaultLogger.Fatal(xs...) +func Fatal(ctx context.Context, xs ...Fer) { + DefaultLogger.Fatal(ctx, xs...) +} + +// FatalErr combines Fatal and Error. +func FatalErr(ctx context.Context, err error, xs ...Fer) { + DefaultLogger.FatalErr(ctx, err, xs...) } diff --git a/vendor/github.com/Xe/ln/logger_test.go b/vendor/github.com/Xe/ln/logger_test.go new file mode 100644 index 0000000..800ed90 --- /dev/null +++ b/vendor/github.com/Xe/ln/logger_test.go @@ -0,0 +1,111 @@ +package ln + +import ( + "bytes" + "context" + "fmt" + "testing" + "time" +) + +var ctx context.Context + +func setup(t *testing.T) (*bytes.Buffer, func()) { + ctx = context.Background() + + out := bytes.Buffer{} + oldFilters := DefaultLogger.Filters + DefaultLogger.Filters = []Filter{NewWriterFilter(&out, nil)} + return &out, func() { + DefaultLogger.Fi