1
0
mirror of synced 2025-12-25 02:09:19 -05:00

add api endpoint to download server and scheduler logs (#1641)

* add api endpoint to download server and scheduler logs

* fmt

* respond to pr comments

* fix test

* oops
This commit is contained in:
Jared Rhizor
2021-01-14 11:00:30 -08:00
committed by GitHub
parent e79e80f82e
commit 3b08ace20c
9 changed files with 303 additions and 4 deletions

View File

@@ -262,6 +262,10 @@ font-style: italic;
<li><a href="#getJobInfo"><code><span class="http-method">post</span> /v1/jobs/get</code></a></li>
<li><a href="#listJobsFor"><code><span class="http-method">post</span> /v1/jobs/list</code></a></li>
</ul>
<h4><a href="#Logs">Logs</a></h4>
<ul>
<li><a href="#getLogs"><code><span class="http-method">post</span> /v1/logs/get</code></a></li>
</ul>
<h4><a href="#Scheduler">Scheduler</a></h4>
<ul>
<li><a href="#executeDestinationCheckConnection"><code><span class="http-method">post</span> /v1/scheduler/destinations/check_connection</code></a></li>
@@ -1994,6 +1998,60 @@ font-style: italic;
<a href="#"></a>
</div> <!-- method -->
<hr/>
<h1><a name="Logs">Logs</a></h1>
<div class="method"><a name="getLogs"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/logs/get</code></pre></div>
<div class="method-summary">Get logs (<span class="nickname">getLogs</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">LogsRequestBody <a href="#LogsRequestBody">LogsRequestBody</a> (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
File
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>text/plain</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Returns the log file
<a href="#File">File</a>
<h4 class="field-label">404</h4>
Logs not found
<a href="#"></a>
<h4 class="field-label">422</h4>
Invalid Input
<a href="#"></a>
</div> <!-- method -->
<hr/>
<h1><a name="Scheduler">Scheduler</a></h1>
<div class="method"><a name="executeDestinationCheckConnection"/>
<div class="method-path">
@@ -3905,6 +3963,8 @@ font-style: italic;
<li><a href="#JobStatus"><code>JobStatus</code> - </a></li>
<li><a href="#JobWithAttemptsRead"><code>JobWithAttemptsRead</code> - </a></li>
<li><a href="#LogRead"><code>LogRead</code> - </a></li>
<li><a href="#LogType"><code>LogType</code> - </a></li>
<li><a href="#LogsRequestBody"><code>LogsRequestBody</code> - </a></li>
<li><a href="#SlugRequestBody"><code>SlugRequestBody</code> - </a></li>
<li><a href="#SourceCoreConfig"><code>SourceCoreConfig</code> - </a></li>
<li><a href="#SourceCreate"><code>SourceCreate</code> - </a></li>
@@ -4247,6 +4307,19 @@ font-style: italic;
<div class="param">logLines </div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="LogType"><code>LogType</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>type/source of logs produced</div>
<div class="field-items">
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="LogsRequestBody"><code>LogsRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">log_type </div><div class="param-desc"><span class="param-type"><a href="#LogType">LogType</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="SlugRequestBody"><code>SlugRequestBody</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>