quic: add QUIC downstream connection close error stats. #16584
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| #include "common/quic/quic_stats.h" | ||
|
|
||
| namespace Envoy { | ||
| namespace Quic { | ||
|
|
||
| QuicStats::QuicStats(Stats::SymbolTable& symbol_table) | ||
| : stat_name_pool_(symbol_table), symbol_table_(symbol_table), | ||
| downstream_(stat_name_pool_.add("downstream")), upstream_(stat_name_pool_.add("upstream")), | ||
| from_self_(stat_name_pool_.add("self")), from_peer_(stat_name_pool_.add("peer")) { | ||
| // Preallocate most used counters | ||
| ConnectionCloseStatName(quic::QUIC_NETWORK_IDLE_TIMEOUT); | ||
| } | ||
|
|
||
| void QuicStats::incCounter(Stats::Scope& scope, const Stats::StatNameVec& names) { | ||
| Stats::SymbolTable::StoragePtr stat_name_storage = symbol_table_.join(names); | ||
| scope.counterFromStatName(Stats::StatName(stat_name_storage.get())).inc(); | ||
| } | ||
|
|
||
| void QuicStats::chargeQuicConnectionCloseStats(Stats::Scope& scope, quic::QuicErrorCode error_code, | ||
| quic::ConnectionCloseSource source, | ||
| bool is_upstream) { | ||
| ASSERT(&symbol_table_ == &scope.symbolTable()); | ||
|
|
||
| const Stats::StatName connection_close = ConnectionCloseStatName(error_code); | ||
| incCounter(scope, {is_upstream ? upstream_ : downstream_, | ||
| source == quic::ConnectionCloseSource::FROM_SELF ? from_self_ : from_peer_, | ||
| connection_close}); | ||
| } | ||
|
|
||
| Stats::StatName QuicStats::ConnectionCloseStatName(quic::QuicErrorCode error_code) { | ||
|
There was a problem hiding this comment. connectionCloseStatName per Envoy style guide |
||
| ASSERT(error_code < quic::QUIC_LAST_ERROR); | ||
|
|
||
| return Stats::StatName( | ||
| connection_error_stat_names_.get(error_code, [this, error_code]() -> const uint8_t* { | ||
| return stat_name_pool_.addReturningStorage( | ||
| absl::StrCat("quic_connection_close_error_code_", QuicErrorCodeToString(error_code))); | ||
| })); | ||
| } | ||
|
|
||
| } // namespace Quic | ||
| } // namespace Envoy | ||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| #pragma once | ||
|
|
||
| #include "envoy/stats/scope.h" | ||
|
|
||
| #include "common/common/thread.h" | ||
| #include "common/stats/symbol_table_impl.h" | ||
|
|
||
| #include "quiche/quic/core/quic_error_codes.h" | ||
| #include "quiche/quic/core/quic_types.h" | ||
|
|
||
| namespace Envoy { | ||
| namespace Quic { | ||
|
|
||
| class QuicStats { | ||
| public: | ||
| explicit QuicStats(Stats::SymbolTable& symbol_table); | ||
|
|
||
| void chargeQuicConnectionCloseStats(Stats::Scope& scope, quic::QuicErrorCode error_code, | ||
| quic::ConnectionCloseSource source, bool is_upstream); | ||
|
|
||
| private: | ||
| void incCounter(Stats::Scope& scope, const Stats::StatNameVec& names); | ||
|
|
||
| Stats::StatName ConnectionCloseStatName(quic::QuicErrorCode error_code); | ||
|
|
||
| Stats::StatNamePool stat_name_pool_; | ||
| Stats::SymbolTable& symbol_table_; | ||
| const Stats::StatName downstream_; | ||
| const Stats::StatName upstream_; | ||
| const Stats::StatName from_self_; | ||
| const Stats::StatName from_peer_; | ||
| Thread::AtomicPtrArray<const uint8_t, quic::QUIC_LAST_ERROR, | ||
| Thread::AtomicPtrAllocMode::DoNotDelete> | ||
| connection_error_stat_names_; | ||
| }; | ||
|
|
||
| } // namespace Quic | ||
| } // namespace Envoy |
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd suggest bundling QuicStats and quic::QuicConfig into a class Quic::Context, which can parallel Http::Context in most ways.
That will cut down by one on the arg-count in a few interfaces in this PR, and give you other good places to put stuff that may need to be shared across workers.
Moreover,
Quic::Context(or maybeOptRef<Quic::Context>) could then be returned fromServer::FactoryContext, also parallel to Http::Context and Grpc::Context, cutting down on how much plumbing through needs to happen for those individually.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I originally tried to make QuicStats behave similarly to Http::Context but found it to be quite complicated.
To have the server return QuicStats, we need a pure interface class so that Server::Instance can have a getter interface Quic::QuicStats quicStats().
However, the only public method in QuicStats, chargeQuicConnectionCloseStats(), is dependent on QuicErrorCode, which is defined in third_party library Quiche.
In my understanding, Envoy must to be able to build without quiche. And we probably shouldn't introduce external dependency in the include/ directory either.
Having this dependency makes it hard to follow existing pattern when implementing Quic stats.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On this point, to match the pattern in the other Contexts is to forward-declare QuicStats without defining an interface for it.
So you'd have
So you don't need to expose the error-code type or other types at the interface.