This repository was archived by the owner on Feb 6, 2026. It is now read-only.
feat: add support for tailLogEntry API#627
Merged
Conversation
google-cla
Bot
added
the
cla: yes
product-auto-label
Bot
added
the
api: logging
minherz
force-pushed
the
minherz/tailLogEntry-api
branch
2 times, most recently
from
11de83b to
51b270d
Compare
remove Callable suffix from the API method name add the new method to the "ignore diffs" list for clirr
Defines and implements tailLogEntries() API for streaming fresh log entries. Fixes #592
Renames cancel() to be close()
minherz
force-pushed
the
minherz/tailLogEntry-api
branch
from
9ee740f to
e48d4ac
Compare
use BidiStream to iterate through responses instead of implementing callback approach using BidiStreamObserver
…660) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [com.google.cloud:libraries-bom](https://togithub.com/GoogleCloudPlatform/cloud-opensource-java) | `22.0.0` -> `23.0.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box. --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/java-logging).
…onfig to v1.0.2 (#668) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [com.google.cloud:google-cloud-shared-config](https://togithub.com/googleapis/java-shared-config) | `1.0.1` -> `1.0.2` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>googleapis/java-shared-config</summary> ### [`v1.0.2`](https://togithub.com/googleapis/java-shared-config/blob/master/CHANGELOG.md#​102-httpswwwgithubcomgoogleapisjava-shared-configcomparev101v102-2021-09-13) [Compare Source](https://togithub.com/googleapis/java-shared-config/compare/v1.0.1...v1.0.2) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box. --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/java-logging).
…cies to v2.2.1 (#667) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [com.google.cloud:google-cloud-shared-dependencies](https://togithub.com/googleapis/java-shared-dependencies) | `2.2.0` -> `2.2.1` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>googleapis/java-shared-dependencies</summary> ### [`v2.2.1`](https://togithub.com/googleapis/java-shared-dependencies/blob/master/CHANGELOG.md#​221-httpswwwgithubcomgoogleapisjava-shared-dependenciescompare220v221-2021-09-13) [Compare Source](https://togithub.com/googleapis/java-shared-dependencies/compare/v2.2.0...v2.2.1) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box. --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/java-logging).
provide an explanation about synchronous and asynchronous modes for writing log entries and how the mode can be configured. Fixes #665
adjust Option class name to follow existing naming convention.
remove Callable suffix from the API method name add the new method to the "ignore diffs" list for clirr
Defines and implements tailLogEntries() API for streaming fresh log entries. Fixes #592
Renames cancel() to be close()
use BidiStream to iterate through responses instead of implementing callback approach using BidiStreamObserver
adjust Option class name to follow existing naming convention.
change interface signature to better reflect roles of the interfaces; update unit testing to validate TailOption
|
Warning: This pull request is touching the following templated files:
|
posting failing test as a placeholder. the test does not work because gax.rpc fails to work with stream
refactor the IT code to move delete logs into BaseSystemTest reuse methods and members of BaseSystemTest
format IT code
there is a problem with passing double quotes in the string parameter via grpc. neither "\"" nor "\\\"" that produce " and \" respectively works as desired
add unit test to verify send(TailLogEntriesRequest) method get called. apply formatting for IT test
setup delay in 10 seconds to eliminate any test flakiness validate the test using only values that were explicitly defined in log entry
simonz130
approved these changes
Sep 16, 2021
](https://renovatebot.com){kind=link}
| return listLogEntriesAsync(getOptions(), optionMap(options)); | ||
| } | ||
|
|
||
| static TailLogEntriesRequest tailLogEntriesRequest( |
There was a problem hiding this comment.
Is this not private for testing purposes?
I suggest you rename it to createTailLogEntriesRequest or buildTailLogEntriesRequest to follow conventions for builder method names.
Contributor
Author
There was a problem hiding this comment.
Is this not private for testing purposes?
Yes. Similarly to listLogEntriesRequest().
I will rename it. The old habbit to keep the code homogeneous including naming convention dies hard.
Contributor
Author
|
@simonz130 I will apply all you comments in PR #628 to avoid another review cycle. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implements tailLogEntry API that exposes entries.tail API for end users. The API is in Beta yet and does not support resuming and retrying mechanisms.
Fixes #592