org.apache.flink.runtime.util

Class EnvironmentInformation

java.lang.Object

org.apache.flink.runtime.util.EnvironmentInformation

public class EnvironmentInformation
extends Object

Utility class that gives access to the execution environment of the JVM, like the executing user, startup options, or the JVM version.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnvironmentInformation.RevisionInformation

Method Summary

Methods

Modifier and Type	Method and Description
static String	getJvmStartupOptions()
static String	getJvmVersion()
static long	getMaxJvmHeapMemory() The maximum JVM heap size, in bytes.
static EnvironmentInformation.RevisionInformation	getRevisionInformation() Returns the code revision (commit and commit date) of Flink.
static long	getSizeOfFreeHeapMemory() Gets an estimate of the size of the free heap memory.
static long	getSizeOfFreeHeapMemoryWithDefrag() Gets an estimate of the size of the free heap memory.
static String	getTemporaryFileDirectory()
static String	getUserRunning() Gets the name of the user that is running the JVM.
static String	getVersion() Returns the version of the code as String.
static void	logEnvironmentInfo(org.slf4j.Logger log, String componentName)
static void	main(String[] args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getVersion

public static String getVersion()

Returns the version of the code as String. If version == null, then the JobManager does not run from a Maven build. An example is a source code checkout, compile, and run from inside an IDE.

Returns:

The version string.

getRevisionInformation

public static EnvironmentInformation.RevisionInformation getRevisionInformation()

Returns the code revision (commit and commit date) of Flink.

Returns:

The code revision.

getUserRunning

public static String getUserRunning()

Gets the name of the user that is running the JVM.

Returns:

The name of the user that is running the JVM.

getMaxJvmHeapMemory

public static long getMaxJvmHeapMemory()

The maximum JVM heap size, in bytes.

Returns:

The maximum JVM heap size, in bytes.

getSizeOfFreeHeapMemoryWithDefrag

public static long getSizeOfFreeHeapMemoryWithDefrag()

Gets an estimate of the size of the free heap memory. NOTE: This method is heavy-weight. It triggers a garbage collection to reduce fragmentation and get a better estimate at the size of free memory. It is typically more accurate than the plain version getSizeOfFreeHeapMemory().

Returns:

An estimate of the size of the free heap memory, in bytes.

getSizeOfFreeHeapMemory

public static long getSizeOfFreeHeapMemory()

Gets an estimate of the size of the free heap memory. The estimate may vary, depending on the current level of memory fragmentation and the number of dead objects. For a better (but more heavy-weight) estimate, use getSizeOfFreeHeapMemoryWithDefrag().

Returns:

An estimate of the size of the free heap memory, in bytes.

getJvmVersion

public static String getJvmVersion()

getJvmStartupOptions

public static String getJvmStartupOptions()

getTemporaryFileDirectory

public static String getTemporaryFileDirectory()

logEnvironmentInfo

public static void logEnvironmentInfo(org.slf4j.Logger log,
                      String componentName)

main

public static void main(String[] args)