Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

consumer

package

Go to main page

Versions in this module

v2

v2.6.0

Feb 13, 2026

v2.5.0

Sep 9, 2024

v2.4.0

Jan 24, 2024

v2.3.0

Aug 1, 2023

v2.2.0

Jul 29, 2022

Changes in this version

+ const DefaultMaxRetryCount

+ const DefaultMaxRetryDelay

+ const DefaultMinRetryDelay

+ var ErrBadRequest = errors.New("bad client request")

+ var ErrBadResponse = errors.New("bad server response")

+ var ErrLostConnection = errors.New("remote server terminated connection unexpectedly")

+ var ErrMaxRetriesReached = errors.New("maximum number of connection retries reached")

+ var ErrNotFound = ErrNotOK

+ var ErrNotOK = errors.New("unknown issue when making HTTP request to Loggregator")

+ var KeepAlive = 25 * time.Second

+ type Consumer struct

+ func New(trafficControllerUrl string, tlsConfig *tls.Config, ...) *Consumer

+ func (c *Consumer) Close() error

+ func (c *Consumer) ContainerEnvelopes(appGuid, authToken string) ([]*events.Envelope, error)

+ func (c *Consumer) ContainerMetrics(appGuid string, authToken string) ([]*events.ContainerMetric, error)

+ func (c *Consumer) FilteredFirehose(subscriptionId string, authToken string, filter EnvelopeFilter) (<-chan *events.Envelope, <-chan error)

+ func (c *Consumer) Firehose(subscriptionId string, authToken string) (<-chan *events.Envelope, <-chan error)

+ func (c *Consumer) FirehoseWithoutReconnect(subscriptionId string, authToken string) (<-chan *events.Envelope, <-chan error)

+ func (c *Consumer) RecentLogs(appGuid string, authToken string) ([]*events.LogMessage, error)

+ func (c *Consumer) RefreshTokenFrom(tr TokenRefresher)

+ func (c *Consumer) SetDebugPrinter(debugPrinter DebugPrinter)

+ func (c *Consumer) SetIdleTimeout(idleTimeout time.Duration)

+ func (c *Consumer) SetMaxRetryCount(count int)

+ func (c *Consumer) SetMaxRetryDelay(d time.Duration)

+ func (c *Consumer) SetMinRetryDelay(d time.Duration)

+ func (c *Consumer) SetOnConnectCallback(cb func())

+ func (c *Consumer) SetRecentPathBuilder(b RecentPathBuilder)

+ func (c *Consumer) SetStreamPathBuilder(b StreamPathBuilder)

+ func (c *Consumer) Stream(appGuid string, authToken string) (outputChan <-chan *events.Envelope, errorChan <-chan error)

+ func (c *Consumer) StreamWithoutReconnect(appGuid string, authToken string) (<-chan *events.Envelope, <-chan error)

+ func (c *Consumer) TailingLogs(appGuid, authToken string) (<-chan *events.LogMessage, <-chan error)

+ func (c *Consumer) TailingLogsWithoutReconnect(appGuid string, authToken string) (<-chan *events.LogMessage, <-chan error)

+ type DebugPrinter interface

+ Print func(title, dump string)

+ type EnvelopeFilter int

+ const LogMessages

+ const Metrics

+ type FirehoseOption func(*firehose)

+ func WithEnvelopeFilter(filter EnvelopeFilter) FirehoseOption

+ func WithRetry(retry bool) FirehoseOption

+ type RecentPathBuilder func(trafficControllerUrl *url.URL, appGuid string, endpoint string) string

+ type StreamPathBuilder func(appGuid string) string

+ type TokenRefresher interface

+ RefreshAuthToken func() (token string, authError error)

Other modules containing this package

github.com/cloudfoundry/noaa