package
0.0.0-20190918193452-3ce1eab57797
Repository: https://github.com/cloudfoundry/loggregator.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

NewClient initializes a new Client and opens a gRPC connection to the given address.
NewCounter initializes a new Counter metric with a given name, sourceID and MetricOptions.
NewGauge initializes a new Gauge metric with a given name, unit, sourceID and MetricOptions.
WithDeployment is a ClientOption that will set a deployment, job and index tab on every envelope sent to the IngressClient.
WithGRPCDialOptions is a ClientOption that will set the gRPC dial options on the Clients IngressClient.
WithOrigin is a ClientOption that will set an origin tag to be added to every envelope sent to the IngressClient.
WithPulseInterval is a ClientOption will set the rate at which each metric will be sent to the IngressClient.
WithSourceID is a ClientOption that will set the SourceID to be set on every envelope sent to the IngressClient.
WithTags is a MetricOption that is used to set tags on the metrics V2 Envelope when created.
WithVersion is a MetricOption that can be used to set the metric version.

# Structs

Client is used to initialize and emit metrics on a given pulse interval.
Counter stores data about a counter metric to be used by the metric emitter Client.
Gauge stores data about a gauge metric to be used by the metric emitter Client.
Tagged is a struct that is embedded into metrics to give them common functionality around tags.

# Type aliases

ClientOption is a function that can be passed into the NewClient for optional configuration on the client.
MetricOption is a function that can be passed to a metric on initialization that configures the metric.