Documentation
¶
Index ¶
Constants ¶
View Source
const ( // Handler checks for write message size limits // https://github.com/grafana/mimir/blob/1ff367ef58987cd1941de03a8d6923fde82dfdd3/pkg/distributor/push.go#L92-L92 MimirDistributorMaxWriteMessageSizeError = "err-mimir-distributor-max-write-message-size" MimirDistributorMaxWriteRequestDataItemSizeError = "err-mimir-distributor-max-write-request-data-item-size" // Distributor.prePushValidationMiddleware calls: 1. validateLabels, 2. validateSamples, 3. validateHistograms, // 4. validateExamplars, 5. cleanAndValidateMetadata, then 6. checks for ingestion rate limits // 1. validateLabel errors // https://github.com/grafana/mimir/blob/1ff367ef58987cd1941de03a8d6923fde82dfdd3/pkg/distributor/validate.go#L402-L402 MimirInvalidMetricNameError = "err-mimir-metric-name-invalid" MimirMaxLabelNamesPerInfoSeriesError = "err-mimir-max-label-names-per-info-series" MimirMaxLabelNamesPerSeriesError = "err-mimir-max-label-names-per-series" MimirMissingMetricNameError = "err-mimir-missing-metric-name" MimirSeriesInvalidLabelError = "err-mimir-label-invalid" MimirSeriesInvalidLabelValueError = "err-mimir-label-value-invalid" MimirSeriesLabelNameTooLongError = "err-mimir-label-name-too-long" MimirSeriesLabelValueTooLongError = "err-mimir-label-value-too-long" MimirSeriesWithDuplicateLabelNamesError = "err-mimir-duplicate-label-names" // 2. validateSamples errors MimirSampleTooFarInFutureError = "err-mimir-too-far-in-future" MimirSampleTooFarInPastError = "err-mimir-too-far-in-past" // 3. validateHistograms MimirInvalidSchemaNativeHistogramError = "err-mimir-invalid-native-histogram-schema" MimirMaxNativeHistogramBucketsError = "err-mimir-max-native-histogram-buckets" MimirNotReducibleNativeHistogramError = "err-mimir-not-reducible-native-histogram" // 4. validateExemplars MimirExemplarLabelsMissingError = "err-mimir-exemplar-labels-missing" MimirExemplarLabelsTooLongError = "err-mimir-exemplar-labels-too-long" MimirExemplarTimestampInvalidError = "err-mimir-exemplar-timestamp-invalid" // 5. cleanAndValidateMetadata errors // https://github.com/grafana/mimir/blob/1ff367ef58987cd1941de03a8d6923fde82dfdd3/pkg/distributor/validate.go#L491-L491 MimirMetricMetadataMetricNameTooLongError = "err-mimir-metric-name-too-long" MimirMetricMetadataMissingMetricNameError = "err-mimir-metadata-missing-metric-name" MimirMetricMetadataUnitTooLongError = "err-mimir-unit-too-long" // 6. ingestion rate limited error // https://github.com/grafana/mimir/blob/1ff367ef58987cd1941de03a8d6923fde82dfdd3/pkg/distributor/distributor.go#L1317-L1317 // https://github.com/grafana/mimir/blob/1ff367ef58987cd1941de03a8d6923fde82dfdd3/pkg/distributor/distributor.go#L1324-L1324 MimirIngestionRateLimitedError = "err-mimir-tenant-max-ingestion-rate" // Ingester.PushWithCleanup errors // https://github.com/grafana/mimir/blob/1ff367ef58987cd1941de03a8d6923fde82dfdd3/pkg/ingester/ingester.go#L1254-L1254 MimirExemplarSeriesMissingError = "err-mimir-exemplar-series-missing" MimirExemplarTooFarInFutureError = "err-mimir-exemplar-too-far-in-future" MimirExemplarTooFarInPastError = "err-mimir-exemplar-too-far-in-past" MimirMaxMetadataPerMetricError = "err-mimir-max-metadata-per-metric" MimirMaxMetadataPerUserError = "err-mimir-max-metadata-per-user" MimirMaxSeriesPerMetricError = "err-mimir-max-series-per-metric" MimirMaxSeriesPerUserError = "err-mimir-max-series-per-user" MimirNativeHistogramCountMismatchError = "err-mimir-native-histogram-count-mismatch" MimirNativeHistogramCountNotBigEnoughError = "err-mimir-native-histogram-count-not-big-enough" MimirNativeHistogramNegativeBucketCountError = "err-mimir-native-histogram-negative-bucket-count" MimirNativeHistogramOOODisabledError = "err-mimir-native-histogram-ooo-disabled" MimirNativeHistogramSpanNegativeOffsetError = "err-mimir-native-histogram-span-negative-offset" MimirNativeHistogramSpansBucketsMismatchError = "err-mimir-native-histogram-spans-buckets-mismatch" MimirSampleDuplicateTimestampError = "err-mimir-sample-duplicate-timestamp" MimirSampleOutOfOrderError = "err-mimir-sample-out-of-order" MimirSampleTimestampTooOldError = "err-mimir-sample-timestamp-too-old" MimirTooManyHAClustersError = "err-mimir-tenant-too-many-ha-clusters" // Best effort error messages PrometheusDuplicateTimestampError = "duplicate sample for timestamp" // returned in some cases when multiple org IDs are present in the request MimirErrTooManyOrgIDs = "multiple org IDs present" )
View Source
const RemoteWriteEndpoint = "/api/v1/write"
Variables ¶
View Source
var ( // Unexpected, 500-like write errors. ErrUnexpectedWriteFailure = errors.New("failed to write time series") // Expected, user-level write errors like trying to write an invalid series. ErrRejectedWrite = errors.New("series was rejected") ErrBadFrame = errors.New("failed to read dataframe") ErrDatasourceForbidden = errors.New("failed to authorize in datasource") ErrConnectionFailure = errors.New("failed to connect to remote write endpoint") // IgnoredErrors don't cause the Write to fail, but are still logged. IgnoredErrors = []string{ MimirSampleDuplicateTimestampError, PrometheusDuplicateTimestampError, } // ExpectedErrors are user-level write errors like trying to write an invalid series. ExpectedErrors = []string{ MimirDistributorMaxWriteMessageSizeError, MimirDistributorMaxWriteRequestDataItemSizeError, MimirExemplarLabelsMissingError, MimirExemplarLabelsTooLongError, MimirExemplarSeriesMissingError, MimirExemplarTimestampInvalidError, MimirExemplarTooFarInFutureError, MimirExemplarTooFarInPastError, MimirIngestionRateLimitedError, MimirInvalidMetricNameError, MimirInvalidSchemaNativeHistogramError, MimirMaxLabelNamesPerInfoSeriesError, MimirMaxLabelNamesPerSeriesError, MimirMaxMetadataPerMetricError, MimirMaxMetadataPerUserError, MimirMaxNativeHistogramBucketsError, MimirMaxSeriesPerMetricError, MimirMaxSeriesPerUserError, MimirMetricMetadataMetricNameTooLongError, MimirMetricMetadataMissingMetricNameError, MimirMetricMetadataUnitTooLongError, MimirMissingMetricNameError, MimirNativeHistogramCountMismatchError, MimirNativeHistogramCountNotBigEnoughError, MimirNativeHistogramNegativeBucketCountError, MimirNativeHistogramOOODisabledError, MimirNativeHistogramSpanNegativeOffsetError, MimirNativeHistogramSpansBucketsMismatchError, MimirNotReducibleNativeHistogramError, MimirSampleOutOfOrderError, MimirSampleTimestampTooOldError, MimirSampleTooFarInFutureError, MimirSampleTooFarInPastError, MimirSeriesInvalidLabelError, MimirSeriesInvalidLabelValueError, MimirSeriesLabelNameTooLongError, MimirSeriesLabelValueTooLongError, MimirSeriesWithDuplicateLabelNamesError, MimirTooManyHAClustersError, } )
Functions ¶
This section is empty.
Types ¶
type DatasourceWriter ¶
type DatasourceWriter struct {
// contains filtered or unexported fields
}
func NewDatasourceWriter ¶
func NewDatasourceWriter( cfg DatasourceWriterConfig, datasources datasources.DataSourceService, httpClientProvider HttpClientProvider, pluginContextProvider PluginContextProvider, clock clock.Clock, l log.Logger, metrics *metrics.RemoteWriter, ) *DatasourceWriter
type DatasourceWriterConfig ¶
type DatasourceWriterConfig struct {
// Timeout is the maximum time to wait for a remote write to succeed.
Timeout time.Duration
// DetaultDatasourceUID is the data source used if no data source is specified.
// This exists to cater for upgrading from old versions of Grafana, where rule
// definitions may not have a target data source specified.
DefaultDatasourceUID string
// CustomHeaders is a map of optional custom HTTP headers
// to include in recording rule write requests.
CustomHeaders map[string]string
}
type FakeWriter ¶
type HttpClientProvider ¶
type HttpClientProvider interface {
New(options ...httpclient.Options) (*http.Client, error)
}
type PluginContextProvider ¶
type PluginContextProvider interface {
GetWithDataSource(ctx context.Context, pluginID string, user identity.Requester, ds *datasources.DataSource) (backend.PluginContext, error)
}
type Point ¶
Point is a logical representation of a single point in time for a Prometheus time series.
type PrometheusWriter ¶
type PrometheusWriter struct {
// contains filtered or unexported fields
}
func NewPrometheusWriter ¶
func NewPrometheusWriter( cfg PrometheusWriterConfig, httpClientProvider HttpClientProvider, clock clock.Clock, l log.Logger, metrics *metrics.RemoteWriter, ) (*PrometheusWriter, error)
type PrometheusWriterConfig ¶
type PrometheusWriterConfig struct {
URL string
HTTPOptions httpclient.Options
Timeout time.Duration
BackendType backendType
}
type TestRemoteWriteTarget ¶
type TestRemoteWriteTarget struct {
RequestsCount int
LastRequestBody string
LastHeaders http.Header
ExpectedPath string
// contains filtered or unexported fields
}
func NewTestRemoteWriteTarget ¶
func NewTestRemoteWriteTarget(t *testing.T) *TestRemoteWriteTarget
func (*TestRemoteWriteTarget) ClientSettings ¶
func (s *TestRemoteWriteTarget) ClientSettings() setting.RecordingRuleSettings
func (*TestRemoteWriteTarget) Close ¶
func (s *TestRemoteWriteTarget) Close()
func (*TestRemoteWriteTarget) DatasourceURL ¶
func (s *TestRemoteWriteTarget) DatasourceURL() string
func (*TestRemoteWriteTarget) Reset ¶
func (s *TestRemoteWriteTarget) Reset()
Reset resets all tracked requests and counters.
Click to show internal directories.
Click to hide internal directories.