org.apache.ambari.server.controller.logging

Interface LoggingRequestHelper

All Known Implementing Classes:

LoggingRequestHelperImpl

public interface LoggingRequestHelper

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.

Method Summary

Modifier and Type	Method and Description
String	createLogFileTailURI(String baseURI, String componentName, String hostName) Appends the required LogSearch query parameters to a base URI
HostLogFilesResponse	sendGetLogFileNamesRequest(String hostName) Sends a request to obtain the log file names for a given host
LogLevelQueryResponse	sendLogLevelQueryRequest(String componentName, String hostName) Sends a request to obtain the log level counts for a given component on a given host
LogQueryResponse	sendQueryRequest(Map<String,String> queryParameters) Sends a search query request to the LogSearch server

Method Detail

sendQueryRequest

LogQueryResponse sendQueryRequest(Map<String,String> queryParameters)

Sends a search query request to the LogSearch server

Parameters:

queryParameters - the query parameters to pass to LogSearch

Returns:

a LogQueryResponse, containing the results of the search

sendGetLogFileNamesRequest

HostLogFilesResponse sendGetLogFileNamesRequest(String hostName)

Sends a request to obtain the log file names for a given host

Parameters:

hostName - the host name

Returns:

a HostLogFilesResponse, containing include the log file names for components associated with a hostname

sendLogLevelQueryRequest

LogLevelQueryResponse sendLogLevelQueryRequest(String componentName,
                                               String hostName)

Sends a request to obtain the log level counts for a given component on a given host

Parameters:

componentName - the component name

hostName - the host name

Returns:

a LogLevelQueryResponse, containing the log level counts for this component/host combination

createLogFileTailURI

String createLogFileTailURI(String baseURI,
                            String componentName,
                            String hostName)

Appends the required LogSearch query parameters to a base URI

Parameters:

baseURI - the base URI for this request, typically the URI to the Ambari Integration searchEngine component

componentName - the component name

hostName - the host name

Returns:

a URI String that refers to the tail results of the log file associated with this component/host combination