From 1ae74591f65df241baf31fca783d827fe52b31a7 Mon Sep 17 00:00:00 2001 From: "Frederick F. Kautz IV" Date: Tue, 24 Mar 2015 23:54:43 -0700 Subject: [PATCH] Adding iodine --- Godeps/Godeps.json | 4 + .../src/github.com/minio-io/iodine/.gitignore | 24 +++ .../src/github.com/minio-io/iodine/LICENSE | 202 ++++++++++++++++++ .../src/github.com/minio-io/iodine/README.md | 2 + .../src/github.com/minio-io/iodine/iodine.go | 93 ++++++++ .../github.com/minio-io/iodine/iodine_test.go | 43 ++++ pkg/storage/donut/donut.go | 8 +- 7 files changed, 373 insertions(+), 3 deletions(-) create mode 100644 Godeps/_workspace/src/github.com/minio-io/iodine/.gitignore create mode 100644 Godeps/_workspace/src/github.com/minio-io/iodine/LICENSE create mode 100644 Godeps/_workspace/src/github.com/minio-io/iodine/README.md create mode 100644 Godeps/_workspace/src/github.com/minio-io/iodine/iodine.go create mode 100644 Godeps/_workspace/src/github.com/minio-io/iodine/iodine_test.go diff --git a/Godeps/Godeps.json b/Godeps/Godeps.json index 3099aa9c6..3742c0790 100644 --- a/Godeps/Godeps.json +++ b/Godeps/Godeps.json @@ -18,6 +18,10 @@ "Comment": "1.2.0-96-gfcc23e2", "Rev": "fcc23e23a705c0d95fce2a446c364ac31a1c73a5" }, + { + "ImportPath": "github.com/minio-io/iodine", + "Rev": "3d54fa6339544392a0eaadcf2692fbc94d4ac21d" + }, { "ImportPath": "gopkg.in/check.v1", "Rev": "64131543e7896d5bcc6bd5a76287eb75ea96c673" diff --git a/Godeps/_workspace/src/github.com/minio-io/iodine/.gitignore b/Godeps/_workspace/src/github.com/minio-io/iodine/.gitignore new file mode 100644 index 000000000..daf913b1b --- /dev/null +++ b/Godeps/_workspace/src/github.com/minio-io/iodine/.gitignore @@ -0,0 +1,24 @@ +# Compiled Object files, Static and Dynamic libs (Shared Objects) +*.o +*.a +*.so + +# Folders +_obj +_test + +# Architecture specific extensions/prefixes +*.[568vq] +[568vq].out + +*.cgo1.go +*.cgo2.c +_cgo_defun.c +_cgo_gotypes.go +_cgo_export.* + +_testmain.go + +*.exe +*.test +*.prof diff --git a/Godeps/_workspace/src/github.com/minio-io/iodine/LICENSE b/Godeps/_workspace/src/github.com/minio-io/iodine/LICENSE new file mode 100644 index 000000000..e06d20818 --- /dev/null +++ b/Godeps/_workspace/src/github.com/minio-io/iodine/LICENSE @@ -0,0 +1,202 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/Godeps/_workspace/src/github.com/minio-io/iodine/README.md b/Godeps/_workspace/src/github.com/minio-io/iodine/README.md new file mode 100644 index 000000000..d7391ea49 --- /dev/null +++ b/Godeps/_workspace/src/github.com/minio-io/iodine/README.md @@ -0,0 +1,2 @@ +# iodine +Iodine is an error logging framework for tracing errors. diff --git a/Godeps/_workspace/src/github.com/minio-io/iodine/iodine.go b/Godeps/_workspace/src/github.com/minio-io/iodine/iodine.go new file mode 100644 index 000000000..0e5004dd9 --- /dev/null +++ b/Godeps/_workspace/src/github.com/minio-io/iodine/iodine.go @@ -0,0 +1,93 @@ +/* + * Iodine, (C) 2014 Minio, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package iodine + +import ( + "bytes" + "encoding/json" + "fmt" + "os" + "runtime" + "strconv" +) + +type Error struct { + EmbeddedError error `json:"-"` + ErrorMessage string + + Stack []StackEntry +} + +type StackEntry struct { + Host string + File string + Line int + Data map[string]string +} + +func Wrap(err error, data map[string]string) *Error { + entry := createStackEntry() + for k, v := range data { + entry.Data[k] = v + } + return &Error{ + EmbeddedError: err, + ErrorMessage: err.Error(), + Stack: []StackEntry{entry}, + } +} + +func createStackEntry() StackEntry { + host, _ := os.Hostname() + _, file, line, _ := runtime.Caller(2) + entry := StackEntry{ + Host: host, + File: file, + Line: line, + Data: make(map[string]string), + } + return entry +} + +func (err *Error) Annotate(info map[string]string) *Error { + data := make(map[string]string) + if info != nil { + for k, v := range info { + data[k] = v + } + } + entry := createStackEntry() + err.Stack = append(err.Stack, entry) + return err +} + +func (err Error) EmitJson() ([]byte, error) { + return json.Marshal(err) +} + +func (err Error) EmitHumanReadable() string { + var errorBuffer bytes.Buffer + fmt.Fprintln(&errorBuffer, err.Error()) + for i, entry := range err.Stack { + fmt.Fprintln(&errorBuffer, "-", i, entry.Host+":"+entry.File+":"+strconv.Itoa(entry.Line), entry.Data) + } + return string(errorBuffer.Bytes()) +} + +func (err Error) Error() string { + return err.EmbeddedError.Error() +} diff --git a/Godeps/_workspace/src/github.com/minio-io/iodine/iodine_test.go b/Godeps/_workspace/src/github.com/minio-io/iodine/iodine_test.go new file mode 100644 index 000000000..b8625de36 --- /dev/null +++ b/Godeps/_workspace/src/github.com/minio-io/iodine/iodine_test.go @@ -0,0 +1,43 @@ +/* + * Iodine, (C) 2014 Minio, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package iodine + +import ( + "bytes" + "encoding/json" + "errors" + "log" + "testing" +) + +func TestIodine(t *testing.T) { + iodineError := Wrap(errors.New("Hello"), nil) + iodineError.Annotate(nil) + iodineError.Annotate(nil) + iodineError.Annotate(nil) + if len(iodineError.Stack) != 4 { + t.Fail() + } + jsonResult, err := iodineError.EmitJson() + if err != nil { + t.Fail() + } + var prettyBuffer bytes.Buffer + json.Indent(&prettyBuffer, jsonResult, "", " ") + log.Println(string(prettyBuffer.Bytes())) + log.Println(iodineError.EmitHumanReadable()) +} diff --git a/pkg/storage/donut/donut.go b/pkg/storage/donut/donut.go index 3af9d6fa8..3ff320c1e 100644 --- a/pkg/storage/donut/donut.go +++ b/pkg/storage/donut/donut.go @@ -6,6 +6,8 @@ import ( "sort" "strconv" "strings" + + "github.com/minio-io/iodine" ) type donut struct { @@ -14,7 +16,7 @@ type donut struct { } // NewDonut - instantiate new donut driver -func NewDonut(root string) (Donut, error) { +func NewDonut(root string) (Donut, *iodine.Error) { nodes := make(map[string]Node) nodes["localhost"] = &localDirectoryNode{root: root} driver := &donut{ @@ -24,7 +26,7 @@ func NewDonut(root string) (Donut, error) { for nodeID, node := range nodes { bucketIDs, err := node.GetBuckets() if err != nil { - return nil, err + return nil, iodine.Wrap(err, map[string]string{"root": root}) } for _, bucketID := range bucketIDs { tokens := strings.Split(bucketID, ":") @@ -38,7 +40,7 @@ func NewDonut(root string) (Donut, error) { driver.buckets[tokens[0]] = bucket } if err = driver.buckets[tokens[0]].AddNode(nodeID, bucketID); err != nil { - return nil, err + return nil, iodine.Wrap(err, map[string]string{"root": root}) } } }