io.opentelemetry.instrumentation.quartz.v2_0.QuartzTelemetry Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of opentelemetry-quartz-2.0 Show documentation

Instrumentation of Java libraries using OpenTelemetry.

There is a newer version: 2.8.0-alpha

Show newest version

/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.instrumentation.quartz.v2_0;

import io.opentelemetry.api.OpenTelemetry;
import org.quartz.JobKey;
import org.quartz.JobListener;
import org.quartz.Matcher;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.impl.matchers.EverythingMatcher;

/** Entrypoint for telemetry instrumentation of Quartz jobs. */
public final class QuartzTelemetry {

  /** Returns a new {@link QuartzTelemetry} configured with the given {@link OpenTelemetry}. */
  public static QuartzTelemetry create(OpenTelemetry openTelemetry) {
    return builder(openTelemetry).build();
  }

  /**
   * Returns a new {@link QuartzTelemetryBuilder} configured with the given {@link OpenTelemetry}.
   */
  public static QuartzTelemetryBuilder builder(OpenTelemetry openTelemetry) {
    return new QuartzTelemetryBuilder(openTelemetry);
  }

  QuartzTelemetry(JobListener jobListener) {
    this.jobListener = jobListener;
  }

  private final JobListener jobListener;

  /**
   * Configures the {@link Scheduler} to enable tracing of jobs.
   *
   * NOTE: If there are job listeners already registered on the Scheduler that
   * may throw exceptions, tracing will be broken. It's important to call this as soon as possible
   * to avoid being affected by other bad listeners, or otherwise ensure listeners you register do
   * not throw exceptions.
   */
  public void configure(Scheduler scheduler) {
    try {
      for (JobListener listener : scheduler.getListenerManager().getJobListeners()) {
        if (listener instanceof TracingJobListener) {
          return;
        }
      }
    } catch (SchedulerException e) {
      // Ignore
    }
    try {
      // We must pass a matcher to work around a bug in Quartz 2.0.0. It's unlikely anyone uses
      // a version before 2.0.2, but it makes muzzle simple.
      @SuppressWarnings({"rawtypes", "unchecked"})
      Matcher[] matchers = new Matcher[] {EverythingMatcher.allJobs()};
      scheduler.getListenerManager().addJobListener(jobListener, matchers);
    } catch (SchedulerException e) {
      throw new IllegalStateException("Could not add JobListener to Scheduler", e);
    }
  }
}