Class MetricAdmin

    • Constructor Detail

      • MetricAdmin

        public MetricAdmin()
    • Method Detail

      • enableDefaultMetrics

        public boolean enableDefaultMetrics()
        Description copied from interface: MetricAdminMBean
        Starts the default AWS SDK metric collector, but only if no metric collector is currently in use at the AWS SDK level.
        Specified by:
        enableDefaultMetrics in interface MetricAdminMBean
        Returns:
        true if the default AWS SDK metric collector has been successfully started by this call; false otherwise.
      • isMetricsEnabled

        public boolean isMetricsEnabled()
        Description copied from interface: MetricAdminMBean
        Returns true if metrics at the AWS SDK level is enabled; false if disabled.
        Specified by:
        isMetricsEnabled in interface MetricAdminMBean
      • setMachineMetricsExcluded

        public void setMachineMetricsExcluded​(boolean excludeJvmMetrics)
        Description copied from interface: MetricAdminMBean
        Used to set whether the JVM metrics is to be excluded.
        Specified by:
        setMachineMetricsExcluded in interface MetricAdminMBean
        Parameters:
        excludeJvmMetrics - true if JVM metrics is to be excluded; false otherwise.
      • getRegion

        public String getRegion()
        Description copied from interface: MetricAdminMBean
        Returns the region configured for the default AWS SDK metric collector; or null if the default is to be used.
        Specified by:
        getRegion in interface MetricAdminMBean
      • setRegion

        public void setRegion​(String region)
        Description copied from interface: MetricAdminMBean
        Sets the region to be used for the default AWS SDK metric collector; or null if the default is to be used.
        Specified by:
        setRegion in interface MetricAdminMBean
      • getMetricQueueSize

        public Integer getMetricQueueSize()
        Description copied from interface: MetricAdminMBean
        Returns the internal metric queue size to be used for the default AWS SDK metric collector; or null if the default is to be used.
        Specified by:
        getMetricQueueSize in interface MetricAdminMBean
      • setMetricQueueSize

        public void setMetricQueueSize​(Integer metricQueueSize)
        Description copied from interface: MetricAdminMBean
        Sets the metric queue size to be used for the default AWS SDK metric collector; or null if the default is to be used.
        Specified by:
        setMetricQueueSize in interface MetricAdminMBean
      • getQueuePollTimeoutMilli

        public Integer getQueuePollTimeoutMilli()
        Description copied from interface: MetricAdminMBean
        Returns the internal metric queue timeout in millisecond to be used for the default AWS SDK metric collector; or null if the default is to be used. Use Integer instead of Long as it seems jconsole does not handle Long properly.
        Specified by:
        getQueuePollTimeoutMilli in interface MetricAdminMBean
      • setQueuePollTimeoutMilli

        public void setQueuePollTimeoutMilli​(Integer timeoutMilli)
        Description copied from interface: MetricAdminMBean
        Sets the queue poll time in millisecond to be used for the default AWS SDK metric collector; or null if the default is to be used. Use Integer instead of Long as it seems jconsole does not handle Long properly.
        Specified by:
        setQueuePollTimeoutMilli in interface MetricAdminMBean
      • setPerHostMetricsIncluded

        public void setPerHostMetricsIncluded​(boolean includePerHostMetrics)
        Description copied from interface: MetricAdminMBean
        Used to set whether the per-host metrics is to be included.
        Specified by:
        setPerHostMetricsIncluded in interface MetricAdminMBean
        Parameters:
        includePerHostMetrics - true if per-host metrics is to be included; false otherwise.
      • getJvmMetricName

        public String getJvmMetricName()
        Description copied from interface: MetricAdminMBean
        Returns the JVM metric name. If the returned value is either null or blank, no JVM level metrics will be generated.
        Specified by:
        getJvmMetricName in interface MetricAdminMBean
      • setJvmMetricName

        public void setJvmMetricName​(String jvmMetricName)
        Description copied from interface: MetricAdminMBean
        Sets the JVM metric name to enable per-JVM level metrics generation. If the given value is either null or blank, no JVM level metrics will be generated.
        Specified by:
        setJvmMetricName in interface MetricAdminMBean
      • setHostMetricName

        public void setHostMetricName​(String hostMetricName)
        Description copied from interface: MetricAdminMBean
        Sets the host name to enable per-host level metrics generation. If the given value is either null or blank but the per-host metric is enabled, the host name will be automatically detected via InetAddress.
        Specified by:
        setHostMetricName in interface MetricAdminMBean
      • setSingleMetricNamespace

        public void setSingleMetricNamespace​(boolean singleMetricNamespace)
        Description copied from interface: MetricAdminMBean
        Used to set whether a single metric name space is to be used.
        Specified by:
        setSingleMetricNamespace in interface MetricAdminMBean