docs: Update stackdriver examples for tracing and stats #613

mutianf · 2021-02-04T22:06:36Z

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 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)

Fixes #<issue_number_goes_here> ☕️

codecov · 2021-02-04T22:11:20Z

Codecov Report

Merging #613 (b8d4a4b) into master (4893b16) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #613   +/-   ##
=========================================
  Coverage     81.71%   81.71%           
  Complexity     1156     1156           
=========================================
  Files           110      110           
  Lines          7214     7214           
  Branches        377      377           
=========================================
  Hits           5895     5895           
  Misses         1119     1119           
  Partials        200      200

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4893b16...0f4e3b3. Read the comment docs.

shantstepanian · 2021-02-05T02:38:06Z

README.md

+[Metrics explorer](https://console.cloud.google.com/monitoring/metrics-explorer)
+page.
+
+You can configure how frequent metrics are pushed to StackDriver and the


typo: frequently

shantstepanian · 2021-02-05T02:38:50Z

README.md

+page.
+
+You can configure how frequent metrics are pushed to StackDriver and the
+[Monitor Resource](https://cloud.google.com/monitoring/api/resources) by


better phrasing: Monitored Resource

shantstepanian · 2021-02-05T02:42:20Z

README.md

+[Metrics explorer](https://console.cloud.google.com/monitoring/metrics-explorer)
+page.
+
+You can configure how frequent metrics are pushed to StackDriver and the


nit: may be nicer to inline these suggestions into the example below. People may read code more easily than documentation

esp. for monitored resource, we want to encourage users to choose their own instead of just going w/ global.

shantstepanian · 2021-02-05T02:42:59Z

README.md

+updating the stats configuration:
+
+``` java
+// set export interval to 10 seconds and monitor resource to global


nit: Prefix this comment w/ Example, just to make it clear this isn't the standard way to do it.

we probably don't need the specified monitored resource too. Can we link to the Java doc for this so people can easily see all the options?

billyjacobson

Part of my confusion was around OpenCensus Tracing vs OpenCensus Stats. Perhaps we can differentiate them better in their section names and descriptions

For tracing: Client request tracing: OpenCensus Tracing
For stats: Enabling Cloud Bigtable Metrics: OpenCensus Stats

billyjacobson · 2021-02-05T14:27:36Z

README.md

@@ -376,6 +378,28 @@ BigtableDataSettings.enableOpenCensusStats();
 BigtableDataSettings.enableGfeOpenCensusStats();


I"m not sure that this line works still. Or at least it didn't compile when I tried using it I think

Ah.. Looks like this change is not released yet

billyjacobson · 2021-02-05T14:31:19Z

README.md

+updating the stats configuration:
+
+``` java
+// set export interval to 10 seconds and monitor resource to global


we probably don't need the specified monitored resource too. Can we link to the Java doc for this so people can easily see all the options?

shantstepanian · 2021-02-05T16:18:25Z

LGTM from my side; I'll defer to Billy's review on the code aspects

* docs: Update stackdriver examples for tracing and stats * update based on review

docs: Update stackdriver examples for tracing and stats

3d8fe76

mutianf requested review from a team as code owners February 4, 2021 22:06

google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Feb 4, 2021

product-auto-label bot added the api: bigtable Issues related to the googleapis/java-bigtable API. label Feb 5, 2021

shantstepanian reviewed Feb 5, 2021

View reviewed changes

billyjacobson reviewed Feb 5, 2021

View reviewed changes

update based on review

0f4e3b3

billyjacobson approved these changes Feb 5, 2021

View reviewed changes

billyjacobson merged commit 3e8af74 into googleapis:master Feb 5, 2021

mutianf deleted the update-readme branch February 5, 2021 16:44

mutianf mentioned this pull request Feb 5, 2021

chore: move readme changes on stackdriver examples #617

Merged

4 tasks

ad548 pushed a commit to ad548/java-bigtable that referenced this pull request Mar 13, 2021

docs: Update stackdriver examples for tracing and stats (googleapis#613)

2f45a4a

* docs: Update stackdriver examples for tracing and stats * update based on review

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Update stackdriver examples for tracing and stats #613

docs: Update stackdriver examples for tracing and stats #613

mutianf commented Feb 4, 2021

codecov bot commented Feb 4, 2021 •

edited

Loading

shantstepanian Feb 5, 2021

shantstepanian Feb 5, 2021

shantstepanian Feb 5, 2021

shantstepanian Feb 5, 2021

billyjacobson Feb 5, 2021

billyjacobson left a comment

billyjacobson Feb 5, 2021

mutianf Feb 5, 2021

billyjacobson Feb 5, 2021

shantstepanian commented Feb 5, 2021

		@@ -376,6 +378,28 @@ BigtableDataSettings.enableOpenCensusStats();
		BigtableDataSettings.enableGfeOpenCensusStats();

docs: Update stackdriver examples for tracing and stats #613

docs: Update stackdriver examples for tracing and stats #613

Conversation

mutianf commented Feb 4, 2021

codecov bot commented Feb 4, 2021 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

billyjacobson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shantstepanian commented Feb 5, 2021

codecov bot commented Feb 4, 2021 •

edited

Loading