http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/InstanceParams.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/InstanceParams.twiki b/trunk/general/src/site/site/twiki/restapi/InstanceParams.twiki new file mode 100644 index 0000000..7a340a5 --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/InstanceParams.twiki @@ -0,0 +1,83 @@ +---++ GET /api/instance/params/:entity-type/:entity-name + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Get the params passed to the workflow for an instance of feed/process. + +---++ Parameters + * :entity-type Valid options are cluster, feed or process. + * :entity-name Name of the entity. + * start should be the nominal time of the instance for which you want the params to be returned + * colo <optional param> Colo on which the query should be run. + * lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default). + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + + +---++ Results +List of instances currently running. + +---++ Examples +---+++ Rest Call +<verbatim> +http://userqa.user.com:16000/api/instance/params/process/Sample-Process?start=2014-10-01T11:00Z&colo=*&doAs=joe +</verbatim> +---+++ Result +{ + "status": "SUCCEEDED", + "message": "ua1/PARAMS\n", + "requestId": "ua1/807e9fe6-ba60-490e-b720-f8dc8b92063e\n", + "instances": [ + { + "instance": "2014-10-01T11:00Z", + "status": "RUNNING", + "logFile": "http://spyke.user.com:11000/oozie?job=0000211-141117203201940-oozie-oozi-W";, + "cluster": "sample-cluster", + "startTime": "2014-11-19T19:46:29+08:00", + "details": "", + "actions": [ + { + "action": "succeeded-post-processing", + "status": "RUNNING", + "logFile": "http://spyke.user.com:50030/jobdetails.jsp?jobid=job_201411071450_1052"; + } + ], + "params": { + "entry": {"key": "jobTracker", "value": "10.16.114.113:8021"}, + "entry":{"key":"falconInputNames","value":"IGNORE"}, + "entry":{"key":"shouldRecord","value":"false"}, + "entry":{"key":"timeStamp","value":"2014-11-19-11-46"}, + "entry":{"key":"falconInPaths","value":"IGNORE"}, + "entry":{"key":"broker.url","value":"tcp://localhost:61616"}, + "entry":{"key":"feedNames","value":"NONE"}, + "entry":{"key":"falcon.libpath","value":"/path/falcon/sample/lib"}, + "entry":{"key":"ENTITY_PATH","value":"/path/falcon/staging/falcon/workflows/process/Sample-Process/9506be19980e0e6fdb709e1baffff_1416397585511/DEFAULT"}, + "entry":{"key":"entityType","value":"process"}, + "entry":{"key":"nominalTime","value":"2014-10-01-11-00"}, + "entry":{"key":"feedInstancePaths","value":"IGNORE"}, + "entry":{"key":"oozie.bundle.application.path","value":"hdfs://10.16.104.13:8020/path/falcon/staging/falcon/workflows/process/Sample-Process/9506be19980e0e669709e1baffff_1416397585511"}, + "entry":{"key":"logDir","value":"hdfs://10.16.104.13:8020/path/falcon/staging/falcon/workflows/process/Sample-Process/logs"}, + "entry":{"key":"userWorkflowEngine","value":"oozie"}, + "entry":{"key":"broker.ttlInMins","value":"4320"}, + "entry":{"key":"oozie.use.system.libpath","value":"true"}, + "entry":{"key":"queueName","value":"reports"}, + "entry":{"key":"falconDataOperation","value":"GENERATE"}, + "entry":{"key":"oozie.wf.external.id","value":"Sample-Process/DEFAULT/2014-10-01T11:00Z"}, + "entry":{"key":"workflowEngineUrl","value":"http://10.11.100.10:11000/oozie/"}, + "entry":{"key":"userBrokerImplClass","value":"org.apache.activemq.ActiveMQConnectionFactory"}, + "entry":{"key":"ENTITY_NAME","value":"FALCON_PROCESS_DEFAULT_Sample-Process"}, + "entry":{"key":"broker.impl.class","value":"org.apache.activemq.ActiveMQConnectionFactory"}, + "entry":{"key":"userWorkflowName","value":"Sample-workflow"}, + "entry":{"key":"entityName","value":"Sample-Process"}, + "entry":{"key":"srcClusterName","value":"NA"}, + "entry":{"key":"userBrokerUrl","value":"tcp://localhost:61616?daemon=true"}, + "entry":{"key":"falconInputFeeds","value":"NONE"}, + "entry":{"key":"user.name","value":"sampleuser"}, + "entry":{"key":"threedaysback","value":"2014-09-28"}, + "entry":{"key":"userWorkflowVersion","value":"1.0"} + } + } + ] +}
http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/InstanceRerun.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/InstanceRerun.twiki b/trunk/general/src/site/site/twiki/restapi/InstanceRerun.twiki new file mode 100644 index 0000000..eef0e1a --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/InstanceRerun.twiki @@ -0,0 +1,66 @@ +---++ POST /api/instance/rerun/:entity-type/:entity-name + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Rerun instances of an entity. On issuing a rerun, by default the execution resumes from the last failed node in the workflow. + +---++ Parameters + * :entity-type can either be a feed or a process. + * :entity-name is name of the entity. + * start is the start time of the instance that you want to refer to + * end is the end time of the instance that you want to refer to + * lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process. + * force <optional param> can be used to forcefully rerun the entire instance. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Results of the rerun command. + +---++ Examples +---+++ Rest Call +<verbatim> +POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2013-04-03T07:00Z&end=2014-04-03T07:00Z +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + "details": "", + "startTime": "2013-10-21T15:10:47-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "RUNNING", + "instance": "2012-04-03T07:00Z" + } + ], + "requestId": "default\/7a3582bd-608c-45a7-9b74-1837b51ba6d5\n", + "message": "default\/RERUN\n", + "status": "SUCCEEDED" +} +</verbatim> + +<verbatim> +POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2013-04-03T07:00Z&end=2014-04-03T07:00Z&force=true&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + "details": "", + "startTime": "2013-10-21T15:10:47-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "RUNNING", + "instance": "2012-04-03T07:00Z" + } + ], + "requestId": "default\/7a3582bd-608c-45a7-9b74-1837b51ba6d5\n", + "message": "default\/RERUN\n", + "status": "SUCCEEDED" +} +</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/InstanceResume.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/InstanceResume.twiki b/trunk/general/src/site/site/twiki/restapi/InstanceResume.twiki new file mode 100644 index 0000000..1254785 --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/InstanceResume.twiki @@ -0,0 +1,43 @@ +---++ POST /api/instance/resume/:entity-type/:entity-name + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Resume suspended instances of an entity. + +---++ Parameters + * :entity-type can either be a feed or a process. + * :entity-name is name of the entity. + * start is the start time of the instance(s) that you want to refer to + * end is the end time of the instance(s) that you want to refer to + * lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Results of the resume command. + +---++ Examples +---+++ Rest Call + <verbatim> + POST http://localhost:15000/api/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z&doAs=joe + </verbatim> + ---+++ Result + <verbatim> + { + "instances": [ + { + "details": "", + "startTime": "2013-10-21T15:19:57-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "RUNNING", + "instance": "2012-04-03T07:00Z" + } + ], + "requestId": "default\/e88ff2e0-2af7-4829-a360-f92e95be2981\n", + "message": "default\/RESUME\n", + "status": "SUCCEEDED" + } + </verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/InstanceRunning.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/InstanceRunning.twiki b/trunk/general/src/site/site/twiki/restapi/InstanceRunning.twiki new file mode 100644 index 0000000..3d1cabc --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/InstanceRunning.twiki @@ -0,0 +1,84 @@ +---++ GET /api/instance/running/:entity-type/:entity-name + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Get a list of instances currently running for a given entity. + +---++ Parameters + * :entity-type Valid options are cluster, feed or process. + * :entity-name Name of the entity. + * colo <optional param> Colo on which the query should be run. + * lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default). + * filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=CLUSTER:primary-cluster + * Supported filter fields are CLUSTER, SOURCECLUSTER, STARTEDAFTER. + * Query will do an AND among filterBy fields. + * orderBy <optional param> Field by which results should be ordered. + * Supports ordering by "status","startTime","endTime","cluster". + * sortOrder <optional param> Valid options are "asc" and "desc" + * offset <optional param> Show results from the offset, used for pagination. Defaults to 0. + * numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +List of instances currently running. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=* +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + "startTime": "2013-10-21T14:39:28-07:00", + "cluster": "primary-cluster", + "status": "RUNNING", + "instance": "2012-04-03T06:00Z" + } + ], + "requestId": "default\/12e9a7d4-3b4f-4a76-b471-c8f3786a62a0\n", + "message": "default\/Running Instances\n", + "status": "SUCCEEDED" +} +</verbatim> + + +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + "details": "", + "endTime": "2013-10-21T14:40:26-07:00", + "startTime": "2013-10-21T14:39:56-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "RUNNING", + "instance": "2012-04-03T07:00Z" + }, + { + "details": "", + "endTime": "2013-10-21T14:42:27-07:00", + "startTime": "2013-10-21T14:41:57-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W", + "status": "RUNNING", + "instance": "2012-04-03T08:00Z" + }, + ], + + "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n", + "message": "default\/STATUS\n", + "status": "SUCCEEDED" +} +</verbatim> + http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/InstanceSearch.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/InstanceSearch.twiki b/trunk/general/src/site/site/twiki/restapi/InstanceSearch.twiki new file mode 100644 index 0000000..4744240 --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/InstanceSearch.twiki @@ -0,0 +1,97 @@ +---++ GET /api/instance/search + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Get the list of instances that meet search criteria. + +---++ Parameters + * :type <optional param> Comma-separated entity types. Valid entity types are feed, process or datasource. + * nameseq <optional param> Subsequence of entity name. Not case sensitive. + * The entity name needs to contain all the characters in the subsequence in the same order. + * Example 1: "sample1" will match the entity named "SampleFeed1-2". + * Example 2: "mhs" will match the entity named "New-My-Hourly-Summary". + * tagkeys <optional param> Keywords in tags, separated by comma. Not case sensitive. + * The returned entities will have tags that match all the tag keywords. + * instanceStatus <optional param> Valid options are RUNNING, SUCCEEDED, FAILED, WAITING, SUSPENDED, KILLED, TIMEOUT. + * start <optional param> Show instances from this nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'. + * By default, it is set to (end - (10 * entityFrequency)). + * end <optional param> Show instances up to this nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'. + * Default is set to now. + * orderBy <optional param> Field by which results should be ordered. Sorted by descending order. + * If not specified, instances of the same entity will be listed together in the result. + * Current valid option: status. Coming soon: sorting by name, nominal time, running time. + * offset <optional param> Show results from the offset, used for pagination. Defaults to 0. + * numResults <optional param> Number of results to show per request, used for pagination. + * Only integers > 0 are valid. Default is 10. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs. + +---++ Results +A list of instances. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/instance/search?nameseq=usbill&start=2012-04-03T00:00Z +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + âname":"SampleUSHealthBillâ, + âtype":"FEEDâ, + âtagsâ: {"tag":["related=ushealthcare","department=billingDepartment"]}, + ânominalTime": "2012-04-03T07:00Z" + "cluster": "primary-cluster", + "status": "SUCCEEDED", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "startTime": "2013-10-21T14:39:56-07:00", + "endTime": "2013-10-21T14:40:26-07:00", + } + ], + "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n", + "message": "Instances Search Results", + "status": "SUCCEEDEDâ +} +</verbatim> + +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/instance/search?nameseq=samplebill&tagkeys=billing,healthcare&start=2012-04-03T00:00Z&instanceStatus=succeeded&orderBy=nominalTime&offset=2&numResults=2 +</verbatim> +---+++ Result +<verbatim> + { + "instances": [ + { + "name":"SampleHealthBill", + "type":"PROCESS", + "tagsâ: {"tag":["related=healthcare","department=billingDepartment"]}, + ânominalTime": "2012-04-03T08:00Z" + "cluster": "primary-cluster", + "status": "SUCCEEDED", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W", + "startTime": "2013-10-21T14:41:56-07:00", + "endTime": "2013-10-21T14:42:26-07:00", + }, + { + "name":"SampleUSHealthBill", + "type":"FEEDâ, + "tags": {"tag":["related=ushealthcare","department=billingDepartment"]}, + ânominalTime": "2012-04-03T07:00Z" + "cluster": "primary-cluster", + "status": "SUCCEEDED", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "startTime": "2013-10-21T14:39:56-07:00", + "endTime": "2013-10-21T14:40:26-07:00", + }, + ], + + "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n", + "message": "Instances Search Results", + "status": "SUCCEEDEDâ +} +</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/InstanceStatus.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/InstanceStatus.twiki b/trunk/general/src/site/site/twiki/restapi/InstanceStatus.twiki new file mode 100644 index 0000000..2b7b643 --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/InstanceStatus.twiki @@ -0,0 +1,98 @@ +---++ GET /api/instance/status/:entity-type/:entity-name + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Get status of a specific instance of an entity. + +---++ Parameters + * :entity-type Valid options are cluster, feed or process. + * :entity-name Name of the entity. + * start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'. + * By default, it is set to (end - (10 * entityFrequency)). + * end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'. + * Default is set to now. + * colo <optional param> Colo on which the query should be run. + * lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default). + * filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster + * Supported filter fields are STATUS, CLUSTER, SOURCECLUSTER, STARTEDAFTER. + * Query will do an AND among filterBy fields. + * orderBy <optional param> Field by which results should be ordered. + * Supports ordering by "status","startTime","endTime","cluster". + * sortOrder <optional param> Valid options are "asc" and "desc" + * offset <optional param> Show results from the offset, used for pagination. Defaults to 0. + * numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + * allAttempts <optional query param> To get all the attempts for corresponding instances. + +---++ Results +Status of the specified instance along with job urls for all actions of user workflow and non-succeeded actions of the main-workflow. + +---++ Examples +---+++ Rest Call +<verbatim> +GET https://localhost:15443/api/instance/status/process/WordCount?start=2014-11-04T16:00Z&colo=* +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + "details": "", + "endTime": "2014-11-05T16:08:10+05:30", + "startTime": "2014-11-05T16:07:29+05:30", + "cluster": "local", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000011-141105155430303-oozie-oozi-W", + "status": "SUCCEEDED", + "instance": "2014-11-04T16:00Z", + "actions": [ + { + "action": "wordcount-mr", + "status": "SUCCEEDED", + "logFile": "http:\/\/localhost:50030\/jobdetails.jsp?jobid=job_201411051553_0005" + } + ] + } + ], + "requestId": "default\/b9fc3cba-1b46-4d1f-8196-52c795ea3580\n", + "message": "default\/STATUS\n", + "status": "SUCCEEDED" +} +</verbatim> + + +---+++ Rest Call +<verbatim> +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 +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + "details": "", + "endTime": "2013-10-21T14:40:26-07:00", + "startTime": "2013-10-21T14:39:56-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "SUCCEEDED", + "instance": "2012-04-03T07:00Z" + }, + { + "details": "", + "endTime": "2013-10-21T14:42:26-07:00", + "startTime": "2013-10-21T14:41:56-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W", + "status": "SUCCEEDED", + "instance": "2012-04-03T08:00Z" + }, + ], + + "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n", + "message": "default\/STATUS\n", + "status": "SUCCEEDED" +} +</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/InstanceSummary.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/InstanceSummary.twiki b/trunk/general/src/site/site/twiki/restapi/InstanceSummary.twiki new file mode 100644 index 0000000..0e1ffee --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/InstanceSummary.twiki @@ -0,0 +1,114 @@ +---++ GET /api/instance/summary/:entity-type/:entity-name + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Get summary of instance/instances of an entity. + +---++ Parameters + * :entity-type Valid options are feed or process. + * :entity-name Name of the entity. + * start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'. + * By default, it is set to (end - (10 * entityFrequency)). + * end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'. + * Default is set to now. + * colo <optional param> Colo on which the query should be run. + * lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default). + * filterBy <optional param> Filter results by list of field:value pairs. + 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. + * orderBy <optional param> Field by which results should be ordered. + * Supports ordering by "cluster". + * sortOrder <optional param> Valid options are "asc" and "desc" + Example: orderBy=cluster sortOrder=asc + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Summary of the instances over the specified time range + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/instance/summary/process/WordCount?colo=*&start=2014-01-21T13:00Z&end=2014-01-21T16:00Z +</verbatim> +---+++ Result +<verbatim> +{ + "status":"SUCCEEDED", + "message":"default/SUMMARY\n", + "requestId":"default/c344567b-da73-44d5-bcd4-bf456524934c\n", + "instancesSummary": + { + "cluster":"local", + "map": + { + "entry": + { + "key":"SUCCEEDED", + "value":"value" + } + } + } + } +} +</verbatim> + +---+++ Rest Call +<verbatim> +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=* +</verbatim> +---+++ Result +<verbatim> +{ + "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" + } + } + } + ] +} +</verbatim> + +---+++ Rest Call +<verbatim> +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 +</verbatim> +---+++ Result +<verbatim> +{ + "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" + } + } + } + ] +} +</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/InstanceSuspend.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/InstanceSuspend.twiki b/trunk/general/src/site/site/twiki/restapi/InstanceSuspend.twiki new file mode 100644 index 0000000..2ba8663 --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/InstanceSuspend.twiki @@ -0,0 +1,44 @@ +---++ POST /api/instance/suspend/:entity-type/:entity-name + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Suspend instances of an entity. + +---++ Parameters + * :entity-type can either be a feed or a process. + * :entity-name is name of the entity. + * start is the start time of the instance(s) that you want to refer to + * end is the end time of the instance(s) that you want to refer to + * lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Results of the suspend command. + +---++ Examples +---+++ Rest Call +<verbatim> +POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + "details": "", + "endTime": "2013-10-21T15:15:01-07:00", + "startTime": "2013-10-21T15:14:32-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "SUCCEEDED", + "instance": "2012-04-03T07:00Z" + } + ], + "requestId": "default\/ff07e45b-b6da-4f47-ae96-9182bd8a7e53\n", + "message": "default\/SUSPEND\n", + "status": "SUCCEEDED" +} +</verbatim> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/MetadataList.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/MetadataList.twiki b/trunk/general/src/site/site/twiki/restapi/MetadataList.twiki new file mode 100644 index 0000000..98abf46 --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/MetadataList.twiki @@ -0,0 +1,31 @@ +---++ GET api/metadata/discovery/:type/list + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Get all dimensions of specified type. + +---++ Parameters + * :type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo, tags, groups, pipelines + * cluster <optional query param> Show dimensions related to this cluster. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + + +---++ Results +List of dimensions that match requested type [and cluster]. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/metadata/discovery/process_entity/list?cluster=primary-cluster&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "results": ["sampleIngestProcess","testProcess","anotherProcess"], + "totalSize": 3 +} +</verbatim> + http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/MetadataRelations.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/MetadataRelations.twiki b/trunk/general/src/site/site/twiki/restapi/MetadataRelations.twiki new file mode 100644 index 0000000..b29fd2a --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/MetadataRelations.twiki @@ -0,0 +1,46 @@ +---++ GET api/metadata/discovery/:dimension-type/:dimension-name/relations + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Get all relations of a specific dimension. + +---++ Parameters + * :type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo, tags, groups, pipelines + * :name Name of the dimension. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Get all relations of a specific dimension. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/metadata/discovery/process_entity/sample-process/relations?doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "timestamp":"2014-09-09T01:31Z", + "userWorkflowEngine":"pig", + "name":"sample-process", + "type":"PROCESS_ENTITY", + "userWorkflowName":"imp-click-join-workflow", + "version":"1.0.9", + "inVertices":[ + {"name":"clicks-feed","type":"FEED_ENTITY","label":"input"}, + {"name":"impression-feed","type":"FEED_ENTITY","label":"input"}, + {"name":"sample-process\/2014-01-01T01:00Z","type":"PROCESS_INSTANCE","label":"instance-of"} + ], + "outVertices":[ + {"name":"Critical","type":"TAGS","label":"classified-as"}, + {"name":"testPipeline","type":"PIPELINES","label":"pipeline"}, + {"name":"primary-cluster","type":"CLUSTER_ENTITY","label":"runs-on"}, + {"name":"imp-click-join2","type":"FEED_ENTITY","label":"output"}, + {"name":"imp-click-join1","type":"FEED_ENTITY","label":"output"}, + {"name":"falcon-user","type":"USER","label":"owned-by"} + ] +} +</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/ResourceList.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/ResourceList.twiki b/trunk/general/src/site/site/twiki/restapi/ResourceList.twiki new file mode 100644 index 0000000..5a4c253 --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/ResourceList.twiki @@ -0,0 +1,118 @@ +---+ RESTful Resources + +---++ Resource List + * <a href="#REST_Call_on_Entity_Resource">REST Call on Entity Resource</a> + * <a href="#REST_Call_on_Feed_and_Process_Instances">REST Call on Feed/Process Instances</a> + * <a href="#REST_Call_on_Admin_Resource">REST Call on Admin Resource</a> + * <a href="#REST_Call_on_Lineage_Graph">REST Call on Lineage Graph Resource</a> + * <a href="#REST_Call_on_Metadata_Resource">REST Call on Metadata Resource</a> + * <a href="#REST_Call_on_Extension_Artifact">REST Call on Extension artifact</a> + * <a href="#REST_Call_on_Extension_Job Management">REST Call on Extension Job Management</a> + +---++ Authentication + +When security is off (Pseudo/Simple), the authenticated user is the username specified in the user.name query +parameter. If the user.name parameter is not set, the server may either set the authenticated user to a default web +user, if there is any, or return an error response. + +When security is on (kerberos), authentication is performed by Kerberos SPNEGO. + +Below are examples using the curl command tool. + +Authentication when security is off (Pseudo/Simple): +<verbatim> +curl -i "http://<HOST>:<PORT>/<PATH>?[user.name=<USER>&]<PARAM>=..." +</verbatim> + +Authentication using Kerberos SPNEGO when security is on: +<verbatim> +curl -i --negotiate -u : "http://<HOST>:<PORT>/<PATH>?<PARAM>=..." +</verbatim> + +See also: [[../Security.twiki][Security in Falcon]] + +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 http://<HOST>:<PORT>/docs + +---++ REST Call on Admin Resource + +| *Call Type* | *Resource* | *Description* | +| GET | [[AdminStack][api/admin/stack]] | Get stack of the server | +| GET | [[AdminVersion][api/admin/version]] | Get version of the server | +| GET | [[AdminConfig][api/admin/config/:config-type]] | Get configuration information of the server | +| GET | [[AdminSafemode][api/admin/setSafeMode/:mode]] | Set safemode to true/false in falcon server | + +---++ REST Call on Entity Resource + +| *Call Type* | *Resource* | *Description* | +| POST | [[EntityValidate][api/entities/validate/:entity-type]] | Validate the entity | +| POST | [[EntitySubmit][api/entities/submit/:entity-type]] | Submit the entity | +| POST | [[EntityUpdate][api/entities/update/:entity-type/:entity-name]] | Update the entity | +| POST | [[EntitySubmitAndSchedule][api/entities/submitAndSchedule/:entity-type]] | Submit & Schedule the entity | +| POST | [[EntitySchedule][api/entities/schedule/:entity-type/:entity-name]] | Schedule the entity | +| POST | [[EntitySuspend][api/entities/suspend/:entity-type/:entity-name]] | Suspend the entity | +| POST | [[EntityResume][api/entities/resume/:entity-type/:entity-name]] | Resume the entity | +| DELETE | [[EntityDelete][api/entities/delete/:entity-type/:entity-name]] | Delete the entity | +| GET | [[EntityStatus][api/entities/status/:entity-type/:entity-name]] | Get the status of the entity | +| GET | [[EntityDefinition][api/entities/definition/:entity-type/:entity-name]] | Get the definition of the entity | +| GET | [[EntityList][api/entities/list/{:entity-type}]] | Get the list of entities | +| GET | [[EntitySummary][api/entities/summary/:entity-type/:cluster]] | Get instance summary of all entities | +| GET | [[EntityDependencies][api/entities/dependencies/:entity-type/:entity-name]] | Get the dependencies of the entity | +| GET | [[FeedSLA][api/entities/sla-alert/:entity-type]] | Get pending feed instances which missed sla | +| GET | [[FeedLookup][api/entities/lookup/feed/]] | Get feed for given path | + +---++ REST Call on Feed and Process Instances + +| *Call Type* | *Resource* | *Description* | +| GET | [[InstanceRunning][api/instance/running/:entity-type/:entity-name]] | List of running instances. | +| GET | [[InstanceParams][api/instance/params/:entity-type/:entity-name]] | List of entity instances along with their workflow params. | +| GET | [[InstanceList][api/instance/list/:entity-type/:entity-name]] | List of instances | +| GET | [[InstanceStatus][api/instance/status/:entity-type/:entity-name]] | Status of a given instance | +| POST | [[InstanceKill][api/instance/kill/:entity-type/:entity-name]] | Kill a given instance | +| POST | [[InstanceSuspend][api/instance/suspend/:entity-type/:entity-name]] | Suspend a running instance | +| POST | [[InstanceResume][api/instance/resume/:entity-type/:entity-name]] | Resume a given instance | +| POST | [[InstanceRerun][api/instance/rerun/:entity-type/:entity-name]] | Rerun a given instance | +| GET | [[InstanceLogs][api/instance/logs/:entity-type/:entity-name]] | Get logs of a given instance | +| GET | [[Triage][api/instance/triage/:entity-type/:entity-name]] | Triage an instance to see it's stuck lineage | +| GET | [[InstanceSummary][api/instance/summary/:entity-type/:entity-name]] | Return summary of instances for an entity | +| GET | [[InstanceDependency][api/instance/dependencies/:entity-type/:entity-name]] | Return dependent instances for a given instance | + +---++ REST Call on Metadata Lineage Resource + +| *Call Type* | *Resource* | *Description* | +| GET | [[Graph][api/metadata/lineage/serialize]] | dump the graph | +| GET | [[AllVertices][api/metadata/lineage/vertices/all]] | get all vertices | +| GET | [[Vertices][api/metadata/lineage/vertices?key=:key&value=:value]] | get all vertices for a key index | +| GET | [[Vertex][api/metadata/lineage/vertices/:id]] | get the vertex with the specified id | +| GET | [[VertexProperties][api/metadata/lineage/vertices/properties/:id?relationships=:true]] | get the properties of the vertex with the specified id | +| GET | [[AdjacentVertices][api/metadata/lineage/vertices/:id/:direction]] | get the adjacent vertices or edges of the vertex with the specified direction | +| GET | [[AllEdges][api/metadata/lineage/edges/all]] | get all edges | +| GET | [[Edge][api/metadata/lineage/edges/:id]] | get the edge with the specified id | +| GET | [[EntityLineage][api/metadata/lineage/entities?pipeline=:name]] | Get lineage graph for processes and feeds in the specified pipeline | + +---++ REST Call on Metadata Discovery Resource + +| *Call Type* | *Resource* | *Description* | +| GET | [[MetadataList][api/metadata/discovery/:dimension-type/list]] | list of dimensions | +| GET | [[MetadataRelations][api/metadata/discovery/:dimension-type/:dimension-name/relations]] | Return all relations of a dimension | + +---++ REST Call on Extension Artifact + +| *Call Type* | *Resource* | *Description* | +| GET | [[ExtensionEnumeration][api/extension/enumerate]] | List all the extensions supported | +| GET | [[ExtensionDescription][api/extension/describe/:extensionÂname]] | Return the README of the specified extension | +| GET | [[ExtensionDefinition][api/extension/definition/:extensionÂname]] | Return a JSON document describing the extension invocation parameters | + + +---++ REST Call on Extension Job Management + +| *Call Type* | *Resource* | *Description* | +| GET | [[ExtensionList][api/extension/list/:extensionÂname]] | List jobs generated from an extension | +| GET | [[ExtensionInstances][api/extension/instances/:job-name]] | List instances of an extension job | +| POST | [[ExtensionValidate][api/extension/validate/:extensionÂname]] | Validate an extension job | +| POST | [[ExtensionSubmit][api/extension/submit/:extensionÂname]] | Submit an extension job | +| POST | [[ExtensionUpdate][api/extension/update/:extensionÂname]] | Update an extension job | +| POST | [[ExtensionSubmitAndSchedule][api/extension/submitAndSchedule/:extensionÂname]] | Submit and schedule an extension job | +| POST | [[ExtensionSchedule][api/extension/schedule/:job-name]] | Schedule an extension job | +| POST | [[ExtensionSuspend][api/extension/suspend/:job-name]] | Suspend an extension job | +| POST | [[ExtensionResume][api/extension/resume/:job-name]] | Resume an extension job | +| POST | [[ExtensionDelete][api/extension/delete/:job-name]] | Delete an extension job | \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/Triage.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/Triage.twiki b/trunk/general/src/site/site/twiki/restapi/Triage.twiki new file mode 100644 index 0000000..9ff95c8 --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/Triage.twiki @@ -0,0 +1,45 @@ +---++ GET api/instance/triage/:entity-type/:entity-name + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +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. + + +---++ Parameters + * :entity-type type of entity(feed/process). + * :entity-name name of the feed/process. + * :start instance time of the entity instance. + * :colo <optional param> name of the colo on which you want to triage + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +It returns a json graph + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/instance/triage/feed/my-feed?start=2015-03-02T00:00Z&colo=local&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "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" + } + ] +} +</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/Vertex.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/Vertex.twiki b/trunk/general/src/site/site/twiki/restapi/Vertex.twiki new file mode 100644 index 0000000..82f5bfb --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/Vertex.twiki @@ -0,0 +1,36 @@ +---++ GET api/metadata/lineage/vertices/:id + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Gets the vertex with specified id. + +---++ Parameters + * :id is the unique id of the vertex. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Vertex with the specified id. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/metadata/lineage/vertices/4?doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "results": [ + { + "timestamp":"2014-04-21T20:55Z", + "name":"sampleIngestProcess", + "type":"process-instance", + "version":"2.0.0", + "_id":4, + "_type":"vertex" + } + ] +} +</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/VertexProperties.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/VertexProperties.twiki b/trunk/general/src/site/site/twiki/restapi/VertexProperties.twiki new file mode 100644 index 0000000..11c64b5 --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/VertexProperties.twiki @@ -0,0 +1,34 @@ +---++ GET api/metadata/lineage/vertices/properties/:id?relationships=:true + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Gets the properties of the vertex with specified id. + +---++ Parameters + * :id is the unique id of the vertex. + * :relationships has default value of false. Pass true if relationships should be fetched. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results + Properties associated with the specified vertex. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/metadata/lineage/vertices/properties/40004?relationships=true&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "results": + { + "timestamp":"2014-04-25T22:20Z", + "name":"local", + "type":"cluster-entity" + }, + "totalSize":3 +} +</verbatim> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/general/src/site/site/twiki/restapi/Vertices.twiki ---------------------------------------------------------------------- diff --git a/trunk/general/src/site/site/twiki/restapi/Vertices.twiki b/trunk/general/src/site/site/twiki/restapi/Vertices.twiki new file mode 100644 index 0000000..643e6e9 --- /dev/null +++ b/trunk/general/src/site/site/twiki/restapi/Vertices.twiki @@ -0,0 +1,38 @@ +---++ GET api/metadata/lineage/vertices?key=:key&value=:value + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Get all vertices for a key index given the specified value. + +---++ Parameters + * :key is the key to be matched. + * :value is the associated value of the key. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +All vertices matching given property key and a value. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/metadata/lineage/vertices?key=name&value=sampleIngestProcess&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "results": [ + { + "timestamp":"2014-04-21T20:55Z", + "name":"sampleIngestProcess", + "type":"process-instance", + "version":"2.0.0", + "_id":4, + "_type":"vertex" + } + ], + "totalSize": 1 +} +</verbatim> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/pom.xml ---------------------------------------------------------------------- diff --git a/trunk/pom.xml b/trunk/pom.xml index b60eb84..63de31f 100644 --- a/trunk/pom.xml +++ b/trunk/pom.xml @@ -21,7 +21,7 @@ <modelVersion>4.0.0</modelVersion> <groupId>org.apache.falcon</groupId> <artifactId>falcon-website</artifactId> - <version>0.11-SNAPSHOT</version> + <version>0.12-SNAPSHOT</version> <packaging>pom</packaging> <name>Apache Falcon</name> @@ -319,6 +319,16 @@ </roles> <organization>Hortonworks</organization> </developer> + <developer> + <id>sandeeps</id> + <name>Sandeep samudrala</name> + <email>[email protected]</email> + <timezone>+05:30</timezone> + <roles> + <role>committer</role> + </roles> + <organization>Inmobi</organization> + </developer> </developers> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/pom.xml ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/pom.xml b/trunk/releases/0.11/pom.xml new file mode 100644 index 0000000..9092d23 --- /dev/null +++ b/trunk/releases/0.11/pom.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.falcon</groupId> + <artifactId>falcon-website-releases</artifactId> + <version>0.2</version> + </parent> + <artifactId>falcon-website-0.11</artifactId> + <version>0.11</version> + <packaging>pom</packaging> + + <name>Apache Falcon - Documentation v0.11</name> + + <build> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>3.3</version> + <dependencies> + <dependency> + <groupId>org.apache.maven.doxia</groupId> + <artifactId>doxia-module-twiki</artifactId> + <version>1.3</version> + </dependency> + <dependency> + <groupId>org.apache.maven.wagon</groupId> + <artifactId>wagon-ssh-external</artifactId> + <version>2.6</version> + </dependency> + </dependencies> + <executions> + <execution> + <goals> + <goal>site</goal> + </goals> + <phase>prepare-package</phase> + </execution> + </executions> + <configuration> + <outputDirectory>../../../content/0.11</outputDirectory> + </configuration> + </plugin> + </plugins> + </build> + +</project> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/Architecture.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/Architecture.png b/trunk/releases/0.11/src/site/resources/Architecture.png new file mode 100644 index 0000000..0378b49 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/Architecture.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/EntityDependency.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/EntityDependency.png b/trunk/releases/0.11/src/site/resources/EntityDependency.png new file mode 100644 index 0000000..9f11870 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/EntityDependency.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/FeedSchedule.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/FeedSchedule.png b/trunk/releases/0.11/src/site/resources/FeedSchedule.png new file mode 100644 index 0000000..105c6b1 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/FeedSchedule.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/PrismSetup.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/PrismSetup.png b/trunk/releases/0.11/src/site/resources/PrismSetup.png new file mode 100644 index 0000000..b0dc9a5 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/PrismSetup.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/ProcessSchedule.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/ProcessSchedule.png b/trunk/releases/0.11/src/site/resources/ProcessSchedule.png new file mode 100644 index 0000000..a7dd788 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/ProcessSchedule.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/accessories-text-editor.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/accessories-text-editor.png b/trunk/releases/0.11/src/site/resources/images/accessories-text-editor.png new file mode 100644 index 0000000..abc3366 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/accessories-text-editor.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/add.gif ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/add.gif b/trunk/releases/0.11/src/site/resources/images/add.gif new file mode 100644 index 0000000..1cb3dbf Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/add.gif differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/apache-incubator-logo.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/apache-incubator-logo.png b/trunk/releases/0.11/src/site/resources/images/apache-incubator-logo.png new file mode 100644 index 0000000..81fb31e Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/apache-incubator-logo.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/apache-maven-project-2.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/apache-maven-project-2.png b/trunk/releases/0.11/src/site/resources/images/apache-maven-project-2.png new file mode 100644 index 0000000..6c096ec Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/apache-maven-project-2.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/application-certificate.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/application-certificate.png b/trunk/releases/0.11/src/site/resources/images/application-certificate.png new file mode 100644 index 0000000..cc6aff6 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/application-certificate.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/contact-new.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/contact-new.png b/trunk/releases/0.11/src/site/resources/images/contact-new.png new file mode 100644 index 0000000..ebc4316 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/contact-new.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/document-properties.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/document-properties.png b/trunk/releases/0.11/src/site/resources/images/document-properties.png new file mode 100644 index 0000000..34c2409 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/document-properties.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/drive-harddisk.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/drive-harddisk.png b/trunk/releases/0.11/src/site/resources/images/drive-harddisk.png new file mode 100644 index 0000000..d7ce475 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/drive-harddisk.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/falcon-logo.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/falcon-logo.png b/trunk/releases/0.11/src/site/resources/images/falcon-logo.png new file mode 100644 index 0000000..0a9f6cf Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/falcon-logo.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/fix.gif ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/fix.gif b/trunk/releases/0.11/src/site/resources/images/fix.gif new file mode 100644 index 0000000..b7eb3dc Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/fix.gif differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/icon_error_sml.gif ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/icon_error_sml.gif b/trunk/releases/0.11/src/site/resources/images/icon_error_sml.gif new file mode 100644 index 0000000..12e9a01 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/icon_error_sml.gif differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/icon_help_sml.gif ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/icon_help_sml.gif b/trunk/releases/0.11/src/site/resources/images/icon_help_sml.gif new file mode 100644 index 0000000..aaf20e6 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/icon_help_sml.gif differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/icon_info_sml.gif ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/icon_info_sml.gif b/trunk/releases/0.11/src/site/resources/images/icon_info_sml.gif new file mode 100644 index 0000000..b776326 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/icon_info_sml.gif differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/icon_success_sml.gif ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/icon_success_sml.gif b/trunk/releases/0.11/src/site/resources/images/icon_success_sml.gif new file mode 100644 index 0000000..0a19527 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/icon_success_sml.gif differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/icon_warning_sml.gif ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/icon_warning_sml.gif b/trunk/releases/0.11/src/site/resources/images/icon_warning_sml.gif new file mode 100644 index 0000000..ac6ad6a Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/icon_warning_sml.gif differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/image-x-generic.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/image-x-generic.png b/trunk/releases/0.11/src/site/resources/images/image-x-generic.png new file mode 100644 index 0000000..ab49efb Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/image-x-generic.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/internet-web-browser.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/internet-web-browser.png b/trunk/releases/0.11/src/site/resources/images/internet-web-browser.png new file mode 100644 index 0000000..307d6ac Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/internet-web-browser.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/logos/build-by-maven-black.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/logos/build-by-maven-black.png b/trunk/releases/0.11/src/site/resources/images/logos/build-by-maven-black.png new file mode 100644 index 0000000..919fd0f Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/logos/build-by-maven-black.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/logos/build-by-maven-white.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/logos/build-by-maven-white.png b/trunk/releases/0.11/src/site/resources/images/logos/build-by-maven-white.png new file mode 100644 index 0000000..7d44c9c Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/logos/build-by-maven-white.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/logos/maven-feather.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/logos/maven-feather.png b/trunk/releases/0.11/src/site/resources/images/logos/maven-feather.png new file mode 100644 index 0000000..b5ada83 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/logos/maven-feather.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/network-server.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/network-server.png b/trunk/releases/0.11/src/site/resources/images/network-server.png new file mode 100644 index 0000000..1d12e19 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/network-server.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/package-x-generic.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/package-x-generic.png b/trunk/releases/0.11/src/site/resources/images/package-x-generic.png new file mode 100644 index 0000000..8b7e9e6 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/package-x-generic.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/profiles/pre-release.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/profiles/pre-release.png b/trunk/releases/0.11/src/site/resources/images/profiles/pre-release.png new file mode 100644 index 0000000..d448e85 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/profiles/pre-release.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/profiles/retired.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/profiles/retired.png b/trunk/releases/0.11/src/site/resources/images/profiles/retired.png new file mode 100644 index 0000000..f89f6a2 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/profiles/retired.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/profiles/sandbox.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/profiles/sandbox.png b/trunk/releases/0.11/src/site/resources/images/profiles/sandbox.png new file mode 100644 index 0000000..f88b362 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/profiles/sandbox.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/remove.gif ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/remove.gif b/trunk/releases/0.11/src/site/resources/images/remove.gif new file mode 100644 index 0000000..fc65631 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/remove.gif differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/rss.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/rss.png b/trunk/releases/0.11/src/site/resources/images/rss.png new file mode 100644 index 0000000..a9850ee Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/rss.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/update.gif ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/update.gif b/trunk/releases/0.11/src/site/resources/images/update.gif new file mode 100644 index 0000000..b2a6d0b Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/update.gif differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/resources/images/window-new.png ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/resources/images/window-new.png b/trunk/releases/0.11/src/site/resources/images/window-new.png new file mode 100644 index 0000000..0e12ef9 Binary files /dev/null and b/trunk/releases/0.11/src/site/resources/images/window-new.png differ http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/site.xml ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/site.xml b/trunk/releases/0.11/src/site/site.xml new file mode 100644 index 0000000..aeb7a5e --- /dev/null +++ b/trunk/releases/0.11/src/site/site.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project name="Falcon" xmlns="http://maven.apache.org/DECORATION/1.3.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 http://maven.apache.org/xsd/decoration-1.3.0.xsd";> + + <skin> + <groupId>org.apache.maven.skins</groupId> + <artifactId>maven-fluido-skin</artifactId> + <version>1.3.0</version> + </skin> + + <custom> + <fluidoSkin> + <project>Apache Falcon</project> + <sideBarEnabled>false</sideBarEnabled> + </fluidoSkin> + </custom> + + <bannerLeft> + <name>Apache Falcon</name> + <src>./images/falcon-logo.png</src> + <width>200px</width> + <height>45px</height> + </bannerLeft> + + <publishDate position="right"/> + <version position="right"/> + + <body> + <head> + <script type="text/javascript"> + $( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } ); + </script> + </head> + + <breadcrumbs position="left"> + <item name="Falcon" title="Apache Falcon" href="index.html"/> + </breadcrumbs> + + <footer> + é 2011-2012 The Apache Software Foundation. Apache Falcon, Falcon, Apache, the Apache feather logo, + and the Apache Falcon project logo are trademarks of The Apache Software Foundation. + </footer> + </body> +</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/twiki/Appendix.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/twiki/Appendix.twiki b/trunk/releases/0.11/src/site/twiki/Appendix.twiki new file mode 100644 index 0000000..e3752fb --- /dev/null +++ b/trunk/releases/0.11/src/site/twiki/Appendix.twiki @@ -0,0 +1,55 @@ +---+ Compatibility + +---++ 0.6-incubating Version Compatibility Matrix + + * Hadoop 2.5.0 and above + * Oozie 4.0.0 and above + * Hive 0.11.0 and above + * HCatalog 0.11.0 and above + * Active MQ 5.4.3 and above + * Titan 0.4.2 and above but below 0.5 + + +---++ 0.6-incubating Tested Compatibility + + * Hadoop 2.6.0 + * Oozie 4.1.0 + * Hive 0.14.0 + * HCatalog 0.14.0 + * Active MQ 5.4.3 + * Titan 0.4.2 + * Java 1.6, Java 1.7 + + Note : Oozie versions below 4.1.0 are not compatible with Java 1.7 + +---++ 0.6-incubating Release Notes + +Major additions are listed below. Refer to CHANGES.txt for detailed issues addressed in this release. + + * Security - Authorization, SSL + * Lineage - More complete with better API + * Recipes + * Usability improvements - Dry run, entity summary, Pagination, etc. + * Operability - Alerts, Audits, etc. + * Refactoring - Messaging, Orchestration of workflows, etc. + * Extension points for developers + * Many bug fixes + + +---++ 0.6-incubating Upgrade Instructions + +Please follow these instructions when upgrading from an older release. + +---+++ Upgrading from 0.5-incubating + +0.6-incubating is backwards *incompatible* with 0.5-incubating. It is recommended that user do not +migrate from 0.5 to 0.6. However if the user must migrate from 0.5-incubating to 0.6-incubating, +user should [[https://cwiki.apache.org/confluence/display/FALCON/Index][follow these instructions] + +---+++ Upgrading from 0.4-incubating + +It is not possible to upgrade to 0.6-incubating from 0.4-incubating. + +---+++ Upgrading from 0.3-incubating + +It is not possible to upgrade to 0.6-incubating from 0.3-incubating. http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/trunk/releases/0.11/src/site/twiki/BacklogMetricEmitterService.twiki ---------------------------------------------------------------------- diff --git a/trunk/releases/0.11/src/site/twiki/BacklogMetricEmitterService.twiki b/trunk/releases/0.11/src/site/twiki/BacklogMetricEmitterService.twiki new file mode 100644 index 0000000..f92b594 --- /dev/null +++ b/trunk/releases/0.11/src/site/twiki/BacklogMetricEmitterService.twiki @@ -0,0 +1,52 @@ +---+Back Log Emitter Service + +Back Log Emitter service keeps track of all the process which have missed an SLA for a particular time and calculates backlog. Once a notification comes that process has completed, it updates the backlog. This service keeps on sending data to Graphite for each process which is missing SLA. + +The emission and calculation of backlog are controlled by the below properties in startup.properties : + +<verbatim> +*.falcon.backlog.metricservice.emit.interval.millisecs=60000 +*.falcon.backlog.metricservice.recheck.interval.millisecs=60000 +</verbatim> + +---+How Backlog is Calculated + +Back Log Emitter Service is a listener to : + + 1. EntitySLAAlertService + 1. !WorkflowExecutionListener + + +EntitySLAListeners service notifies !BacklogEmitter whenever a process misses its shouldEndIn sla. + +!WorkflowExecutionListener notifies !BacklogEmitter service whenever a process get completed. + + +*Back Log Calculation:* + +If two instances of hourly process p1 have missed SLA for 4th and 5th hour then in 6th hourbacklog for process p1 will be ((6-4) + (6-5))*60 = 180 mins. It is cumulative in nature. + +---+Dependencies : + +*Other Services :* + +Following services and listeners should be enabled for Backlog Emitter Service in startup.properties: + +<verbatim> +##Add if you want to enable BacklogMetricService +# org.apache.falcon.service.FalconJPAService,\ +# org.apache.falcon.metrics.MetricNotificationService,\ +# org.apache.falcon.service.EntitySLAMonitoringService,\ +# org.apache.falcon.service.EntitySLAAlertService,\ +# org.apache.falcon.service.BacklogMetricEmitterService + +*.entityAlert.listeners=org.apache.falcon.service.BacklogMetricEmitterService + +*.workflow.execution.listeners=org.apache.falcon.handler.SLAMonitoringHandler +</verbatim> + + + +*Falcon Database :* +Back Log Emitter Service maintains its state in the database. It needs one table *BACKLOG_METRIC* please have a look at [[FalconDatabase]] to know how to create it. +
