Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [cloudtrace] Remove html formatting (cleanup) #9027

Merged
merged 4 commits into from
Feb 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions java-trace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,20 @@ If you are using Maven, add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-trace</artifactId>
<version>2.8.0</version>
<version>2.9.0</version>
</dependency>
```

If you are using Gradle without BOM, add this to your dependencies:

```Groovy
implementation 'com.google.cloud:google-cloud-trace:2.8.0'
implementation 'com.google.cloud:google-cloud-trace:2.9.0'
```

If you are using SBT, add this to your dependencies:

```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-trace" % "2.8.0"
libraryDependencies += "com.google.cloud" % "google-cloud-trace" % "2.9.0"
```

## Authentication
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,13 @@

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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.
* Service Description: Service for collecting and viewing traces and spans within a trace.
*
* <p>A trace is a collection of spans corresponding to a single operation or a set of operations in
* an application.
*
* <p>A span is an individual timed event which forms a node of the trace tree. A single trace can
* contain spans from multiple services.
*
* <p>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:
Expand Down Expand Up @@ -172,7 +175,7 @@ public TraceServiceStub getStub() {

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sends new spans to new or existing traces. You cannot update existing spans.
* Batch writes new spans to new or existing traces. You cannot update existing spans.
*
* <p>Sample code:
*
Expand All @@ -191,8 +194,8 @@ public TraceServiceStub getStub() {
*
* @param name Required. The name of the project where the spans belong. The format is
* `projects/[PROJECT_ID]`.
* @param spans Required. A list of new spans. The span names must not match existing spans, or
* the results are undefined.
* @param spans Required. A list of new spans. The span names must not match existing spans,
* otherwise the results are undefined.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void batchWriteSpans(ProjectName name, List<Span> spans) {
Expand All @@ -206,7 +209,7 @@ public final void batchWriteSpans(ProjectName name, List<Span> spans) {

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sends new spans to new or existing traces. You cannot update existing spans.
* Batch writes new spans to new or existing traces. You cannot update existing spans.
*
* <p>Sample code:
*
Expand All @@ -225,8 +228,8 @@ public final void batchWriteSpans(ProjectName name, List<Span> spans) {
*
* @param name Required. The name of the project where the spans belong. The format is
* `projects/[PROJECT_ID]`.
* @param spans Required. A list of new spans. The span names must not match existing spans, or
* the results are undefined.
* @param spans Required. A list of new spans. The span names must not match existing spans,
* otherwise the results are undefined.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void batchWriteSpans(String name, List<Span> spans) {
Expand All @@ -237,7 +240,7 @@ public final void batchWriteSpans(String name, List<Span> spans) {

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sends new spans to new or existing traces. You cannot update existing spans.
* Batch writes new spans to new or existing traces. You cannot update existing spans.
*
* <p>Sample code:
*
Expand Down Expand Up @@ -266,7 +269,7 @@ public final void batchWriteSpans(BatchWriteSpansRequest request) {

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sends new spans to new or existing traces. You cannot update existing spans.
* Batch writes new spans to new or existing traces. You cannot update existing spans.
*
* <p>Sample code:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,19 @@
*/

/**
* The interfaces provided are listed below, along with usage samples.
* A client to Stackdriver Trace API
*
* <p>The interfaces provided are listed below, along with usage samples.
*
* <p>======================= TraceServiceClient =======================
*
* <p>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.
* <p>Service Description: Service for collecting and viewing traces and spans within a trace.
*
* <p>A trace is a collection of spans corresponding to a single operation or a set of operations in
* an application.
*
* <p>A span is an individual timed event which forms a node of the trace tree. A single trace can
* contain spans from multiple services.
*
* <p>Sample for TraceServiceClient:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,10 @@ public static class Builder extends StubSettings.Builder<TraceServiceStubSetting
ImmutableMap.Builder<String, ImmutableSet<StatusCode.Code>> definitions =
ImmutableMap.builder();
definitions.put(
"no_retry_0_codes", ImmutableSet.copyOf(Lists.<StatusCode.Code>newArrayList()));
"retry_policy_0_codes",
ImmutableSet.copyOf(
Lists.<StatusCode.Code>newArrayList(
StatusCode.Code.UNAVAILABLE, StatusCode.Code.DEADLINE_EXCEEDED)));
definitions.put(
"retry_policy_1_codes",
ImmutableSet.copyOf(
Expand All @@ -243,12 +246,15 @@ public static class Builder extends StubSettings.Builder<TraceServiceStubSetting
RetrySettings settings = null;
settings =
RetrySettings.newBuilder()
.setInitialRetryDelay(Duration.ofMillis(100L))
.setRetryDelayMultiplier(2.0)
.setMaxRetryDelay(Duration.ofMillis(30000L))
.setInitialRpcTimeout(Duration.ofMillis(120000L))
.setRpcTimeoutMultiplier(1.0)
.setMaxRpcTimeout(Duration.ofMillis(120000L))
.setTotalTimeout(Duration.ofMillis(120000L))
.build();
definitions.put("no_retry_0_params", settings);
definitions.put("retry_policy_0_params", settings);
settings =
RetrySettings.newBuilder()
.setInitialRetryDelay(Duration.ofMillis(100L))
Expand Down Expand Up @@ -319,8 +325,8 @@ private static Builder createHttpJsonDefault() {
private static Builder initDefaults(Builder builder) {
builder
.batchWriteSpansSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_0_params"));
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));

builder
.createSpanSettings()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@
*
*
* <pre>
* 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.
* 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.
* </pre>
*/
@javax.annotation.Generated(
Expand Down Expand Up @@ -168,11 +168,11 @@ public TraceServiceFutureStub newStub(
*
*
* <pre>
* 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.
* 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.
* </pre>
*/
public abstract static class TraceServiceImplBase implements io.grpc.BindableService {
Expand All @@ -181,7 +181,7 @@ public abstract static class TraceServiceImplBase implements io.grpc.BindableSer
*
*
* <pre>
* Sends new spans to new or existing traces. You cannot update
* Batch writes new spans to new or existing traces. You cannot update
* existing spans.
* </pre>
*/
Expand Down Expand Up @@ -228,11 +228,11 @@ public final io.grpc.ServerServiceDefinition bindService() {
*
*
* <pre>
* 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.
* 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.
* </pre>
*/
public static final class TraceServiceStub
Expand All @@ -250,7 +250,7 @@ protected TraceServiceStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
*
*
* <pre>
* Sends new spans to new or existing traces. You cannot update
* Batch writes new spans to new or existing traces. You cannot update
* existing spans.
* </pre>
*/
Expand Down Expand Up @@ -282,11 +282,11 @@ public void createSpan(
*
*
* <pre>
* 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.
* 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.
* </pre>
*/
public static final class TraceServiceBlockingStub
Expand All @@ -305,7 +305,7 @@ protected TraceServiceBlockingStub build(
*
*
* <pre>
* Sends new spans to new or existing traces. You cannot update
* Batch writes new spans to new or existing traces. You cannot update
* existing spans.
* </pre>
*/
Expand Down Expand Up @@ -333,11 +333,11 @@ public com.google.devtools.cloudtrace.v2.Span createSpan(
*
*
* <pre>
* 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.
* 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.
* </pre>
*/
public static final class TraceServiceFutureStub
Expand All @@ -356,7 +356,7 @@ protected TraceServiceFutureStub build(
*
*
* <pre>
* Sends new spans to new or existing traces. You cannot update
* Batch writes new spans to new or existing traces. You cannot update
* existing spans.
* </pre>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
*
*
* <pre>
* The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
* The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute.
* </pre>
*
* Protobuf type {@code google.devtools.cloudtrace.v2.AttributeValue}
Expand Down Expand Up @@ -444,7 +444,7 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
* The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute.
* </pre>
*
* Protobuf type {@code google.devtools.cloudtrace.v2.AttributeValue}
Expand Down
Loading