pax_global_header00006660000000000000000000000064144043440700014512gustar00rootroot0000000000000052 comment=39e0d78865134ae0b1bca0183ca5562339e5431f zeroconfig-0.1.2/000077500000000000000000000000001440434407000136575ustar00rootroot00000000000000zeroconfig-0.1.2/.editorconfig000066400000000000000000000003061440434407000163330ustar00rootroot00000000000000root = true [*] indent_style = tab indent_size = 4 end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true [*.{yaml,yml}] indent_style = space indent_size = 2 zeroconfig-0.1.2/.github/000077500000000000000000000000001440434407000152175ustar00rootroot00000000000000zeroconfig-0.1.2/.github/workflows/000077500000000000000000000000001440434407000172545ustar00rootroot00000000000000zeroconfig-0.1.2/.github/workflows/go.yml000066400000000000000000000021071440434407000204040ustar00rootroot00000000000000name: Go on: [push, pull_request] jobs: lint: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: Set up Go uses: actions/setup-go@v3 with: go-version: "1.20" cache: true - name: Install goimports run: | go install golang.org/x/tools/cmd/goimports@latest export PATH="$HOME/go/bin:$PATH" - name: Install pre-commit run: pip install pre-commit - name: Lint run: pre-commit run -a test: runs-on: ubuntu-latest strategy: matrix: go-version: ["1.19", "1.20"] steps: - uses: actions/checkout@v3 - name: Set up Go ${{ matrix.go-version }} uses: actions/setup-go@v3 with: go-version: ${{ matrix.go-version }} cache: true - name: Set up gotestfmt uses: GoTestTools/gotestfmt-action@v2 with: token: ${{ secrets.GITHUB_TOKEN }} - name: Build run: go build -v ./... - name: Test run: go test -json -v ./... 2>&1 | gotestfmt zeroconfig-0.1.2/.pre-commit-config.yaml000066400000000000000000000006101440434407000201350ustar00rootroot00000000000000repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.4.0 hooks: - id: trailing-whitespace exclude_types: [markdown] - id: end-of-file-fixer - id: check-yaml - id: check-added-large-files - repo: https://github.com/tekwizely/pre-commit-golang rev: v1.0.0-rc.1 hooks: - id: go-imports-repo - id: go-vet-repo-mod zeroconfig-0.1.2/LICENSE000066400000000000000000000405251440434407000146720ustar00rootroot00000000000000Mozilla 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. zeroconfig-0.1.2/README.md000066400000000000000000000071611440434407000151430ustar00rootroot00000000000000# zeroconfig A relatively simple declarative config format for [zerolog](https://github.com/rs/zerolog). Meant to be used as YAML, but JSON struct tags are included as well. ## Config reference ```yaml # Global minimum log level. Defaults to trace. min_level: trace # Should logs include timestamps? Defaults to true. timestamps: true # Should logs include the caller function? Defaults to false. caller: false # Additional log metadata to add globally. Map from string key to arbitrary value. metadata: null # List of writers to output logs to. # The `type` field is always required. `format`, `min_level` and `max_level` can be specified for any type of writer. # Some types have additional custom configuration writers: # `stdout` and `stderr` write to the corresponding standard IO streams. # They have no custom configuration fields, the extra fields below showcase the fields that can be added to any writer. - # The type of writer. type: stdout # The format to write. Available formats are json, pretty and pretty-colored. Defaults to json. format: pretty-colored # If format is pretty or pretty-colored, time_format can be used to specify how timestamps are formatted. # Uses Go time formatting https://pkg.go.dev/time#pkg-constants and defaults to RFC3339 (2006-01-02T15:04:05Z07:00). time_format: 2006-01-02 15:04:05 # Minimum level for this writer. Defaults to no level (i.e. inherited from root min_level). # This can only reduce the amount of logs written to this writer, levels below the global min_level are never logged. min_level: info # Maximum level for this writer. Defaults to no level (all logs above minimum are logged). max_level: warn # If you want errors in stderr, make a separate writer like this: # If you want all logs in stdout, just remove this and the max_level above. - type: stderr format: pretty-colored min_level: error # `file` is a rotating file handler (https://github.com/natefinch/lumberjack). - type: file # File name for the current log. Backups will be stored in the same directory, named as name-.ext filename: example.log # Maximum size in megabytes for the log file before rotating. Defaults to 100 megabytes. max_size: 100 # Maximum age of rotated log files to keep as days. Defaults to no limit. max_age: 0 # Maximum number of rotated log files to keep. Defaults to no limit. max_backups: 0 # Should rotated log file names use local time instead of UTC? Defaults to false. local_time: false # Should rotated log files be compressed with gzip? Defaults to false. compress: false # `syslog` writes to the system log service using the Go stdlib syslog package. - type: syslog # you can also use syslog-cee to add the MITRE CEE prefix. # These four parameters are passed to https://pkg.go.dev/log/syslog#Dial directly. network: udp host: localhost # Priority flags as defined in syslog.h flags: 8 tag: zerolog # `journald` writes to systemd's logging service using https://github.com/coreos/go-systemd. # It has no custom configuration fields. - type: journald ``` ## Usage example ```go package main import ( "github.com/rs/zerolog" "go.mau.fi/zeroconfig" "gopkg.in/yaml.v3" ) func prepareLog(yamlConfig []byte) (*zerolog.Logger, error) { var cfg zeroconfig.Config err := yaml.Unmarshal(yamlConfig, &cfg) if err != nil { return nil, err } return cfg.Compile() } // This should obviously be loaded from a file rather than hardcoded const logConfig = ` min_level: debug writers: - type: stdout format: pretty-colored ` func main() { log, err := prepareLog([]byte(logConfig)) if err != nil { panic(err) } log.Info().Msg("Logger initialized") } ``` zeroconfig-0.1.2/adapters.go000066400000000000000000000023061440434407000160120ustar00rootroot00000000000000// Copyright (c) 2023 Tulir Asokan // // 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 zeroconfig import ( "io" "github.com/rs/zerolog" ) type levelWriterAdapter struct { io.Writer } func (lw levelWriterAdapter) WriteLevel(l zerolog.Level, p []byte) (n int, err error) { return lw.Write(p) } type minMaxLevelWriter struct { zerolog.LevelWriter MinLevel zerolog.Level MaxLevel zerolog.Level } // MinMaxLevelWriter wraps a writer in a zerolog.LevelWriter, but limits the log levels that can pass through. func MinMaxLevelWriter(writer io.Writer, minLevel, maxLevel zerolog.Level) zerolog.LevelWriter { lw, ok := writer.(zerolog.LevelWriter) if !ok { lw = levelWriterAdapter{writer} } return minMaxLevelWriter{LevelWriter: lw, MinLevel: minLevel, MaxLevel: maxLevel} } func (mlw minMaxLevelWriter) WriteLevel(l zerolog.Level, p []byte) (n int, err error) { if (mlw.MinLevel == zerolog.NoLevel || l >= mlw.MinLevel) && (mlw.MaxLevel == zerolog.NoLevel || l <= mlw.MaxLevel) { return mlw.LevelWriter.WriteLevel(l, p) } return len(p), nil } zeroconfig-0.1.2/adapters_test.go000066400000000000000000000037061440434407000170560ustar00rootroot00000000000000// Copyright (c) 2023 Tulir Asokan // // 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 zeroconfig_test import ( "bytes" "encoding/json" "testing" "github.com/rs/zerolog" "github.com/stretchr/testify/require" "go.mau.fi/zeroconfig" ) var allLevels = []zerolog.Level{zerolog.TraceLevel, zerolog.DebugLevel, zerolog.InfoLevel, zerolog.WarnLevel, zerolog.ErrorLevel, zerolog.FatalLevel, zerolog.PanicLevel} type logLine struct { Level zerolog.Level `json:"level"` Message string `json:"message"` } func TestMinMaxLevelWriter(t *testing.T) { tests := []struct { name string min zerolog.Level max zerolog.Level out []zerolog.Level }{{ "No limits", zerolog.NoLevel, zerolog.NoLevel, allLevels, }, { "Only up to info", zerolog.NoLevel, zerolog.InfoLevel, []zerolog.Level{zerolog.TraceLevel, zerolog.DebugLevel, zerolog.InfoLevel}, }, { "Only above error", zerolog.ErrorLevel, zerolog.NoLevel, []zerolog.Level{zerolog.ErrorLevel, zerolog.FatalLevel, zerolog.PanicLevel}, }, { "Only between debug and warn", zerolog.DebugLevel, zerolog.WarnLevel, []zerolog.Level{zerolog.DebugLevel, zerolog.InfoLevel, zerolog.WarnLevel}, }} for _, test := range tests { t.Run(test.name, func(t *testing.T) { var buf bytes.Buffer log := zerolog.New(zeroconfig.MinMaxLevelWriter(&buf, test.min, test.max)) for i, level := range allLevels { log.WithLevel(level).Int("meow_num", i).Msg("meow") } dec := json.NewDecoder(&buf) for i, expected := range test.out { var ll logLine err := dec.Decode(&ll) require.NoError(t, err, "Decoding log line should be successful") require.Equalf(t, expected, ll.Level, "Log #%d has expected level", i+1) } require.False(t, dec.More(), "Log output should be empty after reading expected levels") }) } } zeroconfig-0.1.2/config.go000066400000000000000000000172241440434407000154610ustar00rootroot00000000000000// Copyright (c) 2023 Tulir Asokan // // 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 zeroconfig import ( "fmt" "io" "log/syslog" "os" "sort" "time" "github.com/rs/zerolog" "gopkg.in/natefinch/lumberjack.v2" ) // SyslogConfig contains the configuration options for the syslog writer. // // See https://pkg.go.dev/log/syslog for exact details. type SyslogConfig struct { // All parameters are passed to https://pkg.go.dev/log/syslog#Dial directly. Network string `json:"network,omitempty" yaml:"network,omitempty"` Host string `json:"host,omitempty" yaml:"host,omitempty"` Flags syslog.Priority `json:"flags,omitempty" yaml:"flags,omitempty"` Tag string `json:"tag,omitempty" yaml:"tag,omitempty"` } // FileConfig contains the configuration options for the file writer. // // See https://github.com/natefinch/lumberjack for exact details. type FileConfig struct { // File name for the current log. Backups will be stored in the same directory, named as name-.ext Filename string `json:"filename,omitempty" yaml:"filename,omitempty"` // Maximum size in megabytes for the log file before rotating. Defaults to 100 megabytes. MaxSize int `json:"max_size,omitempty" yaml:"max_size,omitempty"` // Maximum age of rotated log files to keep as days. Defaults to no limit. MaxAge int `json:"max_age,omitempty" yaml:"max_age,omitempty"` // Maximum number of rotated log files to keep. Defaults to no limit. MaxBackups int `json:"max_backups,omitempty" yaml:"max_backups,omitempty"` // Should rotated log file names use local time instead of UTC? Defaults to false. LocalTime bool `json:"local_time,omitempty" yaml:"local_time,omitempty"` // Should rotated log files be compressed with gzip? Defaults to false. Compress bool `json:"compress,omitempty" yaml:"compress,omitempty"` } // WriterType is a type of writer. type WriterType string const ( // WriterTypeStdout writes to stdout. WriterTypeStdout WriterType = "stdout" // WriterTypeStderr writes to stderr. WriterTypeStderr WriterType = "stderr" // WriterTypeFile writes to a file, including rotating the file when it gets big. // The configuration is stored in the FileConfig struct. WriterTypeFile WriterType = "file" // WriterTypeSyslog writes to the system logging service. // The configuration is stored in the SyslogConfig struct. WriterTypeSyslog WriterType = "syslog" // WriterTypeSyslogCEE writes to the system logging service with MITRE CEE prefixes. WriterTypeSyslogCEE WriterType = "syslog-cee" // WriterTypeJournald writes to systemd's logging service. WriterTypeJournald WriterType = "journald" ) // LogFormat describes how logs should be formatted for a writer. type LogFormat string const ( // LogFormatJSON outputs logs as the raw JSON that zerolog produces. LogFormatJSON LogFormat = "json" // LogFormatPretty uses zerolog's console writer, but disables color. LogFormatPretty LogFormat = "pretty" // LogFormatPrettyColored uses zerolog's console writer including color. LogFormatPrettyColored LogFormat = "pretty-colored" ) // WriterConfig contains the configuration for an individual log writer. type WriterConfig struct { // The type of writer. Type WriterType `json:"type" yaml:"type"` Format LogFormat `json:"format,omitempty" yaml:"format,omitempty"` MinLevel *zerolog.Level `json:"min_level,omitempty" yaml:"min_level,omitempty"` MaxLevel *zerolog.Level `json:"max_level,omitempty" yaml:"max_level,omitempty"` // Only applies when format=console or format=console-colored TimeFormat string `json:"time_format,omitempty" yaml:"time_format,omitempty"` SyslogConfig `json:",inline,omitempty" yaml:",inline,omitempty"` FileConfig `json:",inline,omitempty" yaml:",inline,omitempty"` } // Config contains all the configuration to create a zerolog logger. type Config struct { Writers []WriterConfig `json:"writers,omitempty" yaml:"writers,omitempty"` MinLevel *zerolog.Level `json:"min_level,omitempty" yaml:"min_level,omitempty"` Timestamp *bool `json:"timestamp,omitempty" yaml:"timestamp,omitempty"` Caller bool `json:"caller,omitempty" yaml:"caller,omitempty"` Metadata map[string]any `json:"metadata,omitempty" yaml:"metadata,omitempty"` } // Outputs used for the stdout and stderr writer types. var ( Stdout io.Writer = os.Stdout Stderr io.Writer = os.Stderr ) func compileUnsupported(wc *WriterConfig) (io.Writer, error) { return nil, fmt.Errorf("writer type %q not supported on this OS", wc.Type) } type WriterCompiler = func(*WriterConfig) (io.Writer, error) var writerCompilers = map[WriterType]WriterCompiler{ WriterTypeStdout: func(_ *WriterConfig) (io.Writer, error) { return Stdout, nil }, WriterTypeStderr: func(_ *WriterConfig) (io.Writer, error) { return Stderr, nil }, WriterTypeFile: compileFile, WriterTypeJournald: compileUnsupported, WriterTypeSyslog: compileUnsupported, WriterTypeSyslogCEE: compileUnsupported, } func RegisterWriter(wt WriterType, compiler WriterCompiler) { writerCompilers[wt] = compiler } func compileFile(wc *WriterConfig) (io.Writer, error) { writer := &lumberjack.Logger{ Filename: wc.Filename, MaxSize: wc.MaxSize, MaxAge: wc.MaxAge, MaxBackups: wc.MaxBackups, LocalTime: wc.LocalTime, Compress: wc.Compress, } err := writer.Rotate() if err != nil { return nil, err } return writer, nil } func (wc *WriterConfig) compileMain() (io.Writer, error) { compiler, ok := writerCompilers[wc.Type] if !ok { return nil, fmt.Errorf("unknown writer type %q", wc.Type) } return compiler(wc) } func levelPtr(ptr *zerolog.Level) zerolog.Level { if ptr == nil { return zerolog.NoLevel } return *ptr } // Compile creates an io.Writer instance out of the configuration in this struct. func (wc *WriterConfig) Compile() (io.Writer, error) { output, err := wc.compileMain() if err != nil { return nil, err } switch wc.Format { case "", LogFormatJSON: // output directly case LogFormatPretty, LogFormatPrettyColored: wrapper := zerolog.ConsoleWriter{ Out: output, } if wc.Format == LogFormatPretty { wrapper.NoColor = true } if wc.TimeFormat != "" { wrapper.TimeFormat = wc.TimeFormat } else { wrapper.TimeFormat = time.RFC3339 } output = wrapper default: return nil, fmt.Errorf("unknown format %q", wc.Format) } if wc.MinLevel != nil || wc.MaxLevel != nil { output = MinMaxLevelWriter(output, levelPtr(wc.MinLevel), levelPtr(wc.MaxLevel)) } return output, nil } // Compile creates a zerolog.Logger instance out of the configuration in this struct. func (c *Config) Compile() (*zerolog.Logger, error) { if len(c.Writers) == 0 || (c.MinLevel != nil && *c.MinLevel == zerolog.Disabled) { log := zerolog.Nop() return &log, nil } writers := make([]io.Writer, len(c.Writers)) for i, wc := range c.Writers { writer, err := wc.Compile() if err != nil { return nil, fmt.Errorf("failed to parse config for writer #%d: %w", i+1, err) } writers[i] = writer } var realWriter io.Writer if len(writers) == 1 { realWriter = writers[0] } else if len(writers) > 1 { realWriter = zerolog.MultiLevelWriter(writers...) } with := zerolog.New(realWriter).With() if c.Timestamp == nil || *c.Timestamp { with = with.Timestamp() } if c.Caller { with = with.Caller() } if len(c.Metadata) > 0 { keys := make([]string, len(c.Metadata)) i := 0 for key := range c.Metadata { keys[i] = key i++ } sort.Strings(keys) for _, key := range keys { with = with.Interface(key, c.Metadata[key]) } } log := with.Logger() if c.MinLevel != nil { log = log.Level(*c.MinLevel) } return &log, nil } zeroconfig-0.1.2/config_test.go000066400000000000000000000110641440434407000165140ustar00rootroot00000000000000// Copyright (c) 2023 Tulir Asokan // // 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 zeroconfig_test import ( "bytes" "encoding/json" "fmt" "os" "path/filepath" "strconv" "testing" "time" "github.com/rs/zerolog" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "go.mau.fi/zeroconfig" ) func compile(t *testing.T, cfg string) *zerolog.Logger { var parsed zeroconfig.Config err := json.Unmarshal([]byte(cfg), &parsed) if err != nil { require.NoError(t, err, "Unmarshaling config should be successful") } logger, err := parsed.Compile() if err != nil { require.NoError(t, err, "Compiling config should be successful") } return logger } func TestWriterConfig_Compile_Stdout(t *testing.T) { var out bytes.Buffer zeroconfig.Stdout = &out log := compile(t, `{ "writers": [ {"type": "stdout", "format": "pretty"} ], "min_level": "debug", "timestamp": false }`) log.Trace().Msg("meow") require.Empty(t, out.String(), "Output should be empty after logging below minimum level") log.Debug().Int("cats", 5).Msg("meow") require.NotEmpty(t, out.String(), "Output should not be empty after logging at minimum level") require.Equal(t, " DBG meow cats=5\n", out.String(), "Output is formatted prettily") out.Reset() } func TestWriterConfig_Compile_Metadata(t *testing.T) { var out bytes.Buffer zeroconfig.Stdout = &out log := compile(t, `{ "writers": [ {"type": "stdout", "format": "pretty"} ], "metadata": { "meow": 5, "foo": {"bar": "asd"} }, "timestamp": false }`) log.Debug().Msg("meow") require.NotEmpty(t, out.String(), "Output should not be empty after logging") require.Equal(t, ` DBG meow foo={"bar":"asd"} meow=5`+"\n", out.String(), "Output contains global metadata fields") out.Reset() } func TestWriterConfig_Compile_TimeFormat(t *testing.T) { var out bytes.Buffer zeroconfig.Stdout = &out log := compile(t, `{ "writers": [ {"type": "stdout", "format": "pretty", "time_format": "2006"} ], "min_level": "debug" }`) require.Equal(t, time.Now().Year(), time.Now().Add(5*time.Second).Year(), "This test can't be ran at midnight right before the new year") log.Debug().Int("cats", 5).Msg("meow") require.Equal(t, strconv.Itoa(time.Now().Year())+" DBG meow cats=5\n", out.String(), "Output has current year as date") } func TestWriterConfig_Compile_MultiLevel_Stdio(t *testing.T) { var stderr, stdout bytes.Buffer zeroconfig.Stdout = &stdout zeroconfig.Stderr = &stderr log := compile(t, `{ "writers": [ {"type": "stdout", "format": "pretty", "max_level": "warn"}, {"type": "stderr", "format": "pretty", "min_level": "error"} ], "min_level": "trace", "timestamp": false }`) log.Info().Msg("meow") assert.Empty(t, stderr.String(), "Stderr should not have info log") assert.Equal(t, " INF meow\n", stdout.String(), "Stdout should have info log") stdout.Reset() stderr.Reset() log.Error().Msg("meow #2") assert.Empty(t, stdout.String(), "Stdout should not have error log") assert.Equal(t, " ERR meow #2\n", stderr.String(), "Stderr should have error log") stdout.Reset() stderr.Reset() log.Trace().Msg("meow #3") assert.Empty(t, stderr.String(), "Stderr should not have trace log") assert.Equal(t, " TRC meow #3\n", stdout.String(), "Stdout should have trace log") stdout.Reset() stderr.Reset() } func TestWriterConfig_Compile_StdoutAndFile(t *testing.T) { dir := t.TempDir() var stdout bytes.Buffer zeroconfig.Stdout = &stdout log := compile(t, fmt.Sprintf(`{ "writers": [ {"type": "stdout", "format": "pretty", "min_level": "info"}, {"type": "file", "filename": "%s/test.log"} ], "min_level": "trace", "timestamp": false }`, dir)) fileName := filepath.Join(dir, "test.log") file, err := os.Open(fileName) require.NoError(t, err, "Opening log file should be successful") dec := json.NewDecoder(file) var ll logLine log.Debug().Msg("meow") assert.Empty(t, stdout.String(), "Stdout is empty when logging debug") assert.NoError(t, dec.Decode(&ll), "File should contain JSON log line") assert.Equal(t, ll.Level, zerolog.DebugLevel) assert.Equal(t, ll.Message, "meow") log.Error().Msg("meow #2") assert.Equal(t, " ERR meow #2\n", stdout.String(), "Stdout should have error log") assert.NoError(t, dec.Decode(&ll), "File should contain JSON log line") assert.Equal(t, ll.Level, zerolog.ErrorLevel) assert.Equal(t, ll.Message, "meow #2") } zeroconfig-0.1.2/config_unix.go000066400000000000000000000016641440434407000165250ustar00rootroot00000000000000// Copyright (c) 2023 Tulir Asokan // // 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/. //go:build unix package zeroconfig import ( "io" "log/syslog" "github.com/rs/zerolog" "github.com/rs/zerolog/journald" ) func compileSyslog(wc *WriterConfig) (io.Writer, error) { sl, err := syslog.Dial(wc.Network, wc.Host, wc.Flags, wc.Tag) if err != nil { return nil, err } if wc.Type == WriterTypeSyslogCEE { return zerolog.SyslogCEEWriter(sl), nil } else { return zerolog.SyslogLevelWriter(sl), nil } } func compileJournald(_ *WriterConfig) (io.Writer, error) { return journald.NewJournalDWriter(), nil } func init() { writerCompilers[WriterTypeSyslog] = compileSyslog writerCompilers[WriterTypeSyslogCEE] = compileSyslog writerCompilers[WriterTypeJournald] = compileJournald } zeroconfig-0.1.2/config_unix_test.go000066400000000000000000000006371440434407000175630ustar00rootroot00000000000000// Copyright (c) 2023 Tulir Asokan // // 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/. // go:build unix package zeroconfig_test import ( "testing" ) func TestWriterConfig_Compile_Journald(t *testing.T) { compile(t, `{"writers": [{"type": "journald"}]}`) } zeroconfig-0.1.2/go.mod000066400000000000000000000010511440434407000147620ustar00rootroot00000000000000module go.mau.fi/zeroconfig go 1.19 require ( github.com/rs/zerolog v1.29.0 github.com/stretchr/testify v1.8.1 gopkg.in/natefinch/lumberjack.v2 v2.2.1 ) require ( github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534 // indirect github.com/davecgh/go-spew v1.1.1 // indirect github.com/mattn/go-colorable v0.1.12 // indirect github.com/mattn/go-isatty v0.0.14 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect ) zeroconfig-0.1.2/go.sum000066400000000000000000000057231440434407000150210ustar00rootroot00000000000000github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534 h1:rtAn27wIbmOGUs7RIbVgPEjb31ehTVniDwPGXyMxm5U= github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.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/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40= github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y= github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= 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/rs/xid v1.4.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= github.com/rs/zerolog v1.29.0 h1:Zes4hju04hjbvkVkOhdl2HpZa+0PmVwigmo8XoORE5w= github.com/rs/zerolog v1.29.0/go.mod h1:NILgTygv/Uej1ra5XxGf82ZFSLk58MFGAUS2o6usyD0= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6 h1:foEbQz/B0Oz6YIqu/69kfXPYeFQAuuMYFkjaqXzl5Wo= golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/natefinch/lumberjack.v2 v2.2.1 h1:bBRl1b0OH9s/DuPhuXpNl+VtCaJXFZ5/uEFST95x9zc= gopkg.in/natefinch/lumberjack.v2 v2.2.1/go.mod h1:YD8tP3GAjkrDg1eZH7EGmyESg/lsYskCTPBJVb9jqSc= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=