AMBARI-18301. Log search, url params description. (Dharmesh Makwana via oleewere)
Project: http://git-wip-us.apache.org/repos/asf/ambari/repo Commit: http://git-wip-us.apache.org/repos/asf/ambari/commit/35a8c0e7 Tree: http://git-wip-us.apache.org/repos/asf/ambari/tree/35a8c0e7 Diff: http://git-wip-us.apache.org/repos/asf/ambari/diff/35a8c0e7 Branch: refs/heads/trunk Commit: 35a8c0e77ff5a6317e8eb11bf3dad4d0cb2f1498 Parents: dfeea2d Author: oleewere <[email protected]> Authored: Fri Sep 2 12:02:39 2016 +0200 Committer: oleewere <[email protected]> Committed: Sat Nov 5 16:05:13 2016 +0100 ---------------------------------------------------------------------- .../ambari/logsearch/doc/DocConstants.java | 152 +++++++++---------- 1 file changed, 76 insertions(+), 76 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ambari/blob/35a8c0e7/ambari-logsearch/ambari-logsearch-portal/src/main/java/org/apache/ambari/logsearch/doc/DocConstants.java ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-portal/src/main/java/org/apache/ambari/logsearch/doc/DocConstants.java b/ambari-logsearch/ambari-logsearch-portal/src/main/java/org/apache/ambari/logsearch/doc/DocConstants.java index c14fc08..0ceb76b 100644 --- a/ambari-logsearch/ambari-logsearch-portal/src/main/java/org/apache/ambari/logsearch/doc/DocConstants.java +++ b/ambari-logsearch/ambari-logsearch-portal/src/main/java/org/apache/ambari/logsearch/doc/DocConstants.java @@ -21,96 +21,96 @@ package org.apache.ambari.logsearch.doc; public class DocConstants { public class CommonDescriptions { - public static final String X_AXIS_D = ""; - public static final String Y_AXIS_D = ""; - public static final String STACK_BY_D = ""; - public static final String EXCLUDE_QUERY_D = ""; - public static final String INCLUDE_QUERY_D = ""; - public static final String MUST_BE_D = ""; - public static final String MUST_NOT_D = ""; - public static final String FROM_D = ""; - public static final String TO_D = ""; - public static final String UNIT_D = ""; - public static final String QUERY_D = ""; - public static final String COLUMN_QUERY_D = ""; - public static final String I_MESSAGE_D = ""; - public static final String G_E_MESSAGE_D = ""; - public static final String E_MESSAGE_D = ""; + public static final String X_AXIS_D = "The column which can be value for x-axis in graph formation"; + public static final String Y_AXIS_D = "The column which can be value for y-axis in graph formation"; + public static final String STACK_BY_D = "The graph property for stacking the plot"; + public static final String EXCLUDE_QUERY_D = "Exclude the values in query result e.g.: [{message:*timeout*}]"; + public static final String INCLUDE_QUERY_D = "Include the values in query result e.g.: [{message:*exception*}]"; + public static final String MUST_BE_D = "Include the components, comman separated values"; + public static final String MUST_NOT_D = "Exclude the components, comman separated values"; + public static final String FROM_D = "Date range param, start date"; + public static final String TO_D = "Date range param, end date"; + public static final String UNIT_D = "Aggregate the data with time gap as unit i.e 1MINUTE"; + public static final String QUERY_D = "not required"; + public static final String COLUMN_QUERY_D = "not required"; + public static final String I_MESSAGE_D = "Include query which will query againt message column"; + public static final String G_E_MESSAGE_D = "not required"; + public static final String E_MESSAGE_D = "Exclude query which will query againt message column"; public static final String IS_LAST_PAGE_D = ""; - public static final String FIELD_D = ""; - public static final String FORMAT_D = ""; + public static final String FIELD_D = "Get top ten values for particular field"; + public static final String FORMAT_D = "File Export format, can be 'txt' or 'json'"; } public class AuditOperationDescriptions { - public static final String GET_AUDIT_SCHEMA_FIELD_LIST_OD = ""; - public static final String GET_AUDIT_LOGS_OD = ""; - public static final String GET_AUDIT_COMPONENTS_OD = ""; - public static final String GET_AUDIT_LINE_GRAPH_DATA_OD = ""; - public static final String GET_TOP_AUDIT_USERS_OD = ""; - public static final String GET_TOP_AUDIT_RESOURCES_OD = ""; - public static final String GET_TOP_AUDIT_COMPONENTS_OD = ""; - public static final String GET_LIVE_LOGS_COUNT_OD = ""; - public static final String GET_REQUEST_USER_LINE_GRAPH_OD = ""; - public static final String GET_ANY_GRAPH_DATA_OD = ""; - public static final String EXPORT_USER_TALBE_TO_TEXT_FILE_OD = ""; - public static final String GET_SERVICE_LOAD_OD = ""; + public static final String GET_AUDIT_SCHEMA_FIELD_LIST_OD = "Get list of schema fields in audit collection"; + public static final String GET_AUDIT_LOGS_OD = "Get the list of logs details"; + public static final String GET_AUDIT_COMPONENTS_OD = "Get the list of audit components currently active or having data in Solr"; + public static final String GET_AUDIT_LINE_GRAPH_DATA_OD = "Get the data required for line graph"; + public static final String GET_TOP_AUDIT_USERS_OD = "Get the top audit users having maximum access"; + public static final String GET_TOP_AUDIT_RESOURCES_OD = "Get the top audit resources having maximum access"; + public static final String GET_TOP_AUDIT_COMPONENTS_OD = "not required"; + public static final String GET_LIVE_LOGS_COUNT_OD = "not required"; + public static final String GET_REQUEST_USER_LINE_GRAPH_OD = "not required"; + public static final String GET_ANY_GRAPH_DATA_OD = "Get the data generic enough to use for graph plots"; + public static final String EXPORT_USER_TALBE_TO_TEXT_FILE_OD = "Export the tables shown on Audit tab"; + public static final String GET_SERVICE_LOAD_OD = "The graph for showing the top users accessing the services"; } public class ServiceDescriptions { - public static final String LEVEL_D = ""; - public static final String ADVANCED_SEARCH_D = ""; - public static final String TREE_PARAMS_D = ""; - public static final String START_TIME_D = ""; - public static final String END_TIME_D = ""; - public static final String FILE_NAME_D = ""; - public static final String HOST_NAME_D = ""; - public static final String COMPONENT_NAME_D = ""; - public static final String FIND_D = ""; - public static final String ID_D = ""; - public static final String HOST_D = ""; - public static final String COMPONENT_D = ""; - public static final String KEYWORD_TYPE_D = ""; - public static final String TOKEN_D = ""; - public static final String SOURCE_LOG_ID_D = ""; - public static final String G_MUST_NOT_D = ""; - public static final String NUMBER_ROWS_D = ""; - public static final String SCROLL_TYPE_D = ""; - public static final String UTC_OFFSET_D = ""; + public static final String LEVEL_D = "filter for log level"; + public static final String ADVANCED_SEARCH_D = "not required"; + public static final String TREE_PARAMS_D = "Host hierarchy shown on UI,filtering there is supported by this param"; + public static final String START_TIME_D = "Date range param which is suportted from browser url"; + public static final String END_TIME_D = "Date range param which is supported from browser url"; + public static final String FILE_NAME_D = "File name filter which is supported from browser url"; + public static final String HOST_NAME_D = "Host name filter which is supported from browser url"; + public static final String COMPONENT_NAME_D = "Component name filter which is supported from browser url"; + public static final String FIND_D = "Finding particular text on subsequent pages in case of table view with pagination"; + public static final String ID_D = "Log id value for traversing to that particular record with that log id"; + public static final String HOST_D = "filter for host"; + public static final String COMPONENT_D = "filter for component"; + public static final String KEYWORD_TYPE_D = "Serching the find param value in previous or next in paginated table"; + public static final String TOKEN_D = "unique number used along with FIND_D. The request can be canceled using this token"; + public static final String SOURCE_LOG_ID_D = "fetch the record set having that log Id"; + public static final String G_MUST_NOT_D = "not required"; + public static final String NUMBER_ROWS_D = "Getting rows after particular log entry - used in 'Preview' option"; + public static final String SCROLL_TYPE_D = "Used in 'Preview' feature for getting records 'after' or 'before'"; + public static final String UTC_OFFSET_D = "timezone offset"; } public class ServiceOperationDescriptions { - public static final String SEARCH_LOGS_OD = ""; - public static final String GET_HOSTS_OD = ""; - public static final String GET_COMPONENTS_OD = ""; - public static final String GET_AGGREGATED_INFO_OD = ""; - public static final String GET_LOG_LEVELS_COUNT_OD = ""; - public static final String GET_COMPONENTS_COUNT_OD = ""; - public static final String GET_HOSTS_COUNT_OD = ""; - public static final String GET_TREE_EXTENSION_OD = ""; - public static final String GET_HISTOGRAM_DATA_OD = ""; - public static final String CANCEL_FIND_REQUEST_OD = ""; - public static final String EXPORT_TO_TEXT_FILE_OD = ""; - public static final String GET_COMPONENT_LIST_WITH_LEVEL_COUNT_OD = ""; - public static final String GET_EXTREME_DATES_FOR_BUNDLE_ID_OD = ""; - public static final String GET_SERVICE_LOGS_FIELD_NAME_OD = ""; - public static final String GET_ANY_GRAPH_DATA_OD = ""; - public static final String GET_AFTER_BEFORE_LOGS_OD = ""; - public static final String GET_HOST_LIST_BY_COMPONENT_OD = ""; - public static final String GET_SERVICE_LOGS_SCHEMA_FIELD_NAME_OD = ""; - public static final String GET_HADOOP_SERVICE_CONFIG_JSON_OD = ""; + public static final String SEARCH_LOGS_OD = "Searching logs entry"; + public static final String GET_HOSTS_OD = "Get the list of service hosts currently active or having data in Solr"; + public static final String GET_COMPONENTS_OD = "Get the list of service components currently active or having data in Solr"; + public static final String GET_AGGREGATED_INFO_OD = "not required"; + public static final String GET_LOG_LEVELS_COUNT_OD = "Get Log levels with their counts"; + public static final String GET_COMPONENTS_COUNT_OD = "Get components with their counts"; + public static final String GET_HOSTS_COUNT_OD = "Get hosts with their counts"; + public static final String GET_TREE_EXTENSION_OD = "Get host and compoenets hierarchy"; + public static final String GET_HISTOGRAM_DATA_OD = "Get data for histogram"; + public static final String CANCEL_FIND_REQUEST_OD = "Cancel the FIND_D param request using TOKEN_D"; + public static final String EXPORT_TO_TEXT_FILE_OD = "Export the table data in file"; + public static final String GET_COMPONENT_LIST_WITH_LEVEL_COUNT_OD = "Get components with log level distribution count"; + public static final String GET_EXTREME_DATES_FOR_BUNDLE_ID_OD = "Get the start and end time of particular bundle_id"; + public static final String GET_SERVICE_LOGS_FIELD_NAME_OD = "Get service logs schema fields name (Human readable)"; + public static final String GET_ANY_GRAPH_DATA_OD = "Get the data generic enough to use for graph plots"; + public static final String GET_AFTER_BEFORE_LOGS_OD = "Preview feature data"; + public static final String GET_HOST_LIST_BY_COMPONENT_OD = "Get host list of components"; + public static final String GET_SERVICE_LOGS_SCHEMA_FIELD_NAME_OD = "Get service logs schema fields"; + public static final String GET_HADOOP_SERVICE_CONFIG_JSON_OD = "Get the json having meta data of services supported by logsearch"; } public class LogFileDescriptions { - public static final String HOST_D = ""; - public static final String COMPONENT_D = ""; - public static final String LOG_TYPE_D = ""; - public static final String TAIL_SIZE_D = ""; + public static final String HOST_D = "not required"; + public static final String COMPONENT_D = "not required"; + public static final String LOG_TYPE_D = "not required"; + public static final String TAIL_SIZE_D = "not required"; } public class LogFileOperationDescriptions { - public static final String SEARCH_LOG_FILES_OD = ""; - public static final String GET_LOG_FILE_TAIL_OD = ""; + public static final String SEARCH_LOG_FILES_OD = "not required"; + public static final String GET_LOG_FILE_TAIL_OD = "not required"; } public class PublicOperationDescriptions { @@ -118,9 +118,9 @@ public class DocConstants { } public class UserConfigDescriptions { - public static final String USER_ID_D = ""; - public static final String FILTER_NAME_D = ""; - public static final String ROW_TYPE_D = ""; + public static final String USER_ID_D = "Get config for a particular user id"; + public static final String FILTER_NAME_D = "The saved query as filter in Solr, search is sopprted by this param"; + public static final String ROW_TYPE_D = "Row type is solr to identify as filter query"; } public class UserConfigOperationDescriptions {
