Documentation
¶
Index ¶
Constants ¶
View Source
const (
// DefaultSite is the default site of the Datadog intake to send data to
DefaultSite = "datadoghq.com"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIConfig ¶
type APIConfig struct {
// Key is the Datadog API key to associate your Agent's data with your organization.
// Create a new API key here: https://app.datadoghq.com/account/settings
// It can also be set through the `DD_API_KEY` environment variable.
Key string `mapstructure:"key"`
// Site is the site of the Datadog intake to send data to.
// It can also be set through the `DD_SITE` environment variable.
// The default value is "datadoghq.com".
Site string `mapstructure:"site"`
}
APIConfig defines the API configuration options
func (*APIConfig) GetCensoredKey ¶
GetCensoredKey returns the API key censored for logging purposes
type Config ¶
type Config struct {
config.ExporterSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
exporterhelper.TimeoutSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.
exporterhelper.QueueSettings `mapstructure:"sending_queue"`
exporterhelper.RetrySettings `mapstructure:"retry_on_failure"`
TagsConfig `mapstructure:",squash"`
// API defines the Datadog API configuration.
API APIConfig `mapstructure:"api"`
// Metrics defines the Metrics exporter specific configuration
Metrics MetricsConfig `mapstructure:"metrics"`
// Traces defines the Traces exporter specific configuration
Traces TracesConfig `mapstructure:"traces"`
// SendMetadata defines whether to send host metadata
// This is undocumented and only used for unit testing.
//
// This can't be disabled if `only_metadata` is true.
SendMetadata bool `mapstructure:"send_metadata"`
// OnlyMetadata defines whether to only send metadata
// This is useful for agent-collector setups, so that
// metadata about a host is sent to the backend even
// when telemetry data is reported via a different host.
//
// This flag is incompatible with disabling `send_metadata`
// or `use_resource_metadata`.
OnlyMetadata bool `mapstructure:"only_metadata"`
// UseResourceMetadata defines whether to use resource attributes
// for completing host metadata (such as the hostname or host tags).
//
// By default this is true: the first resource attribute getting to
// the exporter will be used for host metadata.
// Disable this in the Collector if you are using an agent-collector setup.
UseResourceMetadata bool `mapstructure:"use_resource_metadata"`
// contains filtered or unexported fields
}
Config defines configuration for the Datadog exporter.
func (*Config) OnceMetadata ¶
type HistogramConfig ¶ added in v0.36.0
type HistogramConfig struct {
// Mode for exporting histograms. Valid values are 'distributions', 'counters' or 'nobuckets'.
// - 'distributions' sends histograms as Datadog distributions (recommended).
// - 'counters' sends histograms as Datadog counts, one metric per bucket.
// - 'nobuckets' sends no bucket histogram metrics. .sum and .count metrics will still be sent
// if `send_count_sum_metrics` is enabled.
//
// The current default is 'distributions'.
Mode string `mapstructure:"mode"`
// SendCountSum states if the export should send .sum and .count metrics for histograms.
// The current default is false.
SendCountSum bool `mapstructure:"send_count_sum_metrics"`
}
HistogramConfig customizes export of OTLP Histograms.
type MetricsConfig ¶
type MetricsConfig struct {
// Quantiles states whether to report quantiles from summary metrics.
// By default, the minimum, maximum and average are reported.
Quantiles bool `mapstructure:"report_quantiles"`
// SendMonotonic states whether to report cumulative monotonic metrics as counters
// or gauges
SendMonotonic bool `mapstructure:"send_monotonic_counter"`
// DeltaTTL defines the time that previous points of a cumulative monotonic
// metric are kept in memory to calculate deltas
DeltaTTL int64 `mapstructure:"delta_ttl"`
// TCPAddr.Endpoint is the host of the Datadog intake server to send metrics to.
// It can also be set through the `DD_URL` environment variable.
// If unset, the value is obtained from the Site.
confignet.TCPAddr `mapstructure:",squash"`
ExporterConfig MetricsExporterConfig `mapstructure:",squash"`
// HistConfig defines the export of OTLP Histograms.
HistConfig HistogramConfig `mapstructure:"histograms"`
}
MetricsConfig defines the metrics exporter specific configuration options
type MetricsExporterConfig ¶ added in v0.18.0
type MetricsExporterConfig struct {
// ResourceAttributesAsTags, if set to true, will use the exporterhelper feature to transform all
// resource attributes into metric labels, which are then converted into tags
ResourceAttributesAsTags bool `mapstructure:"resource_attributes_as_tags"`
// InstrumentationLibraryMetadataAsTags, if set to true, adds the name and version of the
// instrumentation library that created a metric to the metric tags
InstrumentationLibraryMetadataAsTags bool `mapstructure:"instrumentation_library_metadata_as_tags"`
}
MetricsExporterConfig provides options for a user to customize the behavior of the metrics exporter
type TagsConfig ¶
type TagsConfig struct {
// Hostname is the host name for unified service tagging.
// It can also be set through the `DD_HOST` environment variable.
// If unset, it is determined automatically.
// See https://docs.datadoghq.com/agent/faq/how-datadog-agent-determines-the-hostname
// for more details.
Hostname string `mapstructure:"hostname"`
// Env is the environment for unified service tagging.
// It can also be set through the `DD_ENV` environment variable.
Env string `mapstructure:"env"`
// Service is the service for unified service tagging.
// It can also be set through the `DD_SERVICE` environment variable.
Service string `mapstructure:"service"`
// Version is the version for unified service tagging.
// It can also be set through the `DD_VERSION` environment variable.
Version string `mapstructure:"version"`
// EnvVarTags is the list of space-separated tags passed by the `DD_TAGS` environment variable
// Superseded by Tags if the latter is set.
// Should not be set in the user-provided config.
EnvVarTags string `mapstructure:"envvartags"`
// Tags is the list of default tags to add to every metric or trace.
Tags []string `mapstructure:"tags"`
}
TagsConfig defines the tag-related configuration It is embedded in the configuration
func (*TagsConfig) GetHostTags ¶
func (t *TagsConfig) GetHostTags() []string
GetHostTags gets the host tags extracted from the configuration
type TracesConfig ¶
type TracesConfig struct {
// TCPAddr.Endpoint is the host of the Datadog intake server to send traces to.
// It can also be set through the `DD_APM_URL` environment variable.
// If unset, the value is obtained from the Site.
confignet.TCPAddr `mapstructure:",squash"`
// SampleRate is the rate at which to sample this event. Default is 1,
// meaning no sampling. If you want to send one event out of every 250
// times Send() is called, you would specify 250 here.
SampleRate uint `mapstructure:"sample_rate"`
// ignored resources
// A blacklist of regular expressions can be provided to disable certain traces based on their resource name
// all entries must be surrounded by double quotes and separated by commas.
// ignore_resources: ["(GET|POST) /healthcheck"]
IgnoreResources []string `mapstructure:"ignore_resources"`
// SpanNameRemappings is the map of datadog span names and preferred name to map to. This can be used to
// automatically map Datadog Span Operation Names to an updated value. All entries should be key/value pairs.
// span_name_remappings:
// io.opentelemetry.javaagent.spring.client: spring.client
// instrumentation:express.server: express
// go.opentelemetry.io_contrib_instrumentation_net_http_otelhttp.client: http.client
SpanNameRemappings map[string]string `mapstructure:"span_name_remappings"`
}
TracesConfig defines the traces exporter specific configuration options
Source Files
Click to show internal directories.
Click to hide internal directories.