org.apache.ambari.server.controller.metrics

Interface MetricHostProvider

All Known Implementing Classes:

AbstractProviderModule, DefaultProviderModule, OverriddenMetricsHostProvider

public interface MetricHostProvider

Method Summary

Modifier and Type	Method and Description
String	getCollectorHostName(String clusterName, MetricsServiceProvider.MetricsService service) Get the metrics server host name for the given cluster name.
String	getCollectorPort(String clusterName, MetricsServiceProvider.MetricsService service) Get the metrics server port for the given cluster name.
default Optional<String>	getExternalHostName(String clusterName, String componentName) If a component is installed to a host that is managed outside of Ambari (for example OneFS) then this method will return the external hostname.
String	getHostName(String clusterName, String componentName) Get the host name for the given cluster name and component name.
boolean	isCollectorComponentLive(String clusterName, MetricsServiceProvider.MetricsService service) Get the status of metrics server component for the given cluster name.
boolean	isCollectorHostExternal(String clusterName) Is the collector host external to the cluster?
boolean	isCollectorHostLive(String clusterName, MetricsServiceProvider.MetricsService service) Get the status of metrics server host for the given cluster name.

Method Detail

getCollectorHostName

String getCollectorHostName(String clusterName,
                            MetricsServiceProvider.MetricsService service)
                     throws SystemException

Get the metrics server host name for the given cluster name.

Parameters:

clusterName - the cluster name

Returns:

the metrics server

Throws:

SystemException - if unable to get the metrics server host name

getHostName

String getHostName(String clusterName,
                   String componentName)
            throws SystemException

Get the host name for the given cluster name and component name.

Parameters:

clusterName - the cluster name

componentName - the component name

Returns:

the host name

Throws:

SystemException - if unable to get the JMX host name

getCollectorPort

String getCollectorPort(String clusterName,
                        MetricsServiceProvider.MetricsService service)
                 throws SystemException

Get the metrics server port for the given cluster name.

Parameters:

clusterName - the cluster name

Returns:

the metrics server

Throws:

SystemException - if unable to get the metrics server port

isCollectorHostLive

boolean isCollectorHostLive(String clusterName,
                            MetricsServiceProvider.MetricsService service)
                     throws SystemException

Get the status of metrics server host for the given cluster name.

Parameters:

clusterName - the cluster name

Returns:

true if heartbeat with metrics server host wasn't lost

Throws:

SystemException - if unable to get the status of metrics server host

isCollectorComponentLive

boolean isCollectorComponentLive(String clusterName,
                                 MetricsServiceProvider.MetricsService service)
                          throws SystemException

Get the status of metrics server component for the given cluster name.

Parameters:

clusterName - the cluster name

Returns:

true if metrics server component is started

Throws:

SystemException - if unable to get the status of metrics server component

getExternalHostName

default Optional<String> getExternalHostName(String clusterName,
                                             String componentName)

If a component is installed to a host that is managed outside of Ambari (for example OneFS) then this method will return the external hostname.

isCollectorHostExternal

boolean isCollectorHostExternal(String clusterName)

Is the collector host external to the cluster?

Parameters:

clusterName - the cluster name

Returns:

true if metrics server component is NOT in this cluster