Skip to content

Commit

Permalink
Using operator-utils HTTP API metrics (#917)
Browse files Browse the repository at this point in the history
* Using operator-utils HTTP API metrics

* Using latest insights-operator-utils and updating docs

* Removing doc for removed source file
  • Loading branch information
joselsegura authored Jul 8, 2020
1 parent e8ba627 commit 06ecca8
Show file tree
Hide file tree
Showing 20 changed files with 290 additions and 681 deletions.
34 changes: 0 additions & 34 deletions docs/packages/metrics/metrics.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,40 +157,6 @@
<div class="literal">&#34;github.com/prometheus/client_golang/prometheus/promauto&#34;</div><div class="operator"></div>
<div class="operator">)</div><div class="operator"></div>

</code></pre></td>
</tr>

<tr class="section">
<td class="doc"><p>APIRequests is a counter vector for requests to endpoints</p>
</td>
<td class="code"><pre><code><div class="keyword">var</div> <div class="ident">APIRequests</div> <div class="operator">=</div> <div class="ident">promauto</div><div class="operator">.</div><div class="ident">NewCounterVec</div><div class="operator">(</div><div class="ident">prometheus</div><div class="operator">.</div><div class="ident">CounterOpts</div><div class="operator">{</div>
<div class="ident">Name</div><div class="operator">:</div> <div class="literal">&#34;api_endpoints_requests&#34;</div><div class="operator">,</div>
<div class="ident">Help</div><div class="operator">:</div> <div class="literal">&#34;The total number of requests per endpoint&#34;</div><div class="operator">,</div>
<div class="operator">}</div><div class="operator">,</div> <div class="operator">[</div><div class="operator">]</div><div class="ident">string</div><div class="operator">{</div><div class="literal">&#34;endpoint&#34;</div><div class="operator">}</div><div class="operator">)</div><div class="operator"></div>

</code></pre></td>
</tr>

<tr class="section">
<td class="doc"><p>APIResponsesTime collects the information about api response time per endpoint</p>
</td>
<td class="code"><pre><code><div class="keyword">var</div> <div class="ident">APIResponsesTime</div> <div class="operator">=</div> <div class="ident">promauto</div><div class="operator">.</div><div class="ident">NewHistogramVec</div><div class="operator">(</div><div class="ident">prometheus</div><div class="operator">.</div><div class="ident">HistogramOpts</div><div class="operator">{</div>
<div class="ident">Name</div><div class="operator">:</div> <div class="literal">&#34;api_endpoints_response_time&#34;</div><div class="operator">,</div>
<div class="ident">Help</div><div class="operator">:</div> <div class="literal">&#34;API endpoints response time&#34;</div><div class="operator">,</div>
<div class="ident">Buckets</div><div class="operator">:</div> <div class="ident">prometheus</div><div class="operator">.</div><div class="ident">LinearBuckets</div><div class="operator">(</div><div class="literal">0</div><div class="operator">,</div> <div class="literal">20</div><div class="operator">,</div> <div class="literal">20</div><div class="operator">)</div><div class="operator">,</div>
<div class="operator">}</div><div class="operator">,</div> <div class="operator">[</div><div class="operator">]</div><div class="ident">string</div><div class="operator">{</div><div class="literal">&#34;endpoint&#34;</div><div class="operator">}</div><div class="operator">)</div><div class="operator"></div>

</code></pre></td>
</tr>

<tr class="section">
<td class="doc"><p>APIResponseStatusCodes collects the information about api response status codes</p>
</td>
<td class="code"><pre><code><div class="keyword">var</div> <div class="ident">APIResponseStatusCodes</div> <div class="operator">=</div> <div class="ident">promauto</div><div class="operator">.</div><div class="ident">NewCounterVec</div><div class="operator">(</div><div class="ident">prometheus</div><div class="operator">.</div><div class="ident">CounterOpts</div><div class="operator">{</div>
<div class="ident">Name</div><div class="operator">:</div> <div class="literal">&#34;api_endpoints_status_codes&#34;</div><div class="operator">,</div>
<div class="ident">Help</div><div class="operator">:</div> <div class="literal">&#34;API endpoints status codes&#34;</div><div class="operator">,</div>
<div class="operator">}</div><div class="operator">,</div> <div class="operator">[</div><div class="operator">]</div><div class="ident">string</div><div class="operator">{</div><div class="literal">&#34;status_code&#34;</div><div class="operator">}</div><div class="operator">)</div><div class="operator"></div>

</code></pre></td>
</tr>

Expand Down
155 changes: 0 additions & 155 deletions docs/packages/metrics/metrics_test.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/packages/server/errors.html
Original file line number Diff line number Diff line change
Expand Up @@ -218,12 +218,12 @@
<td class="doc"><p>handleServerError handles separate server errors and sends appropriate responses</p>
</td>
<td class="code"><pre><code><div class="keyword">func</div> <div class="ident">handleServerError</div><div class="operator">(</div><div class="ident">writer</div> <div class="ident">http</div><div class="operator">.</div><div class="ident">ResponseWriter</div><div class="operator">,</div> <div class="ident">err</div> <div class="ident">error</div><div class="operator">)</div> <div class="operator">{</div>
<div class="ident">log</div><div class="operator">.</div><div class="ident">Error</div><div class="operator">(</div><div class="operator">)</div><div class="operator">.</div><div class="ident">Err</div><div class="operator">(</div><div class="ident">err</div><div class="operator">)</div><div class="operator">.</div><div class="ident">Msg</div><div class="operator">(</div><div class="literal">&#34;handleServerError()&#34;</div><div class="operator">)</div><div class="operator"></div>
<div class="ident">log</div><div class="operator">.</div><div class="ident">Error</div><div class="operator">(</div><div class="operator">)</div><div class="operator">.</div><div class="ident">Err</div><div class="operator">(</div><div class="ident">err</div><div class="operator">)</div><div class="operator">.</div><div class="ident">Msg</div><div class="operator">(</div><div class="literal">&#34;handleServerError&#34;</div><div class="operator">)</div><div class="operator"></div>

<div class="keyword">var</div> <div class="ident">respErr</div> <div class="ident">error</div><div class="operator"></div>

<div class="keyword">switch</div> <div class="ident">err</div> <div class="operator">:=</div> <div class="ident">err</div><div class="operator">.</div><div class="operator">(</div><div class="keyword">type</div><div class="operator">)</div> <div class="operator">{</div>
<div class="keyword">case</div> <div class="operator">*</div><div class="ident">RouterMissingParamError</div><div class="operator">,</div> <div class="operator">*</div><div class="ident">RouterParsingError</div><div class="operator">,</div> <div class="operator">*</div><div class="ident">json</div><div class="operator">.</div><div class="ident">SyntaxError</div><div class="operator">,</div> <div class="operator">*</div><div class="ident">NoBodyError</div><div class="operator">:</div>
<div class="keyword">case</div> <div class="operator">*</div><div class="ident">RouterMissingParamError</div><div class="operator">,</div> <div class="operator">*</div><div class="ident">RouterParsingError</div><div class="operator">,</div> <div class="operator">*</div><div class="ident">json</div><div class="operator">.</div><div class="ident">SyntaxError</div><div class="operator">,</div> <div class="operator">*</div><div class="ident">NoBodyError</div><div class="operator">,</div> <div class="operator">*</div><div class="ident">types</div><div class="operator">.</div><div class="ident">ValidationError</div><div class="operator">:</div>
<div class="ident">respErr</div> <div class="operator">=</div> <div class="ident">responses</div><div class="operator">.</div><div class="ident">SendBadRequest</div><div class="operator">(</div><div class="ident">writer</div><div class="operator">,</div> <div class="ident">err</div><div class="operator">.</div><div class="ident">Error</div><div class="operator">(</div><div class="operator">)</div><div class="operator">)</div><div class="operator"></div>
<div class="keyword">case</div> <div class="operator">*</div><div class="ident">json</div><div class="operator">.</div><div class="ident">UnmarshalTypeError</div><div class="operator">:</div>
<div class="ident">respErr</div> <div class="operator">=</div> <div class="ident">responses</div><div class="operator">.</div><div class="ident">SendBadRequest</div><div class="operator">(</div><div class="ident">writer</div><div class="operator">,</div> <div class="literal">&#34;bad type in json data&#34;</div><div class="operator">)</div><div class="operator"></div>
Expand Down
Loading

0 comments on commit 06ecca8

Please sign in to comment.