https://github.com/hemantjadon/barrel

Rolling writer which can be used when underlying writer changes.
https://github.com/hemantjadon/barrel

golang logging writer

Last synced: 6 months ago
JSON representation

Rolling writer which can be used when underlying writer changes.

• Host: GitHub
• URL: https://github.com/hemantjadon/barrel
• Owner: hemantjadon
• License: mit
• Created: 2020-09-03T06:34:18.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-01-25T08:30:33.000Z (over 5 years ago)
• Last Synced: 2024-06-20T14:24:40.386Z (about 2 years ago)
• Topics: golang, logging, writer
• Language: Go
• Homepage:
• Size: 33.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# barrel

![Go](https://github.com/hemantjadon/barrel/workflows/barrel/badge.svg?branch=master&event=push)

`barrel` provides a rolling writer which can be used as an `io.Writer` when

the underlying writer may change.

## Usage

`barrel` can be used at any place where some changing `io.Writer` is needed.

### Files

`barrel` can be used with package `barrel/barrelfile` to write rolling files, 

where the underlying file vary according to some trigger.

```go

file, _ := os.OpenFile("/path/to/file", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)

rollingWriter := barrel.RollingWriter{

    Writer: file,

    Trigger: barrelfile.TriggerAdapter{

        FileTrigger: barrelfile.SizeBasedTrigger{Size: 1 * 1e3 * 1e3}, // 1 MB

    },

    Rotator: barrelfile.RotatorAdapter{

        FileRotator: barrelfile.TransformRotator{

            Transformers: []barrelfile.Transformer{

                barrelfile.RenameTransformer{

                    Namer: barrelfile.TimestampSequenceNamer{},

                },

                barrelfile.GzipTransformer{

                    GzipLevel: gzip.DefaultCompression,

                },

            },

            Rotator: barrelfile.IdentityRotator{},

        },

        OpenFlag: os.O_WRONLY | os.O_CREATE | os.O_APPEND,

    },

}

_, _ = rollingWriter.Write([]byte("hello world"))

defer func() { _ = rollingWriter.Close() }()

```