com.netflix.spectator.api

Class Spectator

java.lang.Object

com.netflix.spectator.api.Spectator

public final class Spectator
extends Object

Static factory used to access the main global registry.

Method Summary

Modifier and Type	Method and Description
static CompositeRegistry	globalRegistry() Returns the global composite registry.
static ExtendedRegistry	registry() Deprecated. Use injection or globalRegistry() instead. This method is scheduled for removal in a future release.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

registry

@Deprecated
public static ExtendedRegistry registry()

Deprecated. Use injection or globalRegistry() instead. This method is scheduled for removal in a future release.

Returns the global registry.

globalRegistry

public static CompositeRegistry globalRegistry()

Returns the global composite registry. This method can be used for use-cases where it is necessary to get a static reference to a registry. It will not do anything unless other registries are added. Example:

 class Main {
   public static void main(String[] args) {
     // This is the preferred usage and works well with DI libraries like guice. Setup a
     // registry and pass it in as needed.
     Registry registry = new DefaultRegistry();
     (new Example1(registry)).start();

     // If it is desirable to get data from things using the global registry, then the
     // registry for the application can be added to the global context.
     Spectator.globalRegistry().add(registry);
     Example2 ex2 = new Example2();
     ex2.start();

     // If the lifecycle is not the same as the jvm, then the registry should be removed
     // when shutting down.
     ex2.onShutdown(() -> Spectator.globalRegistry().remove(registry));
   }
 }

 class Example1 {
   private final Counter c;

   Example1(Registry registry) {
     c = registry.counter("example1");
   }
   ...
 }

 class Example2 {
   private final Counter c;

   Example2() {
     c = Spectator.globalRegistry().counter("example1");
   }
   ...
 }