REST API Support Engineer Report Plug-In

INFO

A version of Datameer X with the Support Engineer Report Plug-In.

List All the Available Environment Options

Request Method	GET
Description	Lists all available environment options.
Prerequisites	The plug-in "Support Engineer Report Plug-in" must be installed and enabled. The capability ADMINISTRATION_ACCESS is required.
URI Syntax	curl -u '<username>:<password>' 'http://<Datameer-serverIP>:<port-number>/ext/support-engineer-report/envOptions'
Example Response	{ "propertyTable": "dap database property table", "systemProperties": "system properties like java.class.path, java.home, os.arch, os.name, os.version", "macAddress": "MAC address of first network adapter", "plugins": "data about the plugins e.g. names of all available and registered plugins", "hadoopConfiguration": "the Hadoop configuration", "distProperties": "values from dist.properties like revision, version, hadoopDistribution", "nativeLibs": "native library data like java.library.path, compression codecs, native Hadoop code loaded, native Hadoop Libs", "configurationFiles": "various property files e.g. default.properties, das-env.sh and {deployMode}.properties", "devPage": "various data from the datameer dev page like User, Deploy Mode, Memory, Processors, Webserver URL, JVM Version, JVM Arguments, JVM Start Time, Charset, Timezone", "mergedProperties": "merged default.properties, {deployMode}.properties and jvm system properties", "authenticationConfiguration": "data from section authentication at Datameer X admin page" }
Additional Notes

List a Specific Environment Information

Request Method	GET
Description	Shows the information which the parameter of '?envOption' encodes: e.g. for 'macAddress' all mac addresses of 'List All the Available Environment Options' are listed.
Prerequisites	The plug-in "Support Engineer Report Plug-in" must be installed and enabled. The capability ADMINISTRATION_ACCESS is required.
URI Syntax	curl -u '<username>:<password>' 'http://<Datameer-serverIP>:<port-number>/ext/support-engineer-report/envInfos?envOption=macAddress'
Example Response	{ "macAddress": "<MAC-address>" }
Additional Notes	More than one argument can be used to list a set of environment information, e.g. with '?envOption=macAddress&envOption=devPage' for fetching macAdresses and dev page information.

List All Log Files Available for Download

Request Method	GET
Description	Lists all log files that are available for a download.
Prerequisites	The plug-in "Support Engineer Report Plug-in" must be installed and enabled. The capability ADMINISTRATION_ACCESS is required.
URI Syntax	curl -u '<username>:<password>' 'http://<Datameer-serverIP>:<port-number>/ext/support-engineer-report/logFiles'
Example Response	{ "files": [ "audit.log", "conductor.log", "hadoop-metrics.log", "hadoop-metrics.log.2018-05-07", "housekeeping.log", "housekeeping.log.1", "httperror.log", "httperror.log.2018-05-07", "job_execution_trace.log", "metrics-jamon.log", "metrics-jamon.log.2018-05-08", "metrics.log", "rollback-error.log", "rta-sql-query.log", "runtime-analytics-query.log", "runtime-analytics.log", "smart_decision_prerequisites.log", "useraction.log", "volume.log", "workbook-preview-service.log", "workbook_undo.log" ] }
Additional Notes

Download a Single Log File

Request Method	GET
Description	Downloads a given log file in plain text.
Prerequisites	The plug-in "Support Engineer Report Plug-in" must be installed and enabled. The capability ADMINISTRATION_ACCESS is required.
URI Syntax	curl -u '<username>:<password>' 'http: //<Datameer-serverIP> :<port-number> /ext/support-engineer-report/logFile/<log-name> /download'
Example Response	2017-09-15 10:26:15,1344,1.3 KB,1.2 GB/3.6 GB (34.84%),1,1,3817865216,1.3 KB/1.2 GB (1.0E-4%),1330181728,1,1 2017-09-15 10:28:09,19120,18.7 KB,850.0 MB/3.6 GB (23.34%),1,5,3817865216,18.7 KB/850.0 MB (0.0021%),891258504,1,1 2017-09-15 10:29:21,60864,59.4 KB,223.0 MB/3.6 GB (6.13%),1,11,3817865216,59.4 KB/223.0 MB (0.026%),233875952,1,1 2017-09-15 10:30:49,67264,65.7 KB,871.6 MB/3.6 GB (23.94%),1,11,3817865216,65.7 KB/871.6 MB (0.0074%),913972440,1,1 2017-09-15 17:43:50,1344,1.3 KB,646.4 MB/3.6 GB (17.75%),1,1,3817865216,1.3 KB/646.4 MB (2.0E-4%),677814968,1,1 2017-09-15 17:51:35,1344,1.3 KB,255.5 MB/3.6 GB (7.02%),1,1,3817865216,1.3 KB/255.5 MB (5.0E-4%),267911312,1,1 2017-09-15 18:37:16,1344,1.3 KB,877.0 MB/3.6 GB (24.09%),1,1,3817865216,1.3 KB/877.0 MB (1.0E-4%),919582896,1,1 2017-09-18 10:01:54,1344,1.3 KB,533.3 MB/3.6 GB (14.65%),1,1,3817865216,1.3 KB/533.3 MB (2.0E-4%),559208600,1,1 2017-09-18 18:13:39,1344,1.3 KB,393.1 MB/3.6 GB (10.8%),1,1,3817865216,1.3 KB/393.1 MB (3.0E-4%),412213376,1,1 ... 2018-05-29 10:41:38,45224,44.2 KB,1.1 GB/3.6 GB (31.15%),1,1,3817865216,44.2 KB/1.1 GB (0.0038%),1189223728,1,1 2018-06-01 09:48:22,3840,3.8 KB,644.7 MB/3.6 GB (17.71%),1,1,3817865216,3.8 KB/644.7 MB (6.0E-4%),676042416,1,1
Additional Notes

Download a Single Log File as a Zip

Request Method	GET
Description	Downloads a given log file compressed as zip file.
Prerequisites	The plug-in "Support Engineer Report Plug-in" must be installed and enabled. The capability ADMINISTRATION_ACCESS is required.
URI Syntax	curl -u '<username>:<password>' 'http: //<Datameer-serverIP> :<port-number>/ ext/support-engineer-report/logFile/<log-name> /zip > <name-the-file>.zip'
Example Response	No response.

Download Specified Environment Information and Log Files

Request Method	POST
Prerequisites	The plug-in "Support Engineer Report Plug-in" must be installed and enabled. The capability ADMINISTRATION_ACCESS is required.
Description	A combination of downloading specific environment information and log files within one task.
URI Syntax	curl -u '<username>:<password>' -X POST --data-binary @<upload.json> -H 'Content-Type: application/json' 'http://<Datameer-serverIP>:<port-number>/ext/support-engineer-report/all' > <name-the-file>.zip
Example Response	INFO: The response will be delivered as a zip file in every case. Example input for the JSON: { logFiles: { "logFile1.log", "logFile2.log" }, environmentOptions: { "macAddress" } }