hupwriter

README

HUP acceptable io.Writer

Getting Started

Install and Upgrade

$ go get github.com/koron/hupwriter@latest

Usage

import (
    "github.com/koron/hupwriter"
    "log"
)

h := hupwriter.New("/var/log/myapp.log", "/var/pid/myapp.pid")
log.SetOutput(h)

Documentation

Overview

Package hupwriter provides wrapper of os.File.

The wrapper will close and reopen the file when a HUP signal is received. It allows easier log file rotation.

By logging to hupwriter you can create log files that can be used with log rotation management programs such as logrotate, newsyslog, or so.

Index

• type HupWriter
  • func New(name, pid string) *HupWriter
  • func (h *HupWriter) Close() error
  • func (h *HupWriter) Write(p []byte) (int, error)

Types

type HupWriter

type HupWriter struct {
	// contains filtered or unexported fields
}

HupWriter wraps os.File, and will close and reopen the file when a HUP signal is received.

func New

func New(name, pid string) *HupWriter

New creates a HupWriter with a file of name. It create PID file which records current process ID when pid is not empty.

func (*HupWriter) Close

func (h *HupWriter) Close() error

Close closes an underlying file, and stop to listening signals.

func (*HupWriter) Write

func (h *HupWriter) Write(p []byte) (int, error)

Write writes data to an underlying file.