Class TraceServiceClient (2.1.13)

Version 2.1.13

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.7
• 2.2.0
• 2.1.13

public class TraceServiceClient implements BackgroundResource

Service Description: This file describes an API for collecting and viewing traces and spans within a trace. A Trace is a collection of spans corresponding to a single operation or set of operations for an application. A span is an individual timed event which forms a node of the trace tree. A single trace may contain span(s) from multiple services.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   List<Span> spans = new ArrayList<>();
   traceServiceClient.batchWriteSpans(name, spans);
 }
 

Note: close() needs to be called on the TraceServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of TraceServiceSettings to create(). For example:

To customize credentials:

 TraceServiceSettings traceServiceSettings =
     TraceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TraceServiceClient traceServiceClient = TraceServiceClient.create(traceServiceSettings);
 

To customize the endpoint:

 TraceServiceSettings traceServiceSettings =
     TraceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TraceServiceClient traceServiceClient = TraceServiceClient.create(traceServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > TraceServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final TraceServiceClient create()

Constructs an instance of TraceServiceClient with default settings.

Returns
Type	Description
TraceServiceClient

Exceptions
Type	Description
IOException

create(TraceServiceSettings settings)

public static final TraceServiceClient create(TraceServiceSettings settings)

Constructs an instance of TraceServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
settings	TraceServiceSettings

Returns
Type	Description
TraceServiceClient

Exceptions
Type	Description
IOException

create(TraceServiceStub stub)

public static final TraceServiceClient create(TraceServiceStub stub)

Constructs an instance of TraceServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(TraceServiceSettings).

Parameter
Name	Description
stub	TraceServiceStub

Returns
Type	Description
TraceServiceClient

Constructors

TraceServiceClient(TraceServiceSettings settings)

protected TraceServiceClient(TraceServiceSettings settings)

Constructs an instance of TraceServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
settings	TraceServiceSettings

TraceServiceClient(TraceServiceStub stub)

protected TraceServiceClient(TraceServiceStub stub)

Parameter
Name	Description
stub	TraceServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

batchWriteSpans(BatchWriteSpansRequest request)

public final void batchWriteSpans(BatchWriteSpansRequest request)

Sends new spans to new or existing traces. You cannot update existing spans.

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   BatchWriteSpansRequest request =
       BatchWriteSpansRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .addAllSpans(new ArrayList<Span>())
           .build();
   traceServiceClient.batchWriteSpans(request);
 }
 

Parameter
Name	Description
request	BatchWriteSpansRequest The request object containing all of the parameters for the API call.

batchWriteSpans(ProjectName name, List<Span> spans)

public final void batchWriteSpans(ProjectName name, List<Span> spans)

Sends new spans to new or existing traces. You cannot update existing spans.

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   List<Span> spans = new ArrayList<>();
   traceServiceClient.batchWriteSpans(name, spans);
 }
 

Parameters
Name	Description
name	ProjectName Required. The name of the project where the spans belong. The format is projects/[PROJECT_ID].
spans	List<Span> Required. A list of new spans. The span names must not match existing spans, or the results are undefined.

batchWriteSpans(String name, List<Span> spans)

public final void batchWriteSpans(String name, List<Span> spans)

Sends new spans to new or existing traces. You cannot update existing spans.

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   String name = ProjectName.of("[PROJECT]").toString();
   List<Span> spans = new ArrayList<>();
   traceServiceClient.batchWriteSpans(name, spans);
 }
 

Parameters
Name	Description
name	String Required. The name of the project where the spans belong. The format is projects/[PROJECT_ID].
spans	List<Span> Required. A list of new spans. The span names must not match existing spans, or the results are undefined.

batchWriteSpansCallable()

public final UnaryCallable<BatchWriteSpansRequest,Empty> batchWriteSpansCallable()

Sends new spans to new or existing traces. You cannot update existing spans.

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   BatchWriteSpansRequest request =
       BatchWriteSpansRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .addAllSpans(new ArrayList<Span>())
           .build();
   ApiFuture<Empty> future = traceServiceClient.batchWriteSpansCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<BatchWriteSpansRequest,Empty>

close()

public final void close()

createSpan(Span request)

public final Span createSpan(Span request)

Creates a new span.

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   Span request =
       Span.newBuilder()
           .setName(SpanName.of("[PROJECT]", "[TRACE]", "[SPAN]").toString())
           .setSpanId("spanId-896182779")
           .setParentSpanId("parentSpanId1059234639")
           .setDisplayName(TruncatableString.newBuilder().build())
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setAttributes(Span.Attributes.newBuilder().build())
           .setStackTrace(StackTrace.newBuilder().build())
           .setTimeEvents(Span.TimeEvents.newBuilder().build())
           .setLinks(Span.Links.newBuilder().build())
           .setStatus(Status.newBuilder().build())
           .setSameProcessAsParentSpan(BoolValue.newBuilder().build())
           .setChildSpanCount(Int32Value.newBuilder().build())
           .build();
   Span response = traceServiceClient.createSpan(request);
 }
 

Parameter
Name	Description
request	Span The request object containing all of the parameters for the API call.

Returns
Type	Description
Span

createSpanCallable()

public final UnaryCallable<Span,Span> createSpanCallable()

Creates a new span.

Sample code:

 try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
   Span request =
       Span.newBuilder()
           .setName(SpanName.of("[PROJECT]", "[TRACE]", "[SPAN]").toString())
           .setSpanId("spanId-896182779")
           .setParentSpanId("parentSpanId1059234639")
           .setDisplayName(TruncatableString.newBuilder().build())
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .setAttributes(Span.Attributes.newBuilder().build())
           .setStackTrace(StackTrace.newBuilder().build())
           .setTimeEvents(Span.TimeEvents.newBuilder().build())
           .setLinks(Span.Links.newBuilder().build())
           .setStatus(Status.newBuilder().build())
           .setSameProcessAsParentSpan(BoolValue.newBuilder().build())
           .setChildSpanCount(Int32Value.newBuilder().build())
           .build();
   ApiFuture<Span> future = traceServiceClient.createSpanCallable().futureCall(request);
   // Do something.
   Span response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<Span,Span>

getSettings()

public final TraceServiceSettings getSettings()

Returns
Type	Description
TraceServiceSettings

getStub()

public TraceServiceStub getStub()

Returns
Type	Description
TraceServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()