Skip to content

Commit

Permalink
chore: update readme on client side metrics (#1557)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
mutianf and gcf-owl-bot[bot] committed Dec 16, 2022
1 parent 303959c commit 0c9aa49
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 17 deletions.
22 changes: 12 additions & 10 deletions .readme-partials.yml
Original file line number Diff line number Diff line change
Expand Up @@ -116,18 +116,14 @@ custom_content: |
TIP: If you are experiencing version conflicts with gRPC, see [Version Conflicts](#version-conflicts).
## Enabling client side metrics
Cloud Bigtable client supports publishing client side metrics to
[Cloud Monitoring](https://cloud.google.com/monitoring/docs/monitoring-overview) under the
`bigtable.googleapis.com/client` namespace.
Please fill out this [Google Form](https://forms.gle/xuhu6vCunn2MjV2m9) to sign up for the private preview of this
feature. And enable it by setting:
```java
BigtableDataSettings.enableBuiltinMetrics();
```
This feature is available once you upgrade to version 2.16.0 and above.
Follow the guide on https://cloud.google.com/bigtable/docs/client-side-metrics-setup to enable.
## Client request tracing: OpenCensus Tracing
Cloud Bigtable client supports [OpenCensus Tracing](https://opencensus.io/tracing/),
Expand Down Expand Up @@ -203,6 +199,12 @@ custom_content: |
## Enabling Cloud Bigtable Metrics: OpenCensus Stats
---
Note: We recommend [enabling client side built-in metrics](#enabling-client-side-metrics)
if you want to view your metrics on cloud monitoring. This integration is only for exporting the
metrics to a third party dashboard.
---
Cloud Bigtable client supports [Opencensus Metrics](https://opencensus.io/stats/),
which gives insight into the client internals and aids in debugging production issues.
All Cloud Bigtable Metrics are prefixed with `cloud.google.com/java/bigtable/`. The
Expand Down Expand Up @@ -237,7 +239,7 @@ custom_content: |
each operation required, tagged by operation name and final operation status.
Under normal circumstances, this will be 1.
### GFE metric views:
#### GFE metric views:
* `cloud.google.com/java/bigtable/gfe_latency`: A distribution of the latency
between Google's network receives an RPC and reads back the first byte of
the response.
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,13 +219,9 @@ Cloud Bigtable client supports publishing client side metrics to
[Cloud Monitoring](https://cloud.google.com/monitoring/docs/monitoring-overview) under the
`bigtable.googleapis.com/client` namespace.

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

```java
BigtableDataSettings.enableBuiltinMetrics();
```

## Client request tracing: OpenCensus Tracing

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

## Enabling Cloud Bigtable Metrics: OpenCensus Stats

---
Note: We recommend [enabling client side built-in metrics](#enabling-client-side-metrics)
if you want to view your metrics on cloud monitoring. This integration is only for exporting the
metrics to a third party dashboard.
---

Cloud Bigtable client supports [Opencensus Metrics](https://opencensus.io/stats/),
which gives insight into the client internals and aids in debugging production issues.
All Cloud Bigtable Metrics are prefixed with `cloud.google.com/java/bigtable/`. The
Expand Down Expand Up @@ -335,7 +337,7 @@ metrics will be tagged with:
each operation required, tagged by operation name and final operation status.
Under normal circumstances, this will be 1.

### GFE metric views:
#### GFE metric views:
* `cloud.google.com/java/bigtable/gfe_latency`: A distribution of the latency
between Google's network receives an RPC and reads back the first byte of
the response.
Expand Down

0 comments on commit 0c9aa49

Please sign in to comment.