AtlasConfig (spectator-reg-atlas 1.5.4 API)

All Superinterfaces:

com.netflix.spectator.api.RegistryConfig
```
public interface AtlasConfig
extends com.netflix.spectator.api.RegistryConfig
```
Configuration for Atlas registry.

Method Summary

All Methods Instance Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default boolean`	`autoStart()` Returns true if the registry should automatically start the background reporting threads in the constructor.
`default int`	`batchSize()` Returns the number of measurements per request to use for the backend.
`default Map<String,String>`	`commonTags()` Returns the common tags to apply to all metrics reported to Atlas.
`default Duration`	`configRefreshFrequency()` Returns the frequency for refreshing config settings from the LWC service.
`default Duration`	`configTTL()` Returns the TTL for subscriptions from the LWC service.
`default String`	`configUri()` Returns the URI for the Atlas LWC endpoint to retrieve current subscriptions.
`default Duration`	`connectTimeout()` Returns the connection timeout for requests to the backend.
`default com.netflix.spectator.api.Registry`	`debugRegistry()` Returns a registry to use for recording metrics about the behavior of the AtlasRegistry.
`default boolean`	`enabled()` Returns true if publishing to Atlas is enabled.
`default String`	`evalUri()` Returns the URI for the Atlas LWC endpoint to evaluate the data for a suscription.
`default long`	`initialPollingDelay(com.netflix.spectator.api.Clock clock, long stepSize)` Avoid collecting right on boundaries to minimize transitions on step longs during a collection.
`default boolean`	`lwcEnabled()` Returns true if streaming to Atlas LWC is enabled.
`default boolean`	`lwcIgnorePublishStep()` Returns true if expressions with the same step size as Atlas publishing should be ignored for streaming.
`default Duration`	`lwcStep()` Returns the step size (reporting frequency) to use for streaming to Atlas LWC.
`default Duration`	`meterTTL()` Returns the TTL for meters that do not have any activity.
`default int`	`numThreads()` Returns the number of threads to use with the scheduler.
`default Publisher`	`publisher()` Alpha: this method is experimental and may change or be completely removed with no notice.
`default Duration`	`readTimeout()` Returns the read timeout for requests to the backend.
`default RollupPolicy`	`rollupPolicy()` Returns a rollup policy that will be applied to the measurements before sending to Atlas.
`default Duration`	`step()` Returns the step size (reporting frequency) to use.
`default String`	`uri()` Returns the URI for the Atlas backend.
`default String`	`validTagCharacters()` Returns a pattern indicating the valid characters for a tag key or value.
`default Map<String,String>`	`validTagValueCharacters()` Deprecated. This method is no longer used internally.

Methods inherited from interface com.netflix.spectator.api.RegistryConfig
gaugePollingFrequency, get, maxNumberOfMeters, propagateWarnings

- Method Detail
  - step
```
default Duration step()
```
    Returns the step size (reporting frequency) to use. The default is 1 minute.
  - meterTTL
```
default Duration meterTTL()
```
    Returns the TTL for meters that do not have any activity. After this period the meter will be considered expired and will not get reported. Default is 15 minutes.
  - enabled
```
default boolean enabled()
```
    Returns true if publishing to Atlas is enabled. Default is true.
  - autoStart
```
default boolean autoStart()
```
    Returns true if the registry should automatically start the background reporting threads in the constructor. When using DI systems this can be used to automatically start the registry when it is constructed. Otherwise the AtlasRegistry.start() method will need to be called explicitly. Default is false.
  - numThreads
```
default int numThreads()
```
    Returns the number of threads to use with the scheduler. The default is 4 threads.
  - uri
```
default String uri()
```
    Returns the URI for the Atlas backend. The default is http://localhost:7101/api/v1/publish.
  - lwcStep
```
default Duration lwcStep()
```
    Returns the step size (reporting frequency) to use for streaming to Atlas LWC. The default is 5s. This is the highest resolution that would be supported for getting an on-demand stream of the data. It must be less than or equal to the Atlas step (step()) and the Atlas step should be an even multiple of this value.
  - lwcEnabled
```
default boolean lwcEnabled()
```
    Returns true if streaming to Atlas LWC is enabled. Default is false.
  - lwcIgnorePublishStep
```
default boolean lwcIgnorePublishStep()
```
    Returns true if expressions with the same step size as Atlas publishing should be ignored for streaming. This is used for cases where data being published to Atlas is also sent into streaming from the backend. Default is true.
  - configRefreshFrequency
```
default Duration configRefreshFrequency()
```
    Returns the frequency for refreshing config settings from the LWC service.
  - configTTL
```
default Duration configTTL()
```
    Returns the TTL for subscriptions from the LWC service.
  - configUri
```
default String configUri()
```
    Returns the URI for the Atlas LWC endpoint to retrieve current subscriptions. The default is http://localhost:7101/lwc/api/v1/expressions/local-dev.
  - evalUri
```
default String evalUri()
```
    Returns the URI for the Atlas LWC endpoint to evaluate the data for a suscription. The default is http://localhost:7101/lwc/api/v1/evaluate.
  - connectTimeout
```
default Duration connectTimeout()
```
    Returns the connection timeout for requests to the backend. The default is 1 second.
  - readTimeout
```
default Duration readTimeout()
```
    Returns the read timeout for requests to the backend. The default is 10 seconds.
  - batchSize
```
default int batchSize()
```
    Returns the number of measurements per request to use for the backend. If more measurements are found, then multiple requests will be made. The default is 10,000.
  - commonTags
```
default Map<String,String> commonTags()
```
    Returns the common tags to apply to all metrics reported to Atlas. The returned tags must only use valid characters as defined by validTagCharacters(). The default is an empty map.
  - validTagCharacters
```
default String validTagCharacters()
```
    Returns a pattern indicating the valid characters for a tag key or value. The default is -._A-Za-z0-9~^.
  - validTagValueCharacters
```
@Deprecated
default Map<String,String> validTagValueCharacters()
```
    Deprecated. This method is no longer used internally.
    
    Returns a map from tag key to a pattern indicating the valid characters for the values of that key. The default is an empty map.
  - debugRegistry
```
default com.netflix.spectator.api.Registry debugRegistry()
```
    Returns a registry to use for recording metrics about the behavior of the AtlasRegistry. By default it will return null and the metrics will be reported to itself. In some cases it is useful to customize this for debugging so that the metrics for the behavior of AtlasRegistry will have a different failure mode than AtlasRegistry.
  - rollupPolicy
```
default RollupPolicy rollupPolicy()
```
    Returns a rollup policy that will be applied to the measurements before sending to Atlas. The policy will not be applied to data going to the streaming path. Default is a no-op policy.
  - initialPollingDelay
```
default long initialPollingDelay(com.netflix.spectator.api.Clock clock,
                                 long stepSize)
```
    Avoid collecting right on boundaries to minimize transitions on step longs during a collection. By default it will randomly distribute across the middle of the step interval.
  - publisher
```
default Publisher publisher()
```
    Alpha: this method is experimental and may change or be completely removed with no notice. Override to provide a custom publisher for sending data to Atlas. The intended use is for some cases where it is desirable to send the payload somewhere else or to use an alternate client. If the return value is null, then the data will be sent via the normal path.

Interface AtlasConfig

Method Summary

Methods inherited from interface com.netflix.spectator.api.RegistryConfig

Method Detail

step

meterTTL

enabled

autoStart

numThreads

uri

lwcStep

lwcEnabled

lwcIgnorePublishStep

configRefreshFrequency

configTTL

configUri

evalUri

connectTimeout

readTimeout

batchSize

commonTags

validTagCharacters

validTagValueCharacters

debugRegistry

rollupPolicy

initialPollingDelay

publisher