monitoring

Documentation

Index

• Constants
• func Configure(config *Config, serviceName string) *prometheus.Exporter
• func NewFossilizerAdapter(f fossilizer.Adapter, name string) fossilizer.Adapter
• func NewKeyValueStoreAdapter(s store.KeyValueStore, name string) store.KeyValueStore
• func NewStoreAdapter(s store.Adapter, name string) store.Adapter
• func RegisterFlags()
• func SetSpanStatusAndEnd(span *trace.Span, err error)
• type Config
  • func ConfigurationFromFlags() *Config
• type FossilizerAdapter
  • func (a *FossilizerAdapter) AddFossilizerEventChan(c chan *fossilizer.Event)
  • func (a *FossilizerAdapter) Fossilize(ctx context.Context, data []byte, meta []byte) (err error)
  • func (a *FossilizerAdapter) GetInfo(ctx context.Context) (res interface{}, err error)
• type KeyValueStoreAdapter
  • func (a *KeyValueStoreAdapter) DeleteValue(ctx context.Context, key []byte) (v []byte, err error)
  • func (a *KeyValueStoreAdapter) GetValue(ctx context.Context, key []byte) (v []byte, err error)
  • func (a *KeyValueStoreAdapter) SetValue(ctx context.Context, key []byte, value []byte) (err error)
• type StoreAdapter
  • func (a *StoreAdapter) AddEvidence(ctx context.Context, linkHash *types.Bytes32, evidence *cs.Evidence) (err error)
  • func (a *StoreAdapter) AddStoreEventChannel(c chan *store.Event)
  • func (a *StoreAdapter) CreateLink(ctx context.Context, link *cs.Link) (lh *types.Bytes32, err error)
  • func (a *StoreAdapter) FindSegments(ctx context.Context, filter *store.SegmentFilter) (ss cs.SegmentSlice, err error)
  • func (a *StoreAdapter) GetEvidences(ctx context.Context, linkHash *types.Bytes32) (e *cs.Evidences, err error)
  • func (a *StoreAdapter) GetInfo(ctx context.Context) (res interface{}, err error)
  • func (a *StoreAdapter) GetMapIDs(ctx context.Context, filter *store.MapFilter) (mids []string, err error)
  • func (a *StoreAdapter) GetSegment(ctx context.Context, linkHash *types.Bytes32) (s *cs.Segment, err error)
  • func (a *StoreAdapter) NewBatch(ctx context.Context) (b store.Batch, err error)

Constants

const (
	// Not an error; returned on success
	//
	// HTTP Mapping: 200 OK
	Ok = 0

	// The operation was cancelled, typically by the caller.
	//
	// HTTP Mapping: 499 Client Closed Request
	Cancelled = 1

	// Unknown error.  For example, this error may be returned when
	// a `Status` value received from another address space belongs to
	// an error space that is not known in this address space.  Also
	// errors raised by APIs that do not return enough error information
	// may be converted to this error.
	//
	// HTTP Mapping: 500 Internal Server Error
	Unknown = 2

	// The client specified an invalid argument.  Note that this differs
	// from `FAILED_PRECONDITION`.  `INVALID_ARGUMENT` indicates arguments
	// that are problematic regardless of the state of the system
	// (e.g., a malformed file name).
	//
	// HTTP Mapping: 400 Bad Request
	InvalidArgument = 3

	// The deadline expired before the operation could complete. For operations
	// that change the state of the system, this error may be returned
	// even if the operation has completed successfully.  For example, a
	// successful response from a server could have been delayed long
	// enough for the deadline to expire.
	//
	// HTTP Mapping: 504 Gateway Timeout
	DeadlineExceeded = 4

	// Some requested entity (e.g., file or directory) was not found.
	//
	// Note to server developers: if a request is denied for an entire class
	// of users, such as gradual feature rollout or undocumented whitelist,
	// `NOT_FOUND` may be used. If a request is denied for some users within
	// a class of users, such as user-based access control, `PERMISSION_DENIED`
	// must be used.
	//
	// HTTP Mapping: 404 Not Found
	NotFound = 5

	// The entity that a client attempted to create (e.g., file or directory)
	// already exists.
	//
	// HTTP Mapping: 409 Conflict
	AlreadyExists = 6

	// The caller does not have permission to execute the specified
	// operation. `PERMISSION_DENIED` must not be used for rejections
	// caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
	// instead for those errors). `PERMISSION_DENIED` must not be
	// used if the caller can not be identified (use `UNAUTHENTICATED`
	// instead for those errors). This error code does not imply the
	// request is valid or the requested entity exists or satisfies
	// other pre-conditions.
	//
	// HTTP Mapping: 403 Forbidden
	PermissionDenied = 7

	// The request does not have valid authentication credentials for the
	// operation.
	//
	// HTTP Mapping: 401 Unauthorized
	Unauthenticated = 16

	// Some resource has been exhausted, perhaps a per-user quota, or
	// perhaps the entire file system is out of space.
	//
	// HTTP Mapping: 429 Too Many Requests
	ResourceExhausted = 8

	// The operation was rejected because the system is not in a state
	// required for the operation's execution.  For example, the directory
	// to be deleted is non-empty, an rmdir operation is applied to
	// a non-directory, etc.
	//
	// Service implementors can use the following guidelines to decide
	// between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
	//  (a) Use `UNAVAILABLE` if the client can retry just the failing call.
	//  (b) Use `ABORTED` if the client should retry at a higher level
	//      (e.g., when a client-specified test-and-set fails, indicating the
	//      client should restart a read-modify-write sequence).
	//  (c) Use `FAILED_PRECONDITION` if the client should not retry until
	//      the system state has been explicitly fixed.  E.g., if an "rmdir"
	//      fails because the directory is non-empty, `FAILED_PRECONDITION`
	//      should be returned since the client should not retry unless
	//      the files are deleted from the directory.
	//
	// HTTP Mapping: 400 Bad Request
	FailedPrecondition = 9

	// The operation was aborted, typically due to a concurrency issue such as
	// a sequencer check failure or transaction abort.
	//
	// See the guidelines above for deciding between `FAILED_PRECONDITION`,
	// `ABORTED`, and `UNAVAILABLE`.
	//
	// HTTP Mapping: 409 Conflict
	Aborted = 10

	// The operation was attempted past the valid range.  E.g., seeking or
	// reading past end-of-file.
	//
	// Unlike `INVALID_ARGUMENT`, this error indicates a problem that may
	// be fixed if the system state changes. For example, a 32-bit file
	// system will generate `INVALID_ARGUMENT` if asked to read at an
	// offset that is not in the range [0,2^32-1], but it will generate
	// `OUT_OF_RANGE` if asked to read from an offset past the current
	// file size.
	//
	// There is a fair bit of overlap between `FAILED_PRECONDITION` and
	// `OUT_OF_RANGE`.  We recommend using `OUT_OF_RANGE` (the more specific
	// error) when it applies so that callers who are iterating through
	// a space can easily look for an `OUT_OF_RANGE` error to detect when
	// they are done.
	//
	// HTTP Mapping: 400 Bad Request
	OutOfRange = 11

	// The operation is not implemented or is not supported/enabled in this
	// service.
	//
	// HTTP Mapping: 501 Not Implemented
	Unimplemented = 12

	// Internal errors.  This means that some invariants expected by the
	// underlying system have been broken.  This error code is reserved
	// for serious errors.
	//
	// HTTP Mapping: 500 Internal Server Error
	Internal = 13

	// The service is currently unavailable.  This is most likely a
	// transient condition, which can be corrected by retrying with
	// a backoff.
	//
	// See the guidelines above for deciding between `FAILED_PRECONDITION`,
	// `ABORTED`, and `UNAVAILABLE`.
	//
	// HTTP Mapping: 503 Service Unavailable
	Unavailable = 14

	// Unrecoverable data loss or corruption.
	//
	// HTTP Mapping: 500 Internal Server Error
	DataLoss = 15
)

Taken from https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto as recommended by the OpenCensus documentation.

const (
	// DefaultJaegerEndpoint is the default endpoint exposed
	// by the Jaeger collector.
	DefaultJaegerEndpoint = "http://jaeger:14268"
)

Functions

func Configure

func Configure(config *Config, serviceName string) *prometheus.Exporter

Configure configures metrics and trace monitoring. It returns the metrics exporter that you should expose on a /metrics http route.

func NewFossilizerAdapter

func NewFossilizerAdapter(f fossilizer.Adapter, name string) fossilizer.Adapter

NewFossilizerAdapter decorates an existing fossilizer.

func NewKeyValueStoreAdapter

func NewKeyValueStoreAdapter(s store.KeyValueStore, name string) store.KeyValueStore

NewKeyValueStoreAdapter decorates an existing key value store adapter.

func NewStoreAdapter

func NewStoreAdapter(s store.Adapter, name string) store.Adapter

NewStoreAdapter decorates an existing store adapter.

func RegisterFlags

func RegisterFlags()

RegisterFlags registers the command-line monitoring flags.

func SetSpanStatusAndEnd

func SetSpanStatusAndEnd(span *trace.Span, err error)

SetSpanStatusAndEnd sets the status of the span depending on the error and ends it. You should usually call defer SetSpanStatusAndEnd(span, err) at the beginning of your function.

Types

type Config

type Config struct {
	// Set to true to monitor Indigo components.
	Monitor bool
	// Port used to expose prometheus metrics.
	MetricsPort int
	// Jaeger collector url.
	JaegerEndpoint string
	// Ratio of traces to record.
	// If set to 1.0, all traces will be recorded.
	// This is what you should do locally or during a beta.
	// For production, you should set this to 0.25 or 0.5,
	// depending on your load.
	TraceSamplingRatio float64
}

Config contains options for monitoring.

func ConfigurationFromFlags

func ConfigurationFromFlags() *Config

ConfigurationFromFlags builds configuration from user-provided command-line flags.

type FossilizerAdapter

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

FossilizerAdapter is a decorator for the Fossilizer interface. It wraps a real Fossilizer implementation and adds instrumentation.

func (*FossilizerAdapter) AddFossilizerEventChan

func (a *FossilizerAdapter) AddFossilizerEventChan(c chan *fossilizer.Event)

AddFossilizerEventChan instruments the call and delegates to the underlying fossilizer.

func (*FossilizerAdapter) Fossilize

func (a *FossilizerAdapter) Fossilize(ctx context.Context, data []byte, meta []byte) (err error)

Fossilize instruments the call and delegates to the underlying fossilizer.

func (*FossilizerAdapter) GetInfo

func (a *FossilizerAdapter) GetInfo(ctx context.Context) (res interface{}, err error)

GetInfo instruments the call and delegates to the underlying fossilizer.

type KeyValueStoreAdapter

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

KeyValueStoreAdapter is a decorator for the store.KeyValueStore interface. It wraps a real store.KeyValueStore implementation and adds instrumentation.

func (*KeyValueStoreAdapter) DeleteValue

func (a *KeyValueStoreAdapter) DeleteValue(ctx context.Context, key []byte) (v []byte, err error)

DeleteValue instruments the call and delegates to the underlying store.

func (*KeyValueStoreAdapter) GetValue

func (a *KeyValueStoreAdapter) GetValue(ctx context.Context, key []byte) (v []byte, err error)

GetValue instruments the call and delegates to the underlying store.

func (*KeyValueStoreAdapter) SetValue

func (a *KeyValueStoreAdapter) SetValue(ctx context.Context, key []byte, value []byte) (err error)

SetValue instruments the call and delegates to the underlying store.

type StoreAdapter

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

StoreAdapter is a decorator for the store.Adapter interface. It wraps a real store.Adapter implementation and adds instrumentation.

func (*StoreAdapter) AddEvidence

func (a *StoreAdapter) AddEvidence(ctx context.Context, linkHash *types.Bytes32, evidence *cs.Evidence) (err error)

AddEvidence instruments the call and delegates to the underlying store.

func (*StoreAdapter) AddStoreEventChannel

func (a *StoreAdapter) AddStoreEventChannel(c chan *store.Event)

AddStoreEventChannel instruments the call and delegates to the underlying store.

func (*StoreAdapter) CreateLink

func (a *StoreAdapter) CreateLink(ctx context.Context, link *cs.Link) (lh *types.Bytes32, err error)

CreateLink instruments the call and delegates to the underlying store.

func (*StoreAdapter) FindSegments

func (a *StoreAdapter) FindSegments(ctx context.Context, filter *store.SegmentFilter) (ss cs.SegmentSlice, err error)

FindSegments instruments the call and delegates to the underlying store.

func (*StoreAdapter) GetEvidences

func (a *StoreAdapter) GetEvidences(ctx context.Context, linkHash *types.Bytes32) (e *cs.Evidences, err error)

GetEvidences instruments the call and delegates to the underlying store.

func (*StoreAdapter) GetInfo

func (a *StoreAdapter) GetInfo(ctx context.Context) (res interface{}, err error)

GetInfo instruments the call and delegates to the underlying store.

func (*StoreAdapter) GetMapIDs

func (a *StoreAdapter) GetMapIDs(ctx context.Context, filter *store.MapFilter) (mids []string, err error)

GetMapIDs instruments the call and delegates to the underlying store.

func (*StoreAdapter) GetSegment

func (a *StoreAdapter) GetSegment(ctx context.Context, linkHash *types.Bytes32) (s *cs.Segment, err error)

GetSegment instruments the call and delegates to the underlying store.

func (*StoreAdapter) NewBatch

func (a *StoreAdapter) NewBatch(ctx context.Context) (b store.Batch, err error)

NewBatch instruments the call and delegates to the underlying store.