Skip to content

Netflix/spectator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5c7eaaf · Aug 29, 2024
Oct 4, 2023
Jan 4, 2024
Aug 20, 2024
Feb 3, 2024
Aug 1, 2024
Jul 10, 2024
Nov 15, 2023
Oct 31, 2023
Aug 29, 2024
Aug 29, 2023
Apr 24, 2023
Jul 10, 2024
Sep 11, 2021
Jan 29, 2024
Oct 25, 2023
Jul 22, 2024
Jul 10, 2024
Jan 4, 2023
Sep 11, 2021
Apr 6, 2023
Aug 26, 2024
Jul 10, 2024
Jul 10, 2024
Jan 29, 2024
Jan 29, 2024
Jan 29, 2024
Jan 30, 2024
Feb 3, 2024
Apr 2, 2016
Aug 6, 2015
Jan 23, 2015
Oct 26, 2017
Dec 4, 2014
Dec 11, 2015
Jun 5, 2024
Jul 22, 2024
Aug 20, 2024
Feb 14, 2022
Feb 14, 2022
Jan 4, 2023

Repository files navigation

Snapshot Release Maven Central

Spectator

Simple library for instrumenting code to record dimensional time series.

Requirements

  • Java 8 or higher.
  • Java 7 or higher for spectator 0.27.x or earlier.

Documentation

Dependencies

To instrument your code you need to depend on the api library. This provides the minimal interfaces for you to code against and build test cases. The only dependency is slf4j.

com.netflix.spectator:spectator-api:${version}

If running at Netflix with the standard platform, see the Netflix Integration page on the wiki.

Instrumenting Code

Suppose we have a server and we want to keep track of:

  • Number of requests received with dimensions for breaking down by status code, country, and the exception type if the request fails in an unexpected way.
  • Latency for handling requests.
  • Summary of the response sizes.
  • Current number of active connections on the server.

Here is some sample code that does that:

// In the application initialization setup a registry
Registry registry = new DefaultRegistry();
Server s = new Server(registry);

public class Server {
  private final Registry registry;
  private final Id requestCountId;
  private final Timer requestLatency;
  private final DistributionSummary responseSizes;

  @Inject
  public Server(Registry registry) {
    this.registry = registry;

    // Create a base id for the request count. The id will get refined with
    // additional dimensions when we receive a request.
    requestCountId = registry.createId("server.requestCount");

    // Create a timer for tracking the latency. The reference can be held onto
    // to avoid additional lookup cost in critical paths.
    requestLatency = registry.timer("server.requestLatency");

    // Create a distribution summary meter for tracking the response sizes.
    responseSizes = registry.distributionSummary("server.responseSizes");

    // Gauge type that can be sampled. In this case it will invoke the
    // specified method via reflection to get the value. The registry will
    // keep a weak reference to the object passed in so that registration will
    // not prevent garbage collection of the server object.
    registry.methodValue("server.numConnections", this, "getNumConnections");
  }

  public Response handle(Request req) {
    final long s = System.nanoTime();
    requestLatency.recordRunnable(() -> {
      try {
        Response res = doSomething(req);

        // Update the counter id with dimensions based on the request. The
        // counter will then be looked up in the registry which should be
        // fairly cheap, such as lookup of id object in a ConcurrentHashMap.
        // However, it is more expensive than having a local variable set
        // to the counter.
        final Id cntId = requestCountId
          .withTag("country", req.country())
          .withTag("status", res.status());
        registry.counter(cntId).increment();

        responseSizes.record(res.body().size());

        return res;
      } catch (Exception e) {
        final Id cntId = requestCountId
          .withTag("country", req.country())
          .withTag("status", "exception")
          .withTag("error", e.getClass().getSimpleName());
        registry.counter(cntId).increment();
        throw e;
      }
    });
  }

  public int getNumConnections() {
    // however we determine the current number of connections on the server
  }
}