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: Documentation update for OpenTelemetry and tracing #1657

Merged
merged 5 commits into from
Jul 16, 2024

Conversation

cindy-peng
Copy link
Contributor

@cindy-peng cindy-peng commented Jul 12, 2024

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)

Here is a preview for the updated ReadMe:

image

@cindy-peng cindy-peng requested review from a team as code owners July 12, 2024 00:01
@product-auto-label product-auto-label bot added size: s Pull request size is small. api: logging Issues related to the googleapis/java-logging API. labels Jul 12, 2024
@cindy-peng cindy-peng added kokoro:force-run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Jul 12, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 12, 2024
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 12, 2024
.readme-partials.yaml Outdated Show resolved Hide resolved
.readme-partials.yaml Outdated Show resolved Hide resolved
.readme-partials.yaml Outdated Show resolved Hide resolved
.readme-partials.yaml Outdated Show resolved Hide resolved
.readme-partials.yaml Outdated Show resolved Hide resolved
.readme-partials.yaml Outdated Show resolved Hide resolved
@cindy-peng
Copy link
Contributor Author

Thank you for the great feedback @mtabasko! Updated the PR with fixes to your comments.

@@ -227,4 +227,17 @@ custom_content: |
<artifactId>google-cloud-logging-servlet-initializer</artifactId>
</dependency>
```
#### Population of Log Entrys' Trace/Span ID

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to title this "Automatic Trace/Span ID Extraction" to be consistent with the language used in other client libraries?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Kevin, Java-logging is a bit special here. We don't have auto extraction for Http headers unless it's through manual setting or using servlet-initializer.

@cindy-peng cindy-peng added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 12, 2024
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 12, 2024
Copy link

@aabmass aabmass left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is OwlBot supposed to update the README ? Otherwise LGTM

@cindy-peng cindy-peng added the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 12, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 12, 2024
@cindy-peng cindy-peng added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 12, 2024
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 12, 2024
.readme-partials.yaml Outdated Show resolved Hide resolved
@cindy-peng cindy-peng added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 15, 2024
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 15, 2024
@cindy-peng
Copy link
Contributor Author

/gcbrun

1 similar comment
@cindy-peng
Copy link
Contributor Author

/gcbrun

@cindy-peng cindy-peng added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 16, 2024
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 16, 2024
@cindy-peng cindy-peng merged commit e3c6670 into main Jul 16, 2024
23 checks passed
@cindy-peng cindy-peng deleted the cindy/otel-doc branch July 16, 2024 16:36
@cindy-peng
Copy link
Contributor Author

Is OwlBot supposed to update the README ? Otherwise LGTM

The OwlBot was supposed to update the README. However there is a hermetic build change which is deprecating Owlbot for java handwritten client libraries(go/hermetic-build-integration-hw-libraries). @diegomarquezp suggested we update this manually for now while his team is working on a fix. For now we have manually updated README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: logging Issues related to the googleapis/java-logging API. size: s Pull request size is small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants