Interface MetricReader

All Known Implementing Classes:
OtlpMetricExporter
public interface MetricReader
Something that reads Metrics periodically and sends them somewhere -- the OTLP exporter. Installed by the generated entry point of a build that enables OpenTelemetry, and referenced nowhere else, so a build that does not leaves the exporter out of the binary.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    open(Config config)
    Reads the configuration and starts.
    void
    shutdown(int timeoutMillis)
    Sends what is left and stops, waiting up to timeoutMillis.

  • Method Details

    • open

      boolean open(Config config) throws IOException
      Reads the configuration and starts. Answers false when the deployment has metrics turned off, in which case nothing is started; one that throws must leave nothing started either, and changes nothing it was already doing -- the server does not shut down a reader whose open() failed.
      Throws:
      IOException

    • shutdown

      void shutdown(int timeoutMillis)
      Sends what is left and stops, waiting up to timeoutMillis.