org.apache.cassandra.analytics
Class MetricsRecord

java.lang.Object
  extended by org.apache.cassandra.analytics.MetricsRecord

public class MetricsRecord
extends java.lang.Object

This class keeps a back-pointer to the AnalyticsContext and delegates back to it on update and remove(). Author : Avinash Lakshman ( alakshman@facebook.com) & Prashant Malik ( pmalik@facebook.com ) & Karthik Ranganathan ( kranganathan@facebook.com )


Constructor Summary
protected MetricsRecord(java.lang.String recordName, AnalyticsContext context)
          Creates a new instance of MetricsRecord
 
Method Summary
 java.lang.String getRecordName()
          Returns the record name.
 void incrMetric(java.lang.String metricName, byte metricValue)
          Increments the named metric by the specified value.
 void incrMetric(java.lang.String metricName, float metricValue)
          Increments the named metric by the specified value.
 void incrMetric(java.lang.String metricName, int metricValue)
          Increments the named metric by the specified value.
 void incrMetric(java.lang.String metricName, short metricValue)
          Increments the named metric by the specified value.
 void remove()
          Removes the row, if it exists, in the buffered data table having tags that equal the tags that have been set on this record.
 void setMetric(java.lang.String metricName, byte metricValue)
          Sets the named metric to the specified value.
 void setMetric(java.lang.String metricName, float metricValue)
          Sets the named metric to the specified value.
 void setMetric(java.lang.String metricName, int metricValue)
          Sets the named metric to the specified value.
 void setMetric(java.lang.String metricName, short metricValue)
          Sets the named metric to the specified value.
 void setTag(java.lang.String tagName, byte tagValue)
          Sets the named tag to the specified value.
 void setTag(java.lang.String tagName, int tagValue)
          Sets the named tag to the specified value.
 void setTag(java.lang.String tagName, short tagValue)
          Sets the named tag to the specified value.
 void setTag(java.lang.String tagName, java.lang.String tagValue)
          Sets the named tag to the specified value.
 void update()
          Updates the table of buffered data which is to be sent periodically.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MetricsRecord

protected MetricsRecord(java.lang.String recordName,
                        AnalyticsContext context)
Creates a new instance of MetricsRecord

Parameters:
recordName - name of this record
context - the context which this record is a part of
Method Detail

getRecordName

public java.lang.String getRecordName()
Returns the record name.

Returns:
the record name

setTag

public void setTag(java.lang.String tagName,
                   java.lang.String tagValue)
Sets the named tag to the specified value.

Parameters:
tagName - name of the tag
tagValue - new value of the tag
Throws:
MetricsException - if the tagName conflicts with the configuration

setTag

public void setTag(java.lang.String tagName,
                   int tagValue)
Sets the named tag to the specified value.

Parameters:
tagName - name of the tag
tagValue - new value of the tag
Throws:
MetricsException - if the tagName conflicts with the configuration

setTag

public void setTag(java.lang.String tagName,
                   short tagValue)
Sets the named tag to the specified value.

Parameters:
tagName - name of the tag
tagValue - new value of the tag
Throws:
MetricsException - if the tagName conflicts with the configuration

setTag

public void setTag(java.lang.String tagName,
                   byte tagValue)
Sets the named tag to the specified value.

Parameters:
tagName - name of the tag
tagValue - new value of the tag
Throws:
MetricsException - if the tagName conflicts with the configuration

setMetric

public void setMetric(java.lang.String metricName,
                      int metricValue)
Sets the named metric to the specified value.

Parameters:
metricName - name of the metric
metricValue - new value of the metric
Throws:
MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

setMetric

public void setMetric(java.lang.String metricName,
                      short metricValue)
Sets the named metric to the specified value.

Parameters:
metricName - name of the metric
metricValue - new value of the metric
Throws:
MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

setMetric

public void setMetric(java.lang.String metricName,
                      byte metricValue)
Sets the named metric to the specified value.

Parameters:
metricName - name of the metric
metricValue - new value of the metric
Throws:
MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

setMetric

public void setMetric(java.lang.String metricName,
                      float metricValue)
Sets the named metric to the specified value.

Parameters:
metricName - name of the metric
metricValue - new value of the metric
Throws:
MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

incrMetric

public void incrMetric(java.lang.String metricName,
                       int metricValue)
Increments the named metric by the specified value.

Parameters:
metricName - name of the metric
metricValue - incremental value
Throws:
MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

incrMetric

public void incrMetric(java.lang.String metricName,
                       short metricValue)
Increments the named metric by the specified value.

Parameters:
metricName - name of the metric
metricValue - incremental value
Throws:
MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

incrMetric

public void incrMetric(java.lang.String metricName,
                       byte metricValue)
Increments the named metric by the specified value.

Parameters:
metricName - name of the metric
metricValue - incremental value
Throws:
MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

incrMetric

public void incrMetric(java.lang.String metricName,
                       float metricValue)
Increments the named metric by the specified value.

Parameters:
metricName - name of the metric
metricValue - incremental value
Throws:
MetricsException - if the metricName or the type of the metricValue conflicts with the configuration

update

public void update()
Updates the table of buffered data which is to be sent periodically. If the tag values match an existing row, that row is updated; otherwise, a new row is added.


remove

public void remove()
Removes the row, if it exists, in the buffered data table having tags that equal the tags that have been set on this record.



Copyright © 2009 The Apache Software Foundation