com.alibaba.csp.sentinel.node.metric

Class MetricWriter

java.lang.Object

com.alibaba.csp.sentinel.node.metric.MetricWriter

public class MetricWriter
extends Object

This class is responsible for writing MetricNode to disk:

1. metric with the same second should write to the same file;
2. single file size must be controlled;
3. file name is like: ${appName}-metrics.log.pid${pid}.yyyy-MM-dd.[number]
4. metric of different day should in different file;
5. every metric file is accompanied with an index file, which file name is ${metricFileName}.idx

Author:

Carpenter Lee

Field Summary

Fields

Modifier and Type	Field and Description
static String	METRIC_BASE_DIR
static String	METRIC_FILE Note: MetricFileNameComparator's implementation relies on the metric file name, so we should be careful when changing the metric file name.
static String	METRIC_FILE_INDEX_SUFFIX
static Comparator<String>	METRIC_FILE_NAME_CMP

Constructor Summary

Constructors

Constructor and Description
MetricWriter(long singleFileSize)
MetricWriter(long singleFileSize, int totalFileCount)

Method Summary

Modifier and Type	Method and Description
void	close()
static boolean	fileNameMatches(String fileName, String baseFileName) Test whether fileName matches baseFileName.
static String	formIndexFileName(String metricFileName) Form index file name of the metricFileName
static String	formMetricFileName(String appName, int pid) Form metric file name use the specific appName and pid.
void	write(long time, List<MetricNode> nodes) 如果传入了time，就认为nodes中所有的时间时间戳都是time.

Methods inherited from class java.lang.Object

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

Field Detail

METRIC_BASE_DIR

public static final String METRIC_BASE_DIR

METRIC_FILE

public static final String METRIC_FILE

Note: MetricFileNameComparator's implementation relies on the metric file name, so we should be careful when changing the metric file name.

See Also:

formMetricFileName(String, int), Constant Field Values

METRIC_FILE_INDEX_SUFFIX

public static final String METRIC_FILE_INDEX_SUFFIX

See Also:

Constant Field Values

METRIC_FILE_NAME_CMP

public static final Comparator<String> METRIC_FILE_NAME_CMP

Constructor Detail

MetricWriter

public MetricWriter(long singleFileSize)

MetricWriter

public MetricWriter(long singleFileSize,
                    int totalFileCount)

Method Detail

write

public void write(long time,
                  List<MetricNode> nodes)
           throws Exception

如果传入了time，就认为nodes中所有的时间时间戳都是time.

Parameters:

time -

nodes -

Throws:

Exception

close

public void close()
           throws Exception

Throws:

Exception

fileNameMatches

public static boolean fileNameMatches(String fileName,
                                      String baseFileName)

Test whether fileName matches baseFileName. fileName matches baseFileName when

 fileName = baseFileName + ".yyyy-MM-dd.number"
 

Parameters:

fileName - file name

baseFileName - base file name.

Returns:

if fileName matches baseFileName return true, else return false.

formMetricFileName

public static String formMetricFileName(String appName,
                                        int pid)

Form metric file name use the specific appName and pid. Note that only form the file name, not include path. Note: MetricFileNameComparator's implementation relays on the metric file name, we should be careful when changing the metric file name.

Parameters:

appName -

pid -

Returns:

metric file name.

formIndexFileName

public static String formIndexFileName(String metricFileName)

Form index file name of the metricFileName

Parameters:

metricFileName -

Returns:

the index file name of the metricFileName