amproxy

Documentation

Index

• Variables
• type Message
  • func Parse(str string) (*Message, error)
  • func ParseSigned(str string) (*Message, error)
  • func (m Message) ComputeSignature(secret string) string
  • func (m Message) MetricStr() string
  • func (m Message) String() string

Variables

var ErrInvalidNumMessageComponents = errors.New("invalid number of components in message")

ErrInvalidNumMessageComponents is the error returned when parsing a message that has an invaid number of items.

Types

type Message

type Message struct {
	Name      string
	Value     string
	Timestamp time.Time
	PublicKey string
	Signature string
}

Message represents an amproxy metric

func Parse

func Parse(str string) (*Message, error)

Parse attempts to parse the given unsigned string into a Message.

func ParseSigned

func ParseSigned(str string) (*Message, error)

ParseSigned attempts to parse the given signed string into a Message.

func (Message) ComputeSignature

func (m Message) ComputeSignature(secret string) string

ComputeSignature uses the private key to compute the HMAC SHA-256 signature for the message.

func (Message) MetricStr

func (m Message) MetricStr() string

MetricStr returns the carbon wire format of the message.

func (Message) String

func (m Message) String() string

String returns the wire format of the message. The signature must have already been computed.