com.google.cloud.opentelemetry.trace.TraceExporter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of exporter-trace Show documentation
Cloud Trace Exporter for OpenTelemetry
There is a newer version: 0.33.0
/*
 * Copyright 2023 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.cloud.opentelemetry.trace;

import com.google.cloud.ServiceOptions;
import com.google.common.base.Suppliers;
import io.opentelemetry.sdk.common.CompletableResultCode;
import io.opentelemetry.sdk.trace.data.SpanData;
import io.opentelemetry.sdk.trace.export.SpanExporter;
import java.io.IOException;
import java.util.Collection;
import java.util.function.Supplier;
import javax.annotation.Nonnull;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class TraceExporter implements SpanExporter {

  private static final Logger logger = LoggerFactory.getLogger(TraceExporter.class);

  private final Supplier internalTraceExporterSupplier;

  private TraceExporter(TraceConfiguration configuration) {
    this.internalTraceExporterSupplier =
        Suppliers.memoize(
            () -> {
              try {
                return InternalTraceExporter.createWithConfiguration(configuration);
              } catch (IOException e) {
                logger.warn(
                    "Unable to initialize Google Cloud TraceExporter. Export operation failed, switching to NoopSpanExporter.",
                    e);
                return new NoopSpanExporter();
              }
            });
  }

  /**
   * Method that generates an instance of {@link TraceExporter} using a minimally configured {@link
   * TraceConfiguration} object that requires no input from the user. Since no project ID is
   * specified, default project ID is used instead. See {@link ServiceOptions#getDefaultProjectId()}
   * for details.
   *
   * This method defers the initialization of an actual {@link TraceExporter} to a point when it
   * is actually needed - which is when the spans need to be exported. As a result, while this
   * method does not throw any exception, an exception may still be thrown during the attempt to
   * generate the actual {@link TraceExporter}.
   *
   * @return A configured instance of {@link TraceExporter} which gets initialized lazily once
   *     {@link TraceExporter#export(Collection)} is called.
   */
  public static SpanExporter createWithDefaultConfiguration() {
    return new TraceExporter(TraceConfiguration.builder().build());
  }

  /**
   * Method that generates an instance of {@link TraceExporter} using a {@link TraceConfiguration}
   * that allows the user to provide custom configuration for Traces.
   *
   * This method defers the initialization of an actual {@link TraceExporter} to a point when it
   * is actually needed - which is when the spans need to be exported. As a result, while this
   * method does not throw any exception, an exception may still be thrown during the attempt to
   * generate the actual {@link TraceExporter}.
   *
   * @param configuration The {@link TraceConfiguration} object that determines the user preferences
   *     for trace.
   * @return An instance of {@link TraceExporter} as a {@link SpanExporter} object
   */
  public static SpanExporter createWithConfiguration(TraceConfiguration configuration) {
    return new TraceExporter(configuration);
  }

  @Override
  public CompletableResultCode flush() {
    return internalTraceExporterSupplier.get().flush();
  }

  @Override
  public CompletableResultCode export(@Nonnull Collection spanDataList) {
    return internalTraceExporterSupplier.get().export(spanDataList);
  }

  @Override
  public CompletableResultCode shutdown() {
    return internalTraceExporterSupplier.get().shutdown();
  }
}