filesystem

Documentation

Overview

Package filesystem provides functions and types to interact with the filesystem

Index

• func FileExists(path string) bool
• func GetFileModTime(path string) (time.Time, error)
• func GetFileSize(path string) (int64, error)
• func OpenShared(path string) (*os.File, error)
• func ReadLines(filename string) ([]string, error)
• type Disk
  • func NewDisk() Disk
  • func (Disk) GetUsage(path string) (*DiskUsage, error)
• type DiskUsage
• type Permission
  • func NewPermission() (*Permission, error)
  • func (p *Permission) RemoveAccessToOtherUsers(path string) error
  • func (p *Permission) RestrictAccessToUser(path string) error

Functions

func FileExists

func FileExists(path string) bool

FileExists returns true if a file exists and is accessible, false otherwise

func GetFileModTime

func GetFileModTime(path string) (time.Time, error)

GetFileModTime gets the modification time

func GetFileSize

func GetFileSize(path string) (int64, error)

GetFileSize gets the file size

func OpenShared

func OpenShared(path string) (*os.File, error)

OpenShared reimplements the os.Open function for Windows because the default implementation opens files without the FILE_SHARE_DELETE flag. cf: https://github.com/golang/go/blob/release-branch.go1.11/src/syscall/syscall_windows.go#L271 Without FILE_SHARE_DELETE, other users cannot rename/remove the file while this handle is open. Adding this flag allows the agent to have the file open, while not preventing it from being rotated/deleted.

On non-Windows platforms, this calls through to os.Open directly.

func ReadLines

func ReadLines(filename string) ([]string, error)

ReadLines reads a file line by line

Types

type Disk

type Disk struct{}

Disk gets information about the disk

func NewDisk

func NewDisk() Disk

NewDisk creates a new instance of Disk

func (Disk) GetUsage

func (Disk) GetUsage(path string) (*DiskUsage, error)

GetUsage gets the disk usage

type DiskUsage

type DiskUsage struct {
	Total     uint64
	Available uint64
}

DiskUsage is the disk usage

type Permission

type Permission struct{}

Permission handles permissions for Unix and Windows

func NewPermission

func NewPermission() (*Permission, error)

NewPermission creates a new instance of `Permission`

func (*Permission) RemoveAccessToOtherUsers

func (p *Permission) RemoveAccessToOtherUsers(path string) error

RemoveAccessToOtherUsers on Unix this calls RestrictAccessToUser and then removes all access to the file for 'group' and 'other'

func (*Permission) RestrictAccessToUser

func (p *Permission) RestrictAccessToUser(path string) error

RestrictAccessToUser sets the file user and group to the same as 'dd-agent' user. If the function fails to lookup "dd-agent" user it return nil immediately.