usage

README

krakend-usage

Anonymous usage report module for the KrakenD framework

Documentation

Index

• Constants
• type HTTPClient
• type Minter
• type ReportReply
• type ReportRequest
• type Reporter
  • func New(url, clusterID, serverID, Version string) (*Reporter, error)
  • func (r *Reporter) Report(ctx context.Context)
  • func (r *Reporter) SingleReport(ctx context.Context) error
• type SessionReply
• type SessionRequest
• type UsageClient
• type UsageData
  • func (u *UsageData) Expired() bool
  • func (u *UsageData) Hash() (string, error)

Constants

const (
	HashBits         = 20
	SaltChars        = 40
	DefaultExtension = ""
)

Types

type HTTPClient

type HTTPClient interface {
	Send(context.Context, string, interface{}, interface{}) error
}

type Minter

type Minter interface {
	Mint(string) (string, error)
}

type ReportReply

type ReportReply struct {
	Status  int    `json:"status"`
	Message string `json:"message,omitempty"`
}

type ReportRequest

type ReportRequest struct {
	Token string    `json:"token"`
	Pow   string    `json:"pow"`
	Data  UsageData `json:"data"`
}

type Reporter

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

func New

func New(url, clusterID, serverID, Version string) (*Reporter, error)

func (*Reporter) Report

func (r *Reporter) Report(ctx context.Context)

func (*Reporter) SingleReport

func (r *Reporter) SingleReport(ctx context.Context) error

type SessionReply

type SessionReply struct {
	Token string `json:"token"`
}

type SessionRequest

type SessionRequest struct {
	ClusterID string `json:"cluster_id"`
	ServerID  string `json:"server_id"`
}

type UsageClient

type UsageClient interface {
	NewSession(context.Context, *SessionRequest) (*SessionReply, error)
	SendReport(context.Context, *ReportRequest) (*ReportReply, error)
}

type UsageData

type UsageData struct {
	Version   string `json:"version"`
	Arch      string `json:"arch"`
	OS        string `json:"os"`
	ClusterID string `json:"cluster_id"`
	ServerID  string `json:"server_id"`
	Uptime    int64  `json:"uptime"`
	Time      int64  `json:"time"`
}

func (*UsageData) Expired

func (u *UsageData) Expired() bool

func (*UsageData) Hash

func (u *UsageData) Hash() (string, error)