Skip to content

Commit 0c9aa49

Browse files
chore: update readme on client side metrics (#1557)
* chore: update readme on client side metrics * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * update * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix link * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * update * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 303959c commit 0c9aa49

File tree

2 files changed

+21
-17
lines changed

2 files changed

+21
-17
lines changed

.readme-partials.yml

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -116,18 +116,14 @@ custom_content: |
116116
TIP: If you are experiencing version conflicts with gRPC, see [Version Conflicts](#version-conflicts).
117117
118118
## Enabling client side metrics
119-
119+
120120
Cloud Bigtable client supports publishing client side metrics to
121121
[Cloud Monitoring](https://cloud.google.com/monitoring/docs/monitoring-overview) under the
122122
`bigtable.googleapis.com/client` namespace.
123-
124-
Please fill out this [Google Form](https://forms.gle/xuhu6vCunn2MjV2m9) to sign up for the private preview of this
125-
feature. And enable it by setting:
126-
127-
```java
128-
BigtableDataSettings.enableBuiltinMetrics();
129-
```
130-
123+
124+
This feature is available once you upgrade to version 2.16.0 and above.
125+
Follow the guide on https://cloud.google.com/bigtable/docs/client-side-metrics-setup to enable.
126+
131127
## Client request tracing: OpenCensus Tracing
132128
133129
Cloud Bigtable client supports [OpenCensus Tracing](https://opencensus.io/tracing/),
@@ -203,6 +199,12 @@ custom_content: |
203199
204200
## Enabling Cloud Bigtable Metrics: OpenCensus Stats
205201
202+
---
203+
Note: We recommend [enabling client side built-in metrics](#enabling-client-side-metrics)
204+
if you want to view your metrics on cloud monitoring. This integration is only for exporting the
205+
metrics to a third party dashboard.
206+
---
207+
206208
Cloud Bigtable client supports [Opencensus Metrics](https://opencensus.io/stats/),
207209
which gives insight into the client internals and aids in debugging production issues.
208210
All Cloud Bigtable Metrics are prefixed with `cloud.google.com/java/bigtable/`. The
@@ -237,7 +239,7 @@ custom_content: |
237239
each operation required, tagged by operation name and final operation status.
238240
Under normal circumstances, this will be 1.
239241
240-
### GFE metric views:
242+
#### GFE metric views:
241243
* `cloud.google.com/java/bigtable/gfe_latency`: A distribution of the latency
242244
between Google's network receives an RPC and reads back the first byte of
243245
the response.

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -219,13 +219,9 @@ Cloud Bigtable client supports publishing client side metrics to
219219
[Cloud Monitoring](https://cloud.google.com/monitoring/docs/monitoring-overview) under the
220220
`bigtable.googleapis.com/client` namespace.
221221

222-
Please fill out this [Google Form](https://forms.gle/xuhu6vCunn2MjV2m9) to sign up for the private preview of this
223-
feature. And enable it by setting:
222+
This feature is available once you upgrade to version 2.16.0 and above.
223+
Follow the guide on https://cloud.google.com/bigtable/docs/client-side-metrics-setup to enable.
224224

225-
```java
226-
BigtableDataSettings.enableBuiltinMetrics();
227-
```
228-
229225
## Client request tracing: OpenCensus Tracing
230226

231227
Cloud Bigtable client supports [OpenCensus Tracing](https://opencensus.io/tracing/),
@@ -301,6 +297,12 @@ Tracing.getTraceConfig().updateActiveTraceParams(
301297

302298
## Enabling Cloud Bigtable Metrics: OpenCensus Stats
303299

300+
---
301+
Note: We recommend [enabling client side built-in metrics](#enabling-client-side-metrics)
302+
if you want to view your metrics on cloud monitoring. This integration is only for exporting the
303+
metrics to a third party dashboard.
304+
---
305+
304306
Cloud Bigtable client supports [Opencensus Metrics](https://opencensus.io/stats/),
305307
which gives insight into the client internals and aids in debugging production issues.
306308
All Cloud Bigtable Metrics are prefixed with `cloud.google.com/java/bigtable/`. The
@@ -335,7 +337,7 @@ metrics will be tagged with:
335337
each operation required, tagged by operation name and final operation status.
336338
Under normal circumstances, this will be 1.
337339

338-
### GFE metric views:
340+
#### GFE metric views:
339341
* `cloud.google.com/java/bigtable/gfe_latency`: A distribution of the latency
340342
between Google's network receives an RPC and reads back the first byte of
341343
the response.

0 commit comments

Comments
 (0)