Package org.apache.hadoop.yarn.util.timeline

Class TimelineUtils

java.lang.Object

org.apache.hadoop.yarn.util.timeline.TimelineUtils

@Public
@Evolving
public class TimelineUtils
extends java.lang.Object

The helper class for the timeline module.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_FLOW_VERSION
static java.lang.String	FLOW_NAME_TAG_PREFIX
static java.lang.String	FLOW_RUN_ID_TAG_PREFIX
static java.lang.String	FLOW_VERSION_TAG_PREFIX

Constructor Summary

Constructors

Constructor	Description
TimelineUtils()

Method Summary

Modifier and Type	Method	Description
static org.apache.hadoop.io.Text	buildTimelineTokenService(org.apache.hadoop.conf.Configuration conf)
static org.apache.hadoop.yarn.api.records.timeline.TimelineAbout	createTimelineAbout(java.lang.String about)
static java.lang.String	dumpTimelineRecordtoJSON(java.lang.Object o)	Serialize a POJO object into a JSON string not in a pretty format
static java.lang.String	dumpTimelineRecordtoJSON(java.lang.Object o, boolean pretty)	Serialize a POJO object into a JSON string
static java.lang.String	generateDefaultFlowName(java.lang.String appName, org.apache.hadoop.yarn.api.records.ApplicationId appId)
static java.lang.String	generateFlowNameTag(java.lang.String flowName)	Generate flow name tag.
static java.lang.String	generateFlowRunIdTag(long flowRunId)	Generate flow run ID tag.
static java.lang.String	generateFlowVersionTag(java.lang.String flowVersion)	Generate flow version tag.
static float	getTimelineServiceVersion(org.apache.hadoop.conf.Configuration conf)	Returns the timeline service version.
static java.net.InetSocketAddress	getTimelineTokenServiceAddress(org.apache.hadoop.conf.Configuration conf)
static java.lang.String	shortenFlowName(java.lang.String flowName, org.apache.hadoop.conf.Configuration conf)	Shortens the flow name for the configured size by removing UUID if present.
static boolean	timelineServiceEnabled(org.apache.hadoop.conf.Configuration conf)	Returns whether the timeline service is enabled via configuration.
static boolean	timelineServiceV1_5Enabled(org.apache.hadoop.conf.Configuration conf)	Returns whether the timeline service v.1.5 is enabled by default via configuration.

Methods inherited from class java.lang.Object

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

Field Detail

FLOW_NAME_TAG_PREFIX

public static final java.lang.String FLOW_NAME_TAG_PREFIX

See Also:

Constant Field Values

FLOW_VERSION_TAG_PREFIX

public static final java.lang.String FLOW_VERSION_TAG_PREFIX

See Also:

Constant Field Values

FLOW_RUN_ID_TAG_PREFIX

public static final java.lang.String FLOW_RUN_ID_TAG_PREFIX

See Also:

Constant Field Values

DEFAULT_FLOW_VERSION

public static final java.lang.String DEFAULT_FLOW_VERSION

See Also:

Constant Field Values

Constructor Detail

TimelineUtils

public TimelineUtils()

Method Detail

dumpTimelineRecordtoJSON

public static java.lang.String dumpTimelineRecordtoJSON(java.lang.Object o)
                                                 throws com.fasterxml.jackson.core.JsonGenerationException,
                                                        com.fasterxml.jackson.databind.JsonMappingException,
                                                        java.io.IOException

Serialize a POJO object into a JSON string not in a pretty format

Parameters:

o - an object to serialize

Returns:

a JSON string

Throws:

java.io.IOException - io error occur.

com.fasterxml.jackson.databind.JsonMappingException - exception used to signal fatal problems with mapping of content.

com.fasterxml.jackson.core.JsonGenerationException - exception type for exceptions during JSON writing.

dumpTimelineRecordtoJSON

public static java.lang.String dumpTimelineRecordtoJSON(java.lang.Object o,
                                                        boolean pretty)
                                                 throws com.fasterxml.jackson.core.JsonGenerationException,
                                                        com.fasterxml.jackson.databind.JsonMappingException,
                                                        java.io.IOException

Serialize a POJO object into a JSON string

Parameters:

o - an object to serialize

pretty - whether in a pretty format or not

Returns:

a JSON string

Throws:

java.io.IOException - io error occur.

com.fasterxml.jackson.databind.JsonMappingException - exception used to signal fatal problems with mapping of content.

com.fasterxml.jackson.core.JsonGenerationException - exception type for exceptions during JSON writing.

timelineServiceEnabled

public static boolean timelineServiceEnabled(org.apache.hadoop.conf.Configuration conf)

Returns whether the timeline service is enabled via configuration.

Parameters:

conf - the configuration

Returns:

whether the timeline service is enabled.

getTimelineServiceVersion

public static float getTimelineServiceVersion(org.apache.hadoop.conf.Configuration conf)

Returns the timeline service version. It does not check whether the timeline service itself is enabled.

Parameters:

conf - the configuration

Returns:

the timeline service version as a float.

timelineServiceV1_5Enabled

public static boolean timelineServiceV1_5Enabled(org.apache.hadoop.conf.Configuration conf)

Returns whether the timeline service v.1.5 is enabled by default via configuration.

Parameters:

conf - the configuration

Returns:

whether the timeline service v.1.5 is enabled. V.1.5 refers to a version equal to 1.5.

createTimelineAbout

public static org.apache.hadoop.yarn.api.records.timeline.TimelineAbout createTimelineAbout(java.lang.String about)

getTimelineTokenServiceAddress

public static java.net.InetSocketAddress getTimelineTokenServiceAddress(org.apache.hadoop.conf.Configuration conf)

buildTimelineTokenService

public static org.apache.hadoop.io.Text buildTimelineTokenService(org.apache.hadoop.conf.Configuration conf)

generateDefaultFlowName

public static java.lang.String generateDefaultFlowName(java.lang.String appName,
                                                       org.apache.hadoop.yarn.api.records.ApplicationId appId)

generateFlowNameTag

public static java.lang.String generateFlowNameTag(java.lang.String flowName)

Generate flow name tag.

Parameters:

flowName - flow name that identifies a distinct flow application which can be run repeatedly over time

Returns:

flow name tag.

shortenFlowName

public static java.lang.String shortenFlowName(java.lang.String flowName,
                                               org.apache.hadoop.conf.Configuration conf)

Shortens the flow name for the configured size by removing UUID if present.

Parameters:

flowName - which has to be shortened

conf - to resize the flow name

Returns:

shortened flowName

generateFlowVersionTag

public static java.lang.String generateFlowVersionTag(java.lang.String flowVersion)

Generate flow version tag.

Parameters:

flowVersion - flow version that keeps track of the changes made to the flow

Returns:

flow version tag.

generateFlowRunIdTag

public static java.lang.String generateFlowRunIdTag(long flowRunId)

Generate flow run ID tag.

Parameters:

flowRunId - flow run ID that identifies one instance (or specific execution) of that flow

Returns:

flow run id tag.