1 /* 2 * Copyright 2018 Google LLC 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google LLC nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 package com.google.api.gax.tracing; 31 32 import com.google.api.core.InternalApi; 33 import com.google.api.core.InternalExtensionOnly; 34 35 /** 36 * A factory to create new instances of {@link ApiTracer}s. 37 * 38 * <p>In general a single instance of an {@link ApiTracer} will correspond to a single logical 39 * operation. 40 * 41 * <p>For internal use only. google-cloud-java libraries should extend {@link BaseApiTracerFactory}. 42 */ 43 @InternalApi 44 @InternalExtensionOnly 45 public interface ApiTracerFactory { 46 /** The type of operation the {@link ApiTracer} is tracing. */ 47 enum OperationType { 48 Unary, 49 Batching, 50 LongRunning, 51 ServerStreaming, 52 ClientStreaming, 53 BidiStreaming 54 } 55 56 /** 57 * Create a new {@link ApiTracer} that will be a child of the current context. 58 * 59 * @param parent the parent of this tracer 60 * @param spanName the name of the new span 61 * @param operationType the type of operation that the tracer will trace 62 */ newTracer(ApiTracer parent, SpanName spanName, OperationType operationType)63 ApiTracer newTracer(ApiTracer parent, SpanName spanName, OperationType operationType); 64 } 65