dart::Metric Class Reference

#include <metrics.h>

Inheritance diagram for dart::Metric:

Public Types
enum	Unit { kCounter , kByte , kMicrosecond }

Public Member Functions
	Metric ()
void	InitInstance (Isolate *isolate, const char *name, const char *description, Unit unit)
void	InitInstance (IsolateGroup *isolate_group, const char *name, const char *description, Unit unit)
void	InitInstance (const char *name, const char *description, Unit unit)
virtual	~Metric ()
void	PrintJSON (JSONStream *stream)
char *	ToString ()
int64_t	value () const
void	set_value (int64_t value)
void	increment ()
const char *	name () const
const char *	description () const
Unit	unit () const
Isolate *	isolate () const
IsolateGroup *	isolate_group () const
virtual int64_t	Value () const

Static Public Member Functions
static void	Init ()
static void	Cleanup ()
static char *	ValueToString (int64_t value, Unit unit)
static Metric *	vm_head ()

Detailed Description

Definition at line 53 of file metrics.h.

Member Enumeration Documentation

Unit

enum dart::Metric::Unit

Enumerator
kCounter
kByte
kMicrosecond

Definition at line 55 of file metrics.h.

            {
    kCounter,
    kByte,
    kMicrosecond,
  };

Constructor & Destructor Documentation

Metric()

dart::Metric::Metric

(

)

Definition at line 23 of file metrics.cc.

: unit_(kCounter), value_(0) {}

~Metric()

dart::Metric::~Metric ( )

virtual

Definition at line 24 of file metrics.cc.

{}

Member Function Documentation

Cleanup()

static void dart::Metric::Cleanup ( )

static

description()

const char * dart::Metric::description ( ) const

inline

Definition at line 101 of file metrics.h.

{ return description_; }

increment()

void dart::Metric::increment ( )

inline

Definition at line 98 of file metrics.h.

{ value_++; }

Init()

static void dart::Metric::Init ( )

static

InitInstance() [1/3]

void dart::Metric::InitInstance	(	const char *	name,
		const char *	description,
		Unit	unit
	)

Definition at line 51 of file metrics.cc.

                                     {
  // Only called once.
  ASSERT(name != nullptr);
  name_ = name;
  description_ = description;
  unit_ = unit;
}

InitInstance() [2/3]

void dart::Metric::InitInstance	(	Isolate *	isolate,
		const char *	name,
		const char *	description,
		Unit	unit
	)

Definition at line 39 of file metrics.cc.

                                     {
  // Only called once.
  ASSERT(name != nullptr);
  isolate_ = isolate;
  name_ = name;
  description_ = description;
  unit_ = unit;
}

InitInstance() [3/3]

void dart::Metric::InitInstance	(	IsolateGroup *	isolate_group,
		const char *	name,
		const char *	description,
		Unit	unit
	)

Definition at line 26 of file metrics.cc.

                                     {
  // Only called once.
  ASSERT(name != nullptr);
  isolate_group_ = isolate_group;
  name_ = name;
  description_ = description;
  unit_ = unit;
}

isolate()

Isolate * dart::Metric::isolate ( ) const

inline

Definition at line 105 of file metrics.h.

{ return isolate_; }

isolate_group()

IsolateGroup * dart::Metric::isolate_group ( ) const

inline

Definition at line 108 of file metrics.h.

{ return isolate_group_; }

name()

const char * dart::Metric::name ( ) const

inline

Definition at line 100 of file metrics.h.

{ return name_; }

PrintJSON()

void dart::Metric::PrintJSON

(

JSONStream *

stream

)

Definition at line 76 of file metrics.cc.

                                         {
  JSONObject obj(stream);
  obj.AddProperty("type", "Counter");
  obj.AddProperty("name", name_);
  obj.AddProperty("description", description_);
  obj.AddProperty("unit", UnitString(unit()));
  if (isolate_ == nullptr && isolate_group_ == nullptr) {
    obj.AddFixedServiceId("vm/metrics/%s", name_);
  } else {
    obj.AddFixedServiceId("metrics/native/%s", name_);
  }
  // TODO(johnmccutchan): Overflow?
  double value_as_double = static_cast<double>(Value());
  obj.AddProperty("value", value_as_double);
}

set_value()

void dart::Metric::set_value ( int64_t  value )

inline

Definition at line 96 of file metrics.h.

{ value_ = value; }

ToString()

char * dart::Metric::ToString

(

)

Definition at line 136 of file metrics.cc.

                       {
  Thread* thread = Thread::Current();
  ASSERT(thread != nullptr);
  Zone* zone = thread->zone();
  ASSERT(zone != nullptr);
  return zone->PrintToString("%s %s", name(), ValueToString(Value(), unit()));
}

unit()

Unit dart::Metric::unit ( ) const

inline

Definition at line 102 of file metrics.h.

{ return unit_; }

value()

int64_t dart::Metric::value ( ) const

inline

Definition at line 95 of file metrics.h.

{ return value_; }

Value()

virtual int64_t dart::Metric::Value ( ) const

inlinevirtual

Reimplemented in dart::MetricHeapOldUsed, dart::MetricHeapOldCapacity, dart::MetricHeapOldExternal, dart::MetricHeapNewUsed, dart::MetricHeapNewCapacity, dart::MetricHeapNewExternal, dart::MetricIsolateCount, dart::MetricCurrentRSS, dart::MetricPeakRSS, dart::MetricHeapUsed, and dart::MyMetric.

Definition at line 114 of file metrics.h.

{ return value(); }

ValueToString()

char * dart::Metric::ValueToString ( int64_t  value, Unit  unit  )

static

Definition at line 93 of file metrics.cc.

                                                    {
  Thread* thread = Thread::Current();
  ASSERT(thread != nullptr);
  Zone* zone = thread->zone();
  ASSERT(zone != nullptr);
  switch (unit) {
    case kCounter:
      return zone->PrintToString("%" Pd64 "", value);
    case kByte: {
      const char* scaled_suffix = "B";
      double scaled_value = static_cast<double>(value);
      if (value > GB) {
        scaled_suffix = "GB";
        scaled_value /= GB;
      } else if (value > MB) {
        scaled_suffix = "MB";
        scaled_value /= MB;
      } else if (value > KB) {
        scaled_suffix = "kB";
        scaled_value /= KB;
      }
      return zone->PrintToString("%.3f %s (%" Pd64 " B)", scaled_value,
                                 scaled_suffix, value);
    }
    case kMicrosecond: {
      const char* scaled_suffix = "us";
      double scaled_value = static_cast<double>(value);
      if (value > kMicrosecondsPerSecond) {
        scaled_suffix = "s";
        scaled_value /= kMicrosecondsPerSecond;
      } else if (value > kMicrosecondsPerMillisecond) {
        scaled_suffix = "ms";
        scaled_value /= kMicrosecondsPerMillisecond;
      }
      return zone->PrintToString("%.3f %s (%" Pd64 " us)", scaled_value,
                                 scaled_suffix, value);
    }
    default:
      UNREACHABLE();
      return nullptr;
  }
}

vm_head()

static Metric * dart::Metric::vm_head ( )

inlinestatic

Definition at line 110 of file metrics.h.

{ return vm_list_head_; }

---

The documentation for this class was generated from the following files:

• third_party/dart-lang/sdk/runtime/vm/metrics.h
• third_party/dart-lang/sdk/runtime/vm/metrics.cc