Skip to content

Add way to signal encoding used for CompressedAttributes to Mixer #770

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.

Sign up for GitHub

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

Merged
wenchenglu merged 2 commits into from
Jan 30, 2019
Merged

Add way to signal encoding used for CompressedAttributes to Mixer #770

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b56771
Add mechanism to signal encoding used for CompressedAttributes to mix…
douglas-reid Jan 22, 2019
255661c
Update proto.lock
douglas-reid Jan 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 42 additions & 11 deletions mixer/v1/istio.mixer.v1.pb.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: istio.mixer.v1
layout: protoc-gen-docs
generator: protoc-gen-docs
number_of_entries: 20
number_of_entries: 21
---
<p>This package defines the Mixer API that the sidecar proxy uses to perform
precondition checks, manage quotas, and report telemetry.</p>
Expand Down Expand Up @@ -754,16 +754,13 @@ <h3 id="ReportRequest">ReportRequest</h3>
can be provided in a single message in order to improve communication efficiency. The
client can accumulate a set of actions and send them all in one single message.</p>

<p>Although each <code>Attributes</code> message is semantically treated as an independent
stand-alone entity unrelated to the other attributes within the message, this
message format leverages delta-encoding between attribute messages in order to
substantially reduce the request size and improve end-to-end efficiency. Each
individual set of attributes is used to modify the previous set. This eliminates
the need to redundantly send the same attributes multiple times over within
a single request.</p>

<p>If a client is not sophisticated and doesn&rsquo;t want to use delta-encoding,
a degenerate case is to include all attributes in every individual message.</p>
</td>
</tr>
<tr id="ReportRequest-repeated_attributes_semantics">
<td><code>repeatedAttributesSemantics</code></td>
<td><code><a href="#ReportRequest-RepeatedAttributesSemantics">ReportRequest.RepeatedAttributesSemantics</a></code></td>
<td>
<p>Indicates how to decode the attributes sets in this request.</p>

</td>
</tr>
Expand All @@ -787,6 +784,40 @@ <h3 id="ReportRequest">ReportRequest</h3>
<p>The number of words in the global dictionary.
To detect global dictionary out of sync between client and server.</p>

</td>
</tr>
</tbody>
</table>
</section>
<h3 id="ReportRequest-RepeatedAttributesSemantics">ReportRequest.RepeatedAttributesSemantics</h3>
<section>
<p>Used to signal how the sets of compressed attributes should be reconstitued server-side.</p>

<table class="enum-values">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="ReportRequest-RepeatedAttributesSemantics-DELTA_ENCODING">
<td><code>DELTA_ENCODING</code></td>
<td>
<p>Use delta encoding between sets of compressed attributes to reduce the overall on-wire
request size. Each individual set of attributes is used to modify the previous set.
NOTE: There is no way with this encoding to specify attribute value deletion. This
option should be used with extreme caution.</p>

</td>
</tr>
<tr id="ReportRequest-RepeatedAttributesSemantics-INDEPENDENT_ENCODING">
<td><code>INDEPENDENT_ENCODING</code></td>
<td>
<p>Treat each set of compressed attributes as complete - independent from other sets
in this request. This will result in on-wire duplication of attributes and values, but
will allow for proper accounting of absent values in overall encoding.</p>

</td>
</tr>
</tbody>
Expand Down
Loading