package
0.0.0-20191121140916-9649366ff4b2
Repository: https://github.com/chronosphereiox/m3.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

AddWarningHeaders adds any warning headers present in the result's metadata.
AllowedServices returns the list of valid M3 services.
CloseWatcher watches for CloseNotify and context timeout.
IsAllowedService returns whether a service name is a valid M3 service.
NewFetchOptionsBuilder returns a new fetch options builder.
NewSearchHandler returns a new instance of handler.
NewServiceOptions returns a ServiceOptions based on the provided values.
ParseDuration parses a duration HTTP parameter.
ParseLimit parses request limit from either header or query string.
ParseLookbackDuration parses a lookback duration for an HTTP request.
ParseStep parses the step duration for an HTTP request.
WithDefaultServiceEnvironment returns the default service environment.
WithDefaultServiceZone returns the default service zone.

# Constants

DefaultServiceEnvironment is the default service ID environment.
DefaultServiceZone is the default service ID zone.
DeprecatedHeader is the M3 deprecated header.
HeaderClusterEnvironmentName is the header used to specify the environment name.
HeaderClusterZoneName is the header used to specify the zone name.
HeaderDryRun is the header used to specify whether this should be a dry run.
HeaderForce is the header used to specify whether this should be a forced operation.
HeaderKey is the key which headers will be added to in the request context.
LimitHeader is the header added when returned series are limited.
LimitHeaderSeriesLimitApplied is the header applied when fetch results are maxed.
LimitMaxSeriesHeader is the M3 limit timeseries header that limits the number of time series returned by each storage node.
LookbackParam is the lookback parameter.
M3AggregatorServiceName is the service name for M3Aggregator.
M3CoordinatorServiceName is the service name for M3Coordinator.
M3DBServiceName is the service name for M3DB.
MetricsStoragePolicyHeader specifies the resolution and retention of metrics being written or read.
MetricsTypeHeader sets the write or read metrics type to restrict metrics to.
RetryHeader is the M3 retry header to display when it is safe to retry.
RoutePrefixExperimenta is the experimental prefix for all coordinator routes.
RoutePrefixV1 is the v1 prefix for all coordinator routes.
SearchHTTPMethod is the HTTP method used with this resource.
SearchURL is the url to search for metric ids.
ServedByHeader is the M3 query storage execution breakdown.
StepParam is the step parameter.
UnaggregatedStoragePolicy specifies the unaggregated storage policy.
WarningsHeader is the M3 warnings header when to display a warning to a user.

# Structs

FetchOptionsBuilderOptions provides options to use when creating a fetch options builder.
M3AggServiceOptions contains the service options that are specific to the M3Agg service.
SearchHandler represents a handler for the search endpoint.
ServiceNameAndDefaults is the params used when identifying a service and it's service option defaults.
ServiceOptions are the options for Service.

# Interfaces

FetchOptionsBuilder builds fetch options based on a request and default config.

# Type aliases

HeaderKeyType is the type for the header key.
ServiceOptionsDefault is a default to apply to service options.