Skip to content

Commit 9e83e35

Browse files
authored
chore: update readme file (#2199)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/java-bigtable/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) - [ ] Rollback plan is reviewed and LGTMed - [ ] All new data plane features have a completed end to end testing plan Fixes #<issue_number_goes_here> ☕️ If you write sample code, please follow the [samples format]( https://togithub.com/GoogleCloudPlatform/java-docs-samples/blob/main/SAMPLE_FORMAT.md).
1 parent c2a63f7 commit 9e83e35

File tree

2 files changed

+8
-12
lines changed

2 files changed

+8
-12
lines changed

.readme-partials.yml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ custom_content: |
115115
116116
TIP: If you are experiencing version conflicts with gRPC, see [Version Conflicts](#version-conflicts).
117117
118-
## Enabling client side metrics
118+
## Client side metrics
119119
120120
Cloud Bigtable client supports publishing client side metrics to
121121
[Cloud Monitoring](https://cloud.google.com/monitoring/docs/monitoring-overview) under the
@@ -124,8 +124,6 @@ custom_content: |
124124
This feature is available once you upgrade to version 2.16.0 and above.
125125
Follow the guide on https://cloud.google.com/bigtable/docs/client-side-metrics-setup to enable.
126126
127-
## Client side metrics
128-
129127
Since version 2.38.0, [client side metrics](https://cloud.google.com/bigtable/docs/client-side-metrics)
130128
is enabled by default. This feature collects useful telemetry data in the client and is recommended to
131129
use in conjunction with server-side metrics to get a complete, actionable view of your Bigtable
@@ -136,7 +134,7 @@ custom_content: |
136134
137135
You can opt-out client side metrics with the following settings:
138136
139-
```
137+
```java
140138
BigtableDataSettings settings = BigtableDataSettings.newBuilder()
141139
.setProjectId("my-project")
142140
.setInstanceId("my-instance")
@@ -229,7 +227,7 @@ custom_content: |
229227
If your application already has OpenCensus Tracing integration and you want to disable Bigtable
230228
traces, you can do the following:
231229
232-
```
230+
```java
233231
public static class MySampler extends Sampler {
234232
235233
private final Sampler childSampler;
@@ -259,7 +257,7 @@ custom_content: |
259257
```
260258
261259
And use this sampler in your trace config:
262-
```
260+
```java
263261
Tracing.getTraceConfig().updateActiveTraceParams(
264262
Tracing.getTraceConfig().getActiveTraceParams().toBuilder()
265263
.setSampler(new MySampler(Samplers.probabilitySampler(0.1)))

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ try {
215215

216216
TIP: If you are experiencing version conflicts with gRPC, see [Version Conflicts](#version-conflicts).
217217

218-
## Enabling client side metrics
218+
## Client side metrics
219219

220220
Cloud Bigtable client supports publishing client side metrics to
221221
[Cloud Monitoring](https://cloud.google.com/monitoring/docs/monitoring-overview) under the
@@ -224,8 +224,6 @@ Cloud Bigtable client supports publishing client side metrics to
224224
This feature is available once you upgrade to version 2.16.0 and above.
225225
Follow the guide on https://cloud.google.com/bigtable/docs/client-side-metrics-setup to enable.
226226

227-
## Client side metrics
228-
229227
Since version 2.38.0, [client side metrics](https://cloud.google.com/bigtable/docs/client-side-metrics)
230228
is enabled by default. This feature collects useful telemetry data in the client and is recommended to
231229
use in conjunction with server-side metrics to get a complete, actionable view of your Bigtable
@@ -236,7 +234,7 @@ in Cloud Monitoring.
236234

237235
You can opt-out client side metrics with the following settings:
238236

239-
```
237+
```java
240238
BigtableDataSettings settings = BigtableDataSettings.newBuilder()
241239
.setProjectId("my-project")
242240
.setInstanceId("my-instance")
@@ -329,7 +327,7 @@ Tracing.getTraceConfig().updateActiveTraceParams(
329327
If your application already has OpenCensus Tracing integration and you want to disable Bigtable
330328
traces, you can do the following:
331329

332-
```
330+
```java
333331
public static class MySampler extends Sampler {
334332

335333
private final Sampler childSampler;
@@ -359,7 +357,7 @@ public static class MySampler extends Sampler {
359357
```
360358

361359
And use this sampler in your trace config:
362-
```
360+
```java
363361
Tracing.getTraceConfig().updateActiveTraceParams(
364362
Tracing.getTraceConfig().getActiveTraceParams().toBuilder()
365363
.setSampler(new MySampler(Samplers.probabilitySampler(0.1)))

0 commit comments

Comments
 (0)