Class TraceServiceClient (2.43.0)

GitHub RepositoryProduct Reference

Service Description: Service for collecting and viewing traces and spans within a trace.

A trace is a collection of spans corresponding to a single operation or a set of operations in an application.

A span is an individual timed event which forms a node of the trace tree. A single trace can contain spans 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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().

Methods
Method Description Method Variants

BatchWriteSpans

Batch writes new spans to new or existing traces. You cannot update existing spans.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchWriteSpans(BatchWriteSpansRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • batchWriteSpans(ProjectName name, List<Span> spans)

  • batchWriteSpans(String name, List<Span> spans)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchWriteSpansCallable()

CreateSpan

Creates a new span.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createSpan(Span request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createSpanCallable()

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TraceServiceSettings traceServiceSettings =
     TraceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TraceServiceClient traceServiceClient = TraceServiceClient.create(traceServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TraceServiceSettings traceServiceSettings =
     TraceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TraceServiceClient traceServiceClient = TraceServiceClient.create(traceServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TraceServiceSettings traceServiceSettings = TraceServiceSettings.newHttpJsonBuilder().build();
 TraceServiceClient traceServiceClient = TraceServiceClient.create(traceServiceSettings);

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

Inheritance

java.lang.Object > TraceServiceClient

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)

Batch writes new spans to new or existing traces. You cannot update existing spans.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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)

Batch writes new spans to new or existing traces. You cannot update existing spans.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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, otherwise the results are undefined.

batchWriteSpans(String name, List<Span> spans)

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

Batch writes new spans to new or existing traces. You cannot update existing spans.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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, otherwise the results are undefined.

batchWriteSpansCallable()

public final UnaryCallable<BatchWriteSpansRequest,Empty> batchWriteSpansCallable()

Batch writes new spans to new or existing traces. You cannot update existing spans.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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()