package
3.7.2+incompatible
Repository: https://github.com/datadog/datadog-go.git
Documentation: pkg.go.dev

# README

Overview

Package statsd provides a Go dogstatsd client. Dogstatsd extends Statsd, adding tags and histograms.

# Functions

CloneWithExtraOptions create a new Client with extra options.
New returns a pointer to a new Client given an addr in the format "hostname:port" or "unix:///path/to/socket".
NewBuffered returns a Client that buffers its output and sends it in chunks.
NewEvent creates a new event with the given title and text.
NewServiceCheck creates a new serviceCheck with the given name and status.
NewWithWriter creates a new Client with given writer.
WithAggregationInterval set the aggregation interval.
WithBufferFlushInterval sets the BufferFlushInterval option.
WithBufferPoolSize sets the BufferPoolSize option.
WithBufferShardCount sets the BufferShardCount option.
WithChannelMode will use channel to receive metrics.
WithChannelModeBufferSize the channel buffer size when using "drop mode".
WithClientSideAggregation enables client side aggregation.
WithMaxBytesPerPayload sets the MaxBytesPerPayload option.
WithMaxMessagesPerPayload sets the MaxMessagesPerPayload option.
WithMutexModeMode will use mutex to receive metrics.
WithNamespace sets the Namespace option.
WithoutClientSideAggregation disables client side aggregation.
WithoutTelemetry disables the telemetry.
WithSenderQueueSize sets the SenderQueueSize option.
WithTags sets the Tags option.
WithWriteTimeoutUDS sets the WriteTimeoutUDS option.

# Constants

No description provided by the author
Critical is the "critical" ServiceCheck status.
DefaultMaxAgentPayloadSize is the default maximum payload size the agent can receive.
DefaultUDPBufferPoolSize is the default size of the buffer pool for UDP clients.
DefaultUDSBufferPoolSize is the default size of the buffer pool for UDS clients.
ErrNoClient is returned if statsd reporting methods are invoked on a nil client.
Error is the "error" AlertType for events.
Info is the "info" AlertType for events.
Low is the "low" Priority for events.
MaxUDPPayloadSize defines the maximum payload size for a UDP datagram.
No description provided by the author
Normal is the "normal" Priority for events.
Ok is the "ok" ServiceCheck status.
OptimalUDPPayloadSize defines the optimal payload size for a UDP datagram, 1432 bytes is optimal for regular networks with an MTU of 1500 so datagrams don't get fragmented.
Success is the "success" AlertType for events.
TelemetryInterval is the interval at which telemetry will be sent by the client.
UnixAddressPrefix holds the prefix to use to enable Unix Domain Socket traffic instead of UDP.
Unknown is the "unknown" ServiceCheck status.
Warn is the "warning" ServiceCheck status.
Warning is the "warning" AlertType for events.

# Variables

DefaultAggregation.
DefaultAggregationFlushInterval is the default interval for the aggregator to flush metrics.
DefaultBufferFlushInterval is the default value for the BufferFlushInterval option.
DefaultBufferPoolSize is the default value for the DefaultBufferPoolSize option.
DefaultBufferShardCount is the default value for the BufferShardCount option.
DefaultChannelModeBufferSize is the default size of the channel holding incoming metrics.
DefaultMaxBytesPerPayload is the default value for the MaxBytesPerPayload option.
DefaultMaxMessagesPerPayload is the default value for the MaxMessagesPerPayload option.
DefaultNamespace is the default value for the Namespace option.
DefaultReceivingingMode is the default behavior when sending metrics.
DefaultSenderQueueSize is the default value for the DefaultSenderQueueSize option.
DefaultTags is the default value for the Tags option.
DefaultTelemetry is the default value for the Telemetry option.
DefaultWriteTimeoutUDS is the default value for the WriteTimeoutUDS option.

# Structs

A Client is a handle for sending messages to dogstatsd.
ClientMetrics contains metrics about the client.
An Event is an object that can be posted to your DataDog event stream.
NoOpClient is a statsd client that does nothing.
Options contains the configuration options for a client.
SenderMetrics contains metrics about the health of the sender.
A ServiceCheck is an object that contains status of DataDog service check.

# Interfaces

ClientInterface is an interface that exposes the common client functions for the purpose of being able to provide a no-op client or even mocking.

# Type aliases

EventAlertType is the alert type for events.
EventPriority is the event priority for events.
Option is a client option.
No description provided by the author
ServiceCheckStatus support.