pax_global_header00006660000000000000000000000064136205415430014515gustar00rootroot0000000000000052 comment=6d1d13b007673e2c4d37c701b9ad7fee27a65ade golang-github-euank-go-kmsg-parser-2.0.1/000077500000000000000000000000001362054154300202015ustar00rootroot00000000000000golang-github-euank-go-kmsg-parser-2.0.1/.gitignore000066400000000000000000000000151362054154300221650ustar00rootroot00000000000000/bin/godmesg golang-github-euank-go-kmsg-parser-2.0.1/.travis.yml000066400000000000000000000001541362054154300223120ustar00rootroot00000000000000language: go go: - 1.11 branches: only: - master - dev script: - make test-deps - make test - make golang-github-euank-go-kmsg-parser-2.0.1/LICENSE000066400000000000000000000261351362054154300212150ustar00rootroot00000000000000 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. golang-github-euank-go-kmsg-parser-2.0.1/Makefile000066400000000000000000000002641362054154300216430ustar00rootroot00000000000000.PHONY: all godmesg test test-deps all: godmesg godmesg: go build -o ./bin/godmesg ./cmd/godmesg test: go test -v ./... test-deps: go get github.com/stretchr/testify/assert golang-github-euank-go-kmsg-parser-2.0.1/README.md000066400000000000000000000011111362054154300214520ustar00rootroot00000000000000# go-kmsg-parser [![Build Status](https://travis-ci.org/euank/go-kmsg-parser.svg?branch=master)](https://travis-ci.org/euank/go-kmsg-parser) This repository contains a library to allow parsing the `/dev/kmsg` device in Linux. This device provides a read-write interface to the Linux Kernel's ring buffer. In addition to the library, a simple cli-tool that functions similarly to `dmesg --ctime --follow` is included. This code serves both as a usage example and as a simple way to verify it works how you'd expect on a given system. # Contributions Welcome # License Apache 2.0 golang-github-euank-go-kmsg-parser-2.0.1/cmd/000077500000000000000000000000001362054154300207445ustar00rootroot00000000000000golang-github-euank-go-kmsg-parser-2.0.1/cmd/godmesg/000077500000000000000000000000001362054154300223715ustar00rootroot00000000000000golang-github-euank-go-kmsg-parser-2.0.1/cmd/godmesg/main.go000066400000000000000000000021661362054154300236510ustar00rootroot00000000000000/* Copyright 2016 Euan Kemp 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 main import ( "flag" "fmt" "log" "time" "github.com/euank/go-kmsg-parser/kmsgparser" ) func main() { tail := flag.Bool("t", false, "start at the tail of kmsg") flag.Parse() parser, err := kmsgparser.NewParser() if err != nil { log.Fatalf("unable to create parser: %v", err) } defer parser.Close() if *tail { err := parser.SeekEnd() if err != nil { log.Fatalf("could not tail: %v", err) } } kmsg := parser.Parse() for msg := range kmsg { fmt.Printf("(%d) - %s: %s", msg.SequenceNumber, msg.Timestamp.Format(time.RFC3339Nano), msg.Message) } } golang-github-euank-go-kmsg-parser-2.0.1/go.mod000066400000000000000000000002711362054154300213070ustar00rootroot00000000000000module github.com/euank/go-kmsg-parser require ( github.com/davecgh/go-spew v1.1.1 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect github.com/stretchr/testify v1.2.2 ) golang-github-euank-go-kmsg-parser-2.0.1/go.sum000066400000000000000000000010111362054154300213250ustar00rootroot00000000000000github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= golang-github-euank-go-kmsg-parser-2.0.1/kmsgparser/000077500000000000000000000000001362054154300223575ustar00rootroot00000000000000golang-github-euank-go-kmsg-parser-2.0.1/kmsgparser/kmsgparser.go000066400000000000000000000126171362054154300250730ustar00rootroot00000000000000/* Copyright 2016 Euan Kemp 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 kmsgparser implements a parser for the Linux `/dev/kmsg` format. // More information about this format may be found here: // https://www.kernel.org/doc/Documentation/ABI/testing/dev-kmsg // Some parts of it are slightly inspired by rsyslog's contrib module: // https://github.com/rsyslog/rsyslog/blob/v8.22.0/contrib/imkmsg/kmsg.c package kmsgparser import ( "fmt" "io" "os" "strconv" "strings" "syscall" "time" ) // Parser is a parser for the kernel ring buffer found at /dev/kmsg type Parser interface { // SeekEnd moves the parser to the end of the kmsg queue. SeekEnd() error // Parse provides a channel of messages read from the kernel ring buffer. // When first called, it will read the existing ringbuffer, after which it will emit new messages as they occur. Parse() <-chan Message // SetLogger sets the logger that will be used to report malformed kernel // ringbuffer lines or unexpected kmsg read errors. SetLogger(Logger) // Close closes the underlying kmsg reader for this parser Close() error } // Message represents a given kmsg logline, including its timestamp (as // calculated based on offset from boot time), its possibly multi-line body, // and so on. More information about these mssages may be found here: // https://www.kernel.org/doc/Documentation/ABI/testing/dev-kmsg type Message struct { Priority int SequenceNumber int Timestamp time.Time Message string } func NewParser() (Parser, error) { f, err := os.Open("/dev/kmsg") if err != nil { return nil, err } bootTime, err := getBootTime() if err != nil { return nil, err } return &parser{ log: &StandardLogger{nil}, kmsgReader: f, bootTime: bootTime, }, nil } type ReadSeekCloser interface { io.ReadCloser io.Seeker } type parser struct { log Logger kmsgReader ReadSeekCloser bootTime time.Time } func getBootTime() (time.Time, error) { var sysinfo syscall.Sysinfo_t err := syscall.Sysinfo(&sysinfo) if err != nil { return time.Time{}, fmt.Errorf("could not get boot time: %v", err) } // sysinfo only has seconds return time.Now().Add(-1 * (time.Duration(sysinfo.Uptime) * time.Second)), nil } func (p *parser) SetLogger(log Logger) { p.log = log } func (p *parser) Close() error { return p.kmsgReader.Close() } func (p *parser) SeekEnd() error { _, err := p.kmsgReader.Seek(0, os.SEEK_END) return err } // Parse will read from the provided reader and provide a channel of messages // parsed. // If the provided reader *is not* a proper Linux kmsg device, Parse might not // behave correctly since it relies on specific behavior of `/dev/kmsg` // // A goroutine is created to process the provided reader. The goroutine will // exit when the given reader is closed. // Closing the passed in reader will cause the goroutine to exit. func (p *parser) Parse() <-chan Message { output := make(chan Message, 1) go func() { defer close(output) msg := make([]byte, 8192) for { // Each read call gives us one full message. // https://www.kernel.org/doc/Documentation/ABI/testing/dev-kmsg n, err := p.kmsgReader.Read(msg) if err != nil { if err == syscall.EPIPE { p.log.Warningf("short read from kmsg; skipping") continue } if err == io.EOF { p.log.Infof("kmsg reader closed, shutting down") return } p.log.Errorf("error reading /dev/kmsg: %v", err) return } msgStr := string(msg[:n]) message, err := p.parseMessage(msgStr) if err != nil { p.log.Warningf("unable to parse kmsg message %q: %v", msgStr, err) continue } output <- message } }() return output } func (p *parser) parseMessage(input string) (Message, error) { // Format: // PRIORITY,SEQUENCE_NUM,TIMESTAMP,-;MESSAGE parts := strings.SplitN(input, ";", 2) if len(parts) != 2 { return Message{}, fmt.Errorf("invalid kmsg; must contain a ';'") } metadata, message := parts[0], parts[1] metadataParts := strings.Split(metadata, ",") if len(metadataParts) < 3 { return Message{}, fmt.Errorf("invalid kmsg: must contain at least 3 ',' separated pieces at the start") } priority, sequence, timestamp := metadataParts[0], metadataParts[1], metadataParts[2] prioNum, err := strconv.Atoi(priority) if err != nil { return Message{}, fmt.Errorf("could not parse %q as priority: %v", priority, err) } sequenceNum, err := strconv.Atoi(sequence) if err != nil { return Message{}, fmt.Errorf("could not parse %q as sequence number: %v", priority, err) } timestampUsFromBoot, err := strconv.ParseInt(timestamp, 10, 64) if err != nil { return Message{}, fmt.Errorf("could not parse %q as timestamp: %v", priority, err) } // timestamp is offset in microsecond from boottime. msgTime := p.bootTime.Add(time.Duration(timestampUsFromBoot) * time.Microsecond) return Message{ Priority: prioNum, SequenceNumber: sequenceNum, Timestamp: msgTime, Message: message, }, nil } golang-github-euank-go-kmsg-parser-2.0.1/kmsgparser/kmsgparser_test.go000066400000000000000000000070101362054154300261210ustar00rootroot00000000000000/* Copyright 2016 Euan Kemp 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 kmsgparser import ( "bufio" "bytes" "io" "io/ioutil" "os" "path/filepath" "testing" "time" "github.com/stretchr/testify/assert" ) // Logger that errors on warnings and errors type warningAndErrorTestLogger struct { t *testing.T } func (warningAndErrorTestLogger) Infof(string, ...interface{}) {} func (w warningAndErrorTestLogger) Warningf(s string, i ...interface{}) { w.t.Errorf(s, i...) } func (w warningAndErrorTestLogger) Errorf(s string, i ...interface{}) { w.t.Errorf(s, i...) } func TestParseMessage(t *testing.T) { bootTime := time.Unix(0xb100, 0x5ea1).Round(time.Microsecond) p := parser{ log: warningAndErrorTestLogger{t: t}, bootTime: bootTime, } msg, err := p.parseMessage("6,2565,102258085667,-;docker0: port 2(vethc1bb733) entered blocking state") if err != nil { t.Fatalf("error parsing: %v", err) } assert.Equal(t, msg.Message, "docker0: port 2(vethc1bb733) entered blocking state") assert.Equal(t, msg.Priority, 6) assert.Equal(t, msg.SequenceNumber, 2565) assert.Equal(t, msg.Timestamp, bootTime.Add(102258085667*time.Microsecond)) } func TestParse(t *testing.T) { bootTime := time.Unix(0xb100, 0x5ea1).Round(time.Microsecond) p := parser{ log: warningAndErrorTestLogger{t: t}, bootTime: bootTime, } f, err := os.Open(filepath.Join("test_data", "sample1.kmsg")) if err != nil { t.Fatalf("could not find sample data: %v", err) } defer f.Close() expectedMessages := []Message{ { Priority: 6, SequenceNumber: 1804, Timestamp: bootTime.Add(47700428483 * time.Microsecond), Message: "wlp4s0: associated", }, { Priority: 6, SequenceNumber: 1805, Timestamp: bootTime.Add(51742248189 * time.Microsecond), Message: "thinkpad_acpi: EC reports that Thermal Table has changed", }, { Priority: 6, SequenceNumber: 2651, Timestamp: bootTime.Add(106819644585 * time.Microsecond), Message: "CPU1: Package temperature/speed normal", }, } s := bufio.NewScanner(f) mockKmsg, mockKmsgInput := io.Pipe() p.kmsgReader = mockSeeker(ioutil.NopCloser(mockKmsg)) go func() { for s.Scan() { _, err := mockKmsgInput.Write(s.Bytes()) if err != nil { panic(err) } } mockKmsgInput.Close() }() lines := p.Parse() messages := []Message{} for line := range lines { messages = append(messages, line) } assert.Equal(t, expectedMessages, messages) } func TestSeekEnd(t *testing.T) { p := parser{ log: warningAndErrorTestLogger{t: t}, } var mockKmsg bytes.Buffer mockkmsg := mockSeeker(ioutil.NopCloser(&mockKmsg)) p.kmsgReader = mockkmsg err := p.SeekEnd() assert.Nil(t, err) assert.Equal(t, mockkmsg.seekCalls, [][2]int64{[2]int64{0, int64(os.SEEK_END)}}) } type mseeker struct { io.ReadCloser seekCalls [][2]int64 } func mockSeeker(rc io.ReadCloser) *mseeker { return &mseeker{ReadCloser: rc} } func (m *mseeker) Seek(x int64, y int) (int64, error) { m.seekCalls = append(m.seekCalls, [2]int64{x, int64(y)}) return 0, nil } golang-github-euank-go-kmsg-parser-2.0.1/kmsgparser/log.go000066400000000000000000000027201362054154300234700ustar00rootroot00000000000000/* Copyright 2016 Euan Kemp 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 kmsgparser import stdlog "log" // Logger is a glog compatible logging interface // The StandardLogger struct can be used to wrap a log.Logger from the golang // "log" package to create a standard a logger fulfilling this interface as // well. type Logger interface { Warningf(string, ...interface{}) Infof(string, ...interface{}) Errorf(string, ...interface{}) } // StandardLogger adapts the "log" package's Logger interface to be a Logger type StandardLogger struct { *stdlog.Logger } func (s *StandardLogger) Warningf(fmt string, args ...interface{}) { if s.Logger == nil { return } s.Logger.Printf("[WARNING] "+fmt, args) } func (s *StandardLogger) Infof(fmt string, args ...interface{}) { if s.Logger == nil { return } s.Logger.Printf("[INFO] "+fmt, args) } func (s *StandardLogger) Errorf(fmt string, args ...interface{}) { if s.Logger == nil { return } s.Logger.Printf("[INFO] "+fmt, args) } golang-github-euank-go-kmsg-parser-2.0.1/kmsgparser/test_data/000077500000000000000000000000001362054154300243275ustar00rootroot00000000000000golang-github-euank-go-kmsg-parser-2.0.1/kmsgparser/test_data/sample1.kmsg000066400000000000000000000002631362054154300265550ustar00rootroot000000000000006,1804,47700428483,-;wlp4s0: associated 6,1805,51742248189,-;thinkpad_acpi: EC reports that Thermal Table has changed 6,2651,106819644585,-;CPU1: Package temperature/speed normal