Modified: falcon/site/restapi/InstanceStatus.html URL: http://svn.apache.org/viewvc/falcon/site/restapi/InstanceStatus.html?rev=1730450&r1=1730449&r2=1730450&view=diff ============================================================================== --- falcon/site/restapi/InstanceStatus.html (original) +++ falcon/site/restapi/InstanceStatus.html Mon Feb 15 06:02:08 2016 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2015-12-08 + | Generated by Apache Maven Doxia at 2016-02-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20151208" /> + <meta name="Date-Revision-yyyymmdd" content="20160209" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET /api/instance/status/:entity-type/:entity-name</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -58,7 +58,7 @@ - <li id="publishDate" class="pull-right">Last Published: 2015-12-08</li> + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> </ul> </div> @@ -415,6 +415,13 @@ <li> + <a href="../0.9/index.html" title="0.9 (Current)"> + <i class="none"></i> + 0.9 (Current)</a> + </li> + + <li> + <a href="../0.8/index.html" title="0.8"> <i class="none"></i> 0.8</a> @@ -544,7 +551,8 @@ <li>Supports ordering by "status","startTime","endTime","cluster".</li></ul></li> <li>sortOrder <optional param> Valid options are "asc" and "desc"</li> <li>offset <optional param> Show results from the offset, used for pagination. Defaults to 0.</li> -<li>numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10.</li></ul></div> +<li>numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10.</li> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> <div class="section"> <h3>Results<a name="Results"></a></h3> <p>Status of the specified instance along with job urls for all actions of user workflow and non-succeeded actions of the main-workflow.</p></div> @@ -590,7 +598,7 @@ GET https://localhost:15443/api/instance <h4>Rest Call<a name="Rest_Call"></a></h4> <div class="source"> <pre> -GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2 +GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2&doAs=joe </pre></div></div> <div class="section"> @@ -633,7 +641,7 @@ GET http://localhost:15000/api/instance/ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2013-2015 + <div class="row span12">Copyright © 2013-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved.
Modified: falcon/site/restapi/InstanceSummary.html URL: http://svn.apache.org/viewvc/falcon/site/restapi/InstanceSummary.html?rev=1730450&r1=1730449&r2=1730450&view=diff ============================================================================== --- falcon/site/restapi/InstanceSummary.html (original) +++ falcon/site/restapi/InstanceSummary.html Mon Feb 15 06:02:08 2016 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2015-12-08 + | Generated by Apache Maven Doxia at 2016-02-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20151208" /> + <meta name="Date-Revision-yyyymmdd" content="20160209" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET /api/instance/summary/:entity-type/:entity-name</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -58,7 +58,7 @@ - <li id="publishDate" class="pull-right">Last Published: 2015-12-08</li> + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> </ul> </div> @@ -415,6 +415,13 @@ <li> + <a href="../0.9/index.html" title="0.9 (Current)"> + <i class="none"></i> + 0.9 (Current)</a> + </li> + + <li> + <a href="../0.8/index.html" title="0.8"> <i class="none"></i> 0.8</a> @@ -525,16 +532,21 @@ <h3>Parameters<a name="Parameters"></a></h3> <p></p> <ul> -<li>:entity-type Valid options are cluster, feed or process.</li> +<li>:entity-type Valid options are feed or process.</li> <li>:entity-name Name of the entity.</li> -<li>start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'. +<li>start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.</li></ul>* By default, it is set to (end - (10 * entityFrequency)). <ul> -<li>By default, it is set to (end - (10 * entityFrequency)).</li></ul></li> -<li>end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'. +<li>end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.</li></ul>* Default is set to now. <ul> -<li>Default is set to now.</li></ul></li> <li>colo <optional param> Colo on which the query should be run.</li> -<li>lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li></ul></div> +<li>lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li> +<li>filterBy <optional param> Filter results by list of field:value pairs.</li></ul>Example1: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster Example2: filterBy=Status:RUNNING,Status:KILLED * Supported filter fields are STATUS, CLUSTER * Query will do an AND among filterBy fields. +<ul> +<li>orderBy <optional param> Field by which results should be ordered.</li></ul>* Supports ordering by "cluster". +<ul> +<li>sortOrder <optional param> Valid options are "asc" and "desc"</li></ul>Example: orderBy=cluster sortOrder=asc +<ul> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> <div class="section"> <h3>Results<a name="Results"></a></h3> <p>Summary of the instances over the specified time range</p></div> @@ -563,7 +575,7 @@ GET http://localhost:15000/api/instance/ "entry": { "key":"SUCCEEDED", - "key2":"value" + "value":"value" } } } @@ -571,6 +583,72 @@ GET http://localhost:15000/api/instance/ } </pre></div></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET https://localhost:16443/api/instance/summary/process/WordCount?filterBy=Status:KILLED,Status:RUNNING&start=2015-06-24T16:00Z&end=2015-06-24T23:00Z&colo=* + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "status":"SUCCEEDED", + "message":"local/SUMMARY\n", + "requestId":"local/1246061948@qtp-1059149611-5 - 34d8c3bb-f461-4fd5-87cd-402c9c6b1ed2\n", + "instancesSummary":[ + { + "cluster":"local", + "map":{ + "entry":{ + "key":"RUNNING", + "value":"1" + }, + "entry":{ + "key":"KILLED", + "value":"1" + } + } + } + ] +} + +</pre></div></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET https://localhost:16443/api/instance/summary/process/WordCount?orderBy=cluster&sortOrder=asc&start=2015-06-24T16:00Z&end=2015-06-24T23:00Z&colo=*&doAs=joe + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "status":"SUCCEEDED", + "message":"local/SUMMARY\n", + "requestId":"local/1246061948@qtp-1059149611-5 - 42e2040d-6b6e-4bfd-a090-83db5ed1a429\n", + "instancesSummary":[ + { + "cluster":"local", + "map":{ + "entry":{ + "key":"SUCCEEDED", + "value":"6" + }, + "entry":{ + "key":"KILLED", + "value":"1" + } + } + } + ] +} + +</pre></div></div> </div> </div> </div> @@ -579,7 +657,7 @@ GET http://localhost:15000/api/instance/ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2013-2015 + <div class="row span12">Copyright © 2013-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/restapi/InstanceSuspend.html URL: http://svn.apache.org/viewvc/falcon/site/restapi/InstanceSuspend.html?rev=1730450&r1=1730449&r2=1730450&view=diff ============================================================================== --- falcon/site/restapi/InstanceSuspend.html (original) +++ falcon/site/restapi/InstanceSuspend.html Mon Feb 15 06:02:08 2016 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2015-12-08 + | Generated by Apache Maven Doxia at 2016-02-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20151208" /> + <meta name="Date-Revision-yyyymmdd" content="20160209" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - POST /api/instance/suspend/:entity-type/:entity-name</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -58,7 +58,7 @@ - <li id="publishDate" class="pull-right">Last Published: 2015-12-08</li> + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> </ul> </div> @@ -415,6 +415,13 @@ <li> + <a href="../0.9/index.html" title="0.9 (Current)"> + <i class="none"></i> + 0.9 (Current)</a> + </li> + + <li> + <a href="../0.8/index.html" title="0.8"> <i class="none"></i> 0.8</a> @@ -529,7 +536,8 @@ <li>:entity-name is name of the entity.</li> <li>start is the start time of the instance(s) that you want to refer to</li> <li>end is the end time of the instance(s) that you want to refer to</li> -<li>lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.</li></ul></div> +<li>lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.</li> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> <div class="section"> <h3>Results<a name="Results"></a></h3> <p>Results of the suspend command.</p></div> @@ -539,7 +547,7 @@ <h4>Rest Call<a name="Rest_Call"></a></h4> <div class="source"> <pre> -POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z +POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z&doAs=joe </pre></div></div> <div class="section"> @@ -572,7 +580,7 @@ POST http://localhost:15000/api/instance <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2013-2015 + <div class="row span12">Copyright © 2013-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/restapi/MetadataList.html URL: http://svn.apache.org/viewvc/falcon/site/restapi/MetadataList.html?rev=1730450&r1=1730449&r2=1730450&view=diff ============================================================================== --- falcon/site/restapi/MetadataList.html (original) +++ falcon/site/restapi/MetadataList.html Mon Feb 15 06:02:08 2016 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2015-12-08 + | Generated by Apache Maven Doxia at 2016-02-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20151208" /> + <meta name="Date-Revision-yyyymmdd" content="20160209" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET api/metadata/discovery/:type/list</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -58,7 +58,7 @@ - <li id="publishDate" class="pull-right">Last Published: 2015-12-08</li> + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> </ul> </div> @@ -352,6 +352,13 @@ <li> + <a href="../0.9/index.html" title="0.9 (Current)"> + <i class="none"></i> + 0.9 (Current)</a> + </li> + + <li> + <a href="../0.8/index.html" title="0.8"> <i class="none"></i> 0.8</a> @@ -463,7 +470,8 @@ <p></p> <ul> <li>:type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo, tags, groups, pipelines</li> -<li>cluster <optional query param> Show dimensions related to this cluster.</li></ul></div> +<li>cluster <optional query param> Show dimensions related to this cluster.</li> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> <div class="section"> <h3>Results<a name="Results"></a></h3> <p>List of dimensions that match requested type [and cluster].</p></div> @@ -473,7 +481,7 @@ <h4>Rest Call<a name="Rest_Call"></a></h4> <div class="source"> <pre> -GET http://localhost:15000/api/metadata/discovery/process_entity/list?cluster=primary-cluster +GET http://localhost:15000/api/metadata/discovery/process_entity/list?cluster=primary-cluster&doAs=joe </pre></div></div> <div class="section"> @@ -494,7 +502,7 @@ GET http://localhost:15000/api/metadata/ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2013-2015 + <div class="row span12">Copyright © 2013-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/restapi/MetadataRelations.html URL: http://svn.apache.org/viewvc/falcon/site/restapi/MetadataRelations.html?rev=1730450&r1=1730449&r2=1730450&view=diff ============================================================================== --- falcon/site/restapi/MetadataRelations.html (original) +++ falcon/site/restapi/MetadataRelations.html Mon Feb 15 06:02:08 2016 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2015-12-08 + | Generated by Apache Maven Doxia at 2016-02-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20151208" /> + <meta name="Date-Revision-yyyymmdd" content="20160209" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET api/metadata/discovery/:dimension-type/:dimension-name/relations</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -58,7 +58,7 @@ - <li id="publishDate" class="pull-right">Last Published: 2015-12-08</li> + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> </ul> </div> @@ -308,6 +308,13 @@ <li> + <a href="../0.9/index.html" title="0.9 (Current)"> + <i class="none"></i> + 0.9 (Current)</a> + </li> + + <li> + <a href="../0.8/index.html" title="0.8"> <i class="none"></i> 0.8</a> @@ -419,7 +426,8 @@ <p></p> <ul> <li>:type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo, tags, groups, pipelines</li> -<li>:name Name of the dimension.</li></ul></div> +<li>:name Name of the dimension.</li> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> <div class="section"> <h3>Results<a name="Results"></a></h3> <p>Get all relations of a specific dimension.</p></div> @@ -429,7 +437,7 @@ <h4>Rest Call<a name="Rest_Call"></a></h4> <div class="source"> <pre> -GET http://localhost:15000/api/metadata/discovery/process_entity/sample-process/relations +GET http://localhost:15000/api/metadata/discovery/process_entity/sample-process/relations?doAs=joe </pre></div></div> <div class="section"> @@ -467,7 +475,7 @@ GET http://localhost:15000/api/metadata/ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2013-2015 + <div class="row span12">Copyright © 2013-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/restapi/ResourceList.html URL: http://svn.apache.org/viewvc/falcon/site/restapi/ResourceList.html?rev=1730450&r1=1730449&r2=1730450&view=diff ============================================================================== --- falcon/site/restapi/ResourceList.html (original) +++ falcon/site/restapi/ResourceList.html Mon Feb 15 06:02:08 2016 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2015-12-08 + | Generated by Apache Maven Doxia at 2016-02-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20151208" /> + <meta name="Date-Revision-yyyymmdd" content="20160209" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - RESTful Resources</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -58,7 +58,7 @@ - <li id="publishDate" class="pull-right">Last Published: 2015-12-08</li> + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> </ul> </div> @@ -602,6 +602,13 @@ <li> + <a href="../0.9/index.html" title="0.9 (Current)"> + <i class="none"></i> + 0.9 (Current)</a> + </li> + + <li> + <a href="../0.8/index.html" title="0.8"> <i class="none"></i> 0.8</a> @@ -725,7 +732,8 @@ curl -i "http://<HOST>:<PO curl -i --negotiate -u : "http://<HOST>:<PORT>/<PATH>?<PARAM>=..." </pre></div> -<p>See also: <a href="./../Security.twiki.html">Security in Falcon</a></p></div> +<p>See also: <a href="./../Security.twiki.html">Security in Falcon</a></p> +<p>The current version of the rest api's documentation is also hosted on the Falcon server and Prism Server (in distributed mode) at the url <a class="externalLink" href="http://<HOST>:<PORT>/docs";>http://<HOST>:<PORT>/docs</a></p></div> <div class="section"> <h3>REST Call on Admin Resource<a name="REST_Call_on_Admin_Resource"></a></h3> <p></p> @@ -808,6 +816,10 @@ curl -i --negotiate -u : "http://&l <td>Get the dependencies of the entity</td></tr> <tr class="a"> <td>GET</td> +<td><a href="./FeedSLA.html">api/entities/sla-alert/:entity-type</a></td> +<td>Get pending feed instances which missed sla</td></tr> +<tr class="b"> +<td>GET</td> <td><a href="./FeedLookup.html">api/entities/lookup/feed/</a></td> <td>Get feed for given path</td></tr></table></div> <div class="section"> @@ -856,8 +868,16 @@ curl -i --negotiate -u : "http://&l <td>Get logs of a given instance</td></tr> <tr class="a"> <td>GET</td> +<td><a href="./Triage.html">api/instance/triage/:entity-type/:entity-name</a></td> +<td>Triage an instance to see it's stuck lineage</td></tr> +<tr class="b"> +<td>GET</td> <td><a href="./InstanceSummary.html">api/instance/summary/:entity-type/:entity-name</a></td> -<td>Return summary of instances for an entity</td></tr></table></div> +<td>Return summary of instances for an entity</td></tr> +<tr class="a"> +<td>GET</td> +<td><a href="./InstanceDependency.html">api/instance/dependencies/:entity-type/:entity-name</a></td> +<td>Return dependent instances for a given instance</td></tr></table></div> <div class="section"> <h3>REST Call on Metadata Lineage Resource<a name="REST_Call_on_Metadata_Lineage_Resource"></a></h3> <p></p> @@ -926,7 +946,7 @@ curl -i --negotiate -u : "http://&l <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2013-2015 + <div class="row span12">Copyright © 2013-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Added: falcon/site/restapi/Triage.html URL: http://svn.apache.org/viewvc/falcon/site/restapi/Triage.html?rev=1730450&view=auto ============================================================================== --- falcon/site/restapi/Triage.html (added) +++ falcon/site/restapi/Triage.html Mon Feb 15 06:02:08 2016 @@ -0,0 +1,486 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-02-09 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20160209" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET api/instance/triage/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"> + <a href="../../index.html" id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> <a href="http://www.apache.org"; id="bannerRight"> + <img src="../images/apache-feather-tm.gif" alt="Falcon" height="45px"/> + </a> + </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET api/instance/triage/:entity-type/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> + + </ul> + </div> + + + <div class="row-fluid"> + <div id="leftColumn" class="span3"> + <div class="well sidebar-nav"> + + + <ul class="nav nav-list"> + <li class="nav-header">Falcon</li> + + <li> + + <a href="../index.html" title="About"> + <i class="none"></i> + About</a> + </li> + + <li> + + <a href="../slides/falcon-overview.html" title="Overview"> + <i class="none"></i> + Overview</a> + </li> + + <li> + + <a href="../slides/falcon-user-guide.html" title="User Guide"> + <i class="none"></i> + User Guide</a> + </li> + + <li> + + <a href="../GettingStarted.html" title="Getting Started"> + <i class="none"></i> + Getting Started</a> + </li> + + <li> + + <a href="../FalconDocumentation.html" title="Architecture"> + <i class="none"></i> + Architecture</a> + </li> + + <li> + + <a href="../InstallationSteps.html" title="Installation"> + <i class="none"></i> + Installation</a> + </li> + + <li> + + <a href="../OnBoarding.html" title="On Boarding"> + <i class="none"></i> + On Boarding</a> + </li> + + <li> + + <a href="../Operability.html" title="Operability"> + <i class="none"></i> + Operability</a> + </li> + + <li> + + <a href="../EntitySpecification.html" title="Entity Specification"> + <i class="none"></i> + Entity Specification</a> + </li> + + <li> + + <a href="../FalconCLI.html" title="Client (Falcon CLI)"> + <i class="none"></i> + Client (Falcon CLI)</a> + </li> + + <li> + + <a href="../restapi/ResourceList.html" title="Rest API"> + <i class="icon-chevron-right"></i> + Rest API</a> + </li> + + <li> + + <a href="../HiveIntegration.html" title="Hive Integration"> + <i class="none"></i> + Hive Integration</a> + </li> + + <li> + + <a href="../Security.html" title="Security"> + <i class="none"></i> + Security</a> + </li> + <li class="nav-header">Project Information</li> + + <li> + + <a href="../project-info.html" title="Summary"> + <i class="none"></i> + Summary</a> + </li> + + <li> + + <a href="../mail-lists.html" title="Mailing Lists"> + <i class="none"></i> + Mailing Lists</a> + </li> + + <li> + + <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4"; class="externalLink" title="IRC"> + <i class="none"></i> + IRC</a> + </li> + + <li> + + <a href="../team-list.html" title="Team"> + <i class="none"></i> + Team</a> + </li> + + <li> + + <a href="../issue-tracking.html" title="Issue Tracking"> + <i class="none"></i> + Issue Tracking</a> + </li> + + <li> + + <a href="../source-repository.html" title="Source Repository"> + <i class="none"></i> + Source Repository</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/Index"; class="externalLink" title="Wiki"> + <i class="none"></i> + Wiki</a> + </li> + + <li> + + <a href="../license.html" title="License"> + <i class="none"></i> + License</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/News"; class="externalLink" title="News"> + <i class="none"></i> + News</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy"; class="externalLink" title="Powered by"> + <i class="none"></i> + Powered by</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements"; class="externalLink" title="Acknowledgements"> + <i class="none"></i> + Acknowledgements</a> + </li> + + <li> + + <a href="http://blogs.apache.org/falcon/"; class="externalLink" title="Blog"> + <i class="none"></i> + Blog</a> + </li> + <li class="nav-header">Releases</li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.8"; class="externalLink" title="0.8"> + <i class="none"></i> + 0.8</a> + </li> + + <li> + + <a href="http://www.apache.org/dyn/closer.lua/falcon/0.7"; class="externalLink" title="0.7"> + <i class="none"></i> + 0.7</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/falcon/0.6.1"; class="externalLink" title="0.6.1"> + <i class="none"></i> + 0.6.1</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.6-incubating"; class="externalLink" title="0.6-incubating"> + <i class="none"></i> + 0.6-incubating</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.5-incubating"; class="externalLink" title="0.5-incubating"> + <i class="none"></i> + 0.5-incubating</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.4-incubating"; class="externalLink" title="0.4-incubating"> + <i class="none"></i> + 0.4-incubating</a> + </li> + + <li> + + <a href="http://archive.apache.org/dist/incubator/falcon/0.3-incubating"; class="externalLink" title="0.3-incubating"> + <i class="none"></i> + 0.3-incubating</a> + </li> + + <li> + + <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap"; class="externalLink" title="Coming soon"> + <i class="none"></i> + Coming soon</a> + </li> + <li class="nav-header">Documentation</li> + + <li> + + <a href="../0.9/index.html" title="0.9 (Current)"> + <i class="none"></i> + 0.9 (Current)</a> + </li> + + <li> + + <a href="../0.8/index.html" title="0.8"> + <i class="none"></i> + 0.8</a> + </li> + + <li> + + <a href="../0.7/index.html" title="0.7"> + <i class="none"></i> + 0.7</a> + </li> + + <li> + + <a href="../0.6.1/index.html" title="0.6.1"> + <i class="none"></i> + 0.6.1</a> + </li> + + <li> + + <a href="../0.6-incubating/index.html" title="0.6-incubating"> + <i class="none"></i> + 0.6-incubating</a> + </li> + + <li> + + <a href="../0.5-incubating/index.html" title="0.5-incubating"> + <i class="none"></i> + 0.5-incubating</a> + </li> + + <li> + + <a href="../0.4-incubating/index.html" title="0.4-incubating"> + <i class="none"></i> + 0.4-incubating</a> + </li> + + <li> + + <a href="../0.3-incubating/index.html" title="0.3-incubating"> + <i class="none"></i> + 0.3-incubating</a> + </li> + <li class="nav-header">ASF</li> + + <li> + + <a href="http://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"> + <i class="none"></i> + How Apache Works</a> + </li> + + <li> + + <a href="http://www.apache.org/foundation/"; class="externalLink" title="Foundation"> + <i class="none"></i> + Foundation</a> + </li> + + <li> + + <a href="http://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"> + <i class="none"></i> + Sponsoring Apache</a> + </li> + + <li> + + <a href="http://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"> + <i class="none"></i> + Thanks</a> + </li> + </ul> + + + + <hr class="divider" /> + + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div class="clear"></div> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </div> + </div> + </div> + + + <div id="bodyColumn" class="span9" > + + <div class="section"> +<h3>GET api/instance/triage/:entity-type/:entity-name<a name="GET_apiinstancetriage:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Given a feed/process instance this command traces it's ancestors to find what all ancestors have failed. It's useful if lot of instances are failing in a pipeline as it then finds out the root cause of the pipeline being stuck.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type type of entity(feed/process).</li> +<li>:entity-name name of the feed/process.</li> +<li>:start instance time of the entity instance.</li> +<li>:colo <optional param> name of the colo on which you want to triage</li> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>It returns a json graph</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/instance/triage/feed/my-feed?start=2015-03-02T00:00Z&colo=local&doAs=joe + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "vertices": ["(FEED) my-feed (2015-03-02T00:00Z) [Unavailable]", "(PROCESS) producer-process (2015-03-01T10:00Z) [TIMEDOUT]", "(FEED) input-feed-for-producer (2015-03-01T00:00Z) [Available]"], + "edges": + [ + { + "from" : "(PROCESS) producer-process (2015-03-01T10:00Z) [TIMEDOUT]", + "to" : "(FEED) my-feed (2015-03-02T00:00Z) [Unavailable]", + "label" : "produces" + }, + { + "from" : "(FEED) input-feed-for-producer (2015-03-01T00:00Z) [Available]", + "to" : "(PROCESS) producer-process (2015-03-01T10:00Z) [TIMEDOUT]", + "label" : "consumed by" + } + ] +} + +</pre></div></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2013-2016 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html> Modified: falcon/site/restapi/Vertex.html URL: http://svn.apache.org/viewvc/falcon/site/restapi/Vertex.html?rev=1730450&r1=1730449&r2=1730450&view=diff ============================================================================== --- falcon/site/restapi/Vertex.html (original) +++ falcon/site/restapi/Vertex.html Mon Feb 15 06:02:08 2016 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2015-12-08 + | Generated by Apache Maven Doxia at 2016-02-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20151208" /> + <meta name="Date-Revision-yyyymmdd" content="20160209" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET api/metadata/lineage/vertices/:id</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -58,7 +58,7 @@ - <li id="publishDate" class="pull-right">Last Published: 2015-12-08</li> + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> </ul> </div> @@ -408,6 +408,13 @@ <li> + <a href="../0.9/index.html" title="0.9 (Current)"> + <i class="none"></i> + 0.9 (Current)</a> + </li> + + <li> + <a href="../0.8/index.html" title="0.8"> <i class="none"></i> 0.8</a> @@ -518,7 +525,8 @@ <h3>Parameters<a name="Parameters"></a></h3> <p></p> <ul> -<li>:id is the unique id of the vertex.</li></ul></div> +<li>:id is the unique id of the vertex.</li> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> <div class="section"> <h3>Results<a name="Results"></a></h3> <p>Vertex with the specified id.</p></div> @@ -528,7 +536,7 @@ <h4>Rest Call<a name="Rest_Call"></a></h4> <div class="source"> <pre> -GET http://localhost:15000/api/metadata/lineage/vertices/4 +GET http://localhost:15000/api/metadata/lineage/vertices/4?doAs=joe </pre></div></div> <div class="section"> @@ -557,7 +565,7 @@ GET http://localhost:15000/api/metadata/ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2013-2015 + <div class="row span12">Copyright © 2013-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/restapi/VertexProperties.html URL: http://svn.apache.org/viewvc/falcon/site/restapi/VertexProperties.html?rev=1730450&r1=1730449&r2=1730450&view=diff ============================================================================== --- falcon/site/restapi/VertexProperties.html (original) +++ falcon/site/restapi/VertexProperties.html Mon Feb 15 06:02:08 2016 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2015-12-08 + | Generated by Apache Maven Doxia at 2016-02-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20151208" /> + <meta name="Date-Revision-yyyymmdd" content="20160209" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET api/metadata/lineage/vertices/properties/:id?relationships=:true</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -58,7 +58,7 @@ - <li id="publishDate" class="pull-right">Last Published: 2015-12-08</li> + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> </ul> </div> @@ -408,6 +408,13 @@ <li> + <a href="../0.9/index.html" title="0.9 (Current)"> + <i class="none"></i> + 0.9 (Current)</a> + </li> + + <li> + <a href="../0.8/index.html" title="0.8"> <i class="none"></i> 0.8</a> @@ -519,7 +526,8 @@ <p></p> <ul> <li>:id is the unique id of the vertex.</li> -<li>:relationships has default value of false. Pass true if relationships should be fetched.</li></ul></div> +<li>:relationships has default value of false. Pass true if relationships should be fetched.</li> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> <div class="section"> <h3>Results<a name="Results"></a></h3> <p>Properties associated with the specified vertex.</p></div> @@ -529,7 +537,7 @@ <h4>Rest Call<a name="Rest_Call"></a></h4> <div class="source"> <pre> -GET http://localhost:15000/api/metadata/lineage/vertices/properties/40004?relationships=true +GET http://localhost:15000/api/metadata/lineage/vertices/properties/40004?relationships=true&doAs=joe </pre></div></div> <div class="section"> @@ -555,7 +563,7 @@ GET http://localhost:15000/api/metadata/ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2013-2015 + <div class="row span12">Copyright © 2013-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/restapi/Vertices.html URL: http://svn.apache.org/viewvc/falcon/site/restapi/Vertices.html?rev=1730450&r1=1730449&r2=1730450&view=diff ============================================================================== --- falcon/site/restapi/Vertices.html (original) +++ falcon/site/restapi/Vertices.html Mon Feb 15 06:02:08 2016 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2015-12-08 + | Generated by Apache Maven Doxia at 2016-02-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20151208" /> + <meta name="Date-Revision-yyyymmdd" content="20160209" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - GET api/metadata/lineage/vertices?key=:key&value=:value</title> <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> @@ -58,7 +58,7 @@ - <li id="publishDate" class="pull-right">Last Published: 2015-12-08</li> + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> </ul> </div> @@ -408,6 +408,13 @@ <li> + <a href="../0.9/index.html" title="0.9 (Current)"> + <i class="none"></i> + 0.9 (Current)</a> + </li> + + <li> + <a href="../0.8/index.html" title="0.8"> <i class="none"></i> 0.8</a> @@ -519,7 +526,8 @@ <p></p> <ul> <li>:key is the key to be matched.</li> -<li>:value is the associated value of the key.</li></ul></div> +<li>:value is the associated value of the key.</li> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> <div class="section"> <h3>Results<a name="Results"></a></h3> <p>All vertices matching given property key and a value.</p></div> @@ -529,7 +537,7 @@ <h4>Rest Call<a name="Rest_Call"></a></h4> <div class="source"> <pre> -GET http://localhost:15000/api/metadata/lineage/vertices?key=name&value=sampleIngestProcess +GET http://localhost:15000/api/metadata/lineage/vertices?key=name&value=sampleIngestProcess&doAs=joe </pre></div></div> <div class="section"> @@ -559,7 +567,7 @@ GET http://localhost:15000/api/metadata/ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2013-2015 + <div class="row span12">Copyright © 2013-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/source-repository.html URL: http://svn.apache.org/viewvc/falcon/site/source-repository.html?rev=1730450&r1=1730449&r2=1730450&view=diff ============================================================================== --- falcon/site/source-repository.html (original) +++ falcon/site/source-repository.html Mon Feb 15 06:02:08 2016 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2015-12-08 + | Generated by Apache Maven Doxia at 2016-02-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20151208" /> + <meta name="Date-Revision-yyyymmdd" content="20160209" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - Source Repository</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -58,7 +58,7 @@ - <li id="publishDate" class="pull-right">Last Published: 2015-12-08</li> + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> </ul> </div> @@ -306,6 +306,13 @@ <li> + <a href="0.9/index.html" title="0.9 (Current)"> + <i class="none"></i> + 0.9 (Current)</a> + </li> + + <li> + <a href="0.8/index.html" title="0.8"> <i class="none"></i> 0.8</a> @@ -430,7 +437,7 @@ <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2013-2015 + <div class="row span12">Copyright © 2013-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved. Modified: falcon/site/team-list.html URL: http://svn.apache.org/viewvc/falcon/site/team-list.html?rev=1730450&r1=1730449&r2=1730450&view=diff ============================================================================== --- falcon/site/team-list.html (original) +++ falcon/site/team-list.html Mon Feb 15 06:02:08 2016 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2015-12-08 + | Generated by Apache Maven Doxia at 2016-02-09 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20151208" /> + <meta name="Date-Revision-yyyymmdd" content="20160209" /> <meta http-equiv="Content-Language" content="en" /> <title>Falcon - Team list</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> @@ -58,7 +58,7 @@ - <li id="publishDate" class="pull-right">Last Published: 2015-12-08</li> + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> </ul> </div> @@ -306,6 +306,13 @@ <li> + <a href="0.9/index.html" title="0.9 (Current)"> + <i class="none"></i> + 0.9 (Current)</a> + </li> + + <li> + <a href="0.8/index.html" title="0.8"> <i class="none"></i> 0.8</a> @@ -568,7 +575,23 @@ <td>Hortonworks</td> <td>committer</td> <td>-08:00</td> -<td><span id="developer-18">-08:00</span></td></tr></table></div> +<td><span id="developer-18">-08:00</span></td></tr> +<tr class="a"> +<td><a name="pavankumar"></a>pavankumar</td> +<td>Pavan Kumar Kolamuri</td> +<td><a class="externalLink" href="mailto:[email protected]";>[email protected]</a></td> +<td>Inmobi</td> +<td>committer</td> +<td>+05:30</td> +<td><span id="developer-19">+05:30</span></td></tr> +<tr class="b"> +<td><a name="peeyushb"></a>peeyushb</td> +<td>Peeyush Bishnoi</td> +<td><a class="externalLink" href="mailto:[email protected]";>[email protected]</a></td> +<td>Hortonworks</td> +<td>committer</td> +<td>+05:30</td> +<td><span id="developer-20">+05:30</span></td></tr></table></div> <div class="section"> <h3>Contributors<a name="Contributors"></a></h3><a name="Contributors"></a> <p>There are no contributors listed for this project. Please check back again later.</p><script type="text/javascript"> @@ -602,6 +625,8 @@ function init(){ offsetDate('developer-16', '0'); offsetDate('developer-17', '0'); offsetDate('developer-18', '0'); + offsetDate('developer-19', '0'); + offsetDate('developer-20', '0'); } window.onLoad = init(); @@ -614,7 +639,7 @@ window.onLoad = init(); <footer> <div class="container-fluid"> - <div class="row span12">Copyright © 2013-2015 + <div class="row span12">Copyright © 2013-2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All Rights Reserved.
