Repository navigation
docs(sink): fix missing example links and metrics snippet in README - #1014
Open
imitater-dou wants to merge 1 commit into
Open
imitater-dou wants to merge 1 commit into
imitater-dou wants to merge 1 commit into
Conversation
The sink README still referenced examples/basic and examples/advanced, which were not carried over when the sink library moved into this repo; only examples/simple-sink exists. The monitoring snippet also used metric variables that do not exist in the sink package; use ProcessedBytes, ProcessedBlocks and MessageSizeBytes instead, and format the float64 values returned by Get() with %.0f. Signed-off-by: ADou <ikun3.1415927@gmail.com>
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
sink/README.mdwas carried over from the standalonesubstreams-sinkrepository when the sink library moved into this repo (#658). Two parts of it no longer match the code insink/:./examples/basic/and./examples/advanced/(main.go+README.md), butsink/examples/only containssimple-sink/. All 5 links 404 on GitHub.sink.ProgressMessageProcessedBytes,sink.ProgressMessageTotalProcessedBlocksandsink.DataMessageSizeBytes, none of which exist in the package. The current metrics insink/metrics.goareProcessedBytes,ProcessedBlocks(gauges) andMessageSizeBytes(counter). Also,dmetricsGauge.Get()/Counter.Get()returnfloat64, so%dprints%!d(float64=...).Changes
./examples/simple-sink/main.go, and replace the "use the Advanced Example" note with a pointer to the existing Example Implementations section (the production sinks for MongoDB/PostgreSQL, etc.).%.0f.Docs only. No code changes.
How to verify