NetLogger summarization API

From NetLogger

Contents 1 Overview 1.1 Files 1.2 Classes 1.3 Defines 1.4 Functions 2 Define Documentation 2.1 Default event name 3 Function Documentation

Overview

Files

file nltransfer.h

Classes

struct	tsumm_data

Defines

#define 	NLTSUMM_P_INTERVAL   "interval"
#define 	NLTSUMM_P_MIN   "min"
#define 	NLTSUMM_P_MAX   "max"
#define 	NLTSUMM_P_VARBASE   "variance-baseline"
#define 	NLTSUMM_P_EVENT   "event"
#define 	NLTSUMM_P_LVL   "output-level"
#define 	NLTSUMM_D_VARBASE   10
#define 	NLTSUMM_D_EVENT   "summary"
#define 	NLTSUMM_D_LVL   "debug"

Functions

void *NL_tsumm_init (NL_alist_T params)
int NL_tsumm_process (NL_summstate_T state)
void NL_tsumm_flush (NL_summstate_T state)
void NL_tsumm_free_data (void *data)

Define Documentation

#define NLTSUMM_D_EVENT   "summary"

Default event name

#define NLTSUMM_D_LVL   "debug"

Default output level

#define NLTSUMM_D_VARBASE   10

Default min. number of items for variance calculation

#define NLTSUMM_P_EVENT   "event"

Output summary event name (e.g. if 'foo', then event=foo).

#define NLTSUMM_P_INTERVAL   "interval"

Summarization interval in microseconds

#define NLTSUMM_P_LVL   "output-level"

Output summary event logging level (e.g. if 'INFO' then level=INFO).

#define NLTSUMM_P_MAX   "max"

Maximum value accepted. Events with a higher value are not counted.

#define NLTSUMM_P_MIN   "min"

Minimum value summarized. Events with a lower value are not counted.

#define NLTSUMM_P_VARBASE   "variance-baseline"

Minimum number of values needed to calculate a variance.

Function Documentation

void NL_tsumm_flush(NL_summstate_T state)   	

Flush current state.

• Parameters: state Current summarized state of the record.
• Postcondition: A summary record is written to the output destination.

void NL_tsumm_free_data (void *data)  	

Free the internal summary data.

• Precondition: Input parameter points to allocated (struct tsumm).
• Parameters: data Pointer to data of (struct tsumm).
• Postcondition: Memory for data is de-allocated.

void* NL_tsumm_init (NL_alist_T params)  	

Initialize state.

• Parameters: params String name=value pairs. The names should match one of the NLTSUMM_P_<param> constants defined in this file.
• Returns: Pointer to allocated and initialized state, or NULL on failure.

int NL_tsumm_process (NL_summstate_T state)  	

Process a record.

• Parameters: state Current summarized state of the record.
• Returns: Success (0) or failure (-1).