Added consolidate() function to webapp/graphite/render/functions.py

Consolidate is a very generic term, it does not mean sum or average. I would rather see this new function be called average.

Rather than duplicating all of summarize, it might make more sense to add a new optional parameter to the summarize function to change what function is used.

Then

You're saying something like that:

&target=summarize(my.metric, "5min", "avg")

&target=summarize(my.metric, "5min") default does sum

Or move consolidate to average.

This patch on trunk adds the new flag and some basic docs:

diff --git a/webapp/graphite/render/functions.py b/webapp/graphite/render/functions.py
index fb979a3..76bda6a 100644
--- a/webapp/graphite/render/functions.py
+++ b/webapp/graphite/render/functions.py
@@ -1196,16 +1196,24 @@ def exclude(requestContext, seriesList, pattern):
   return [s for s in seriesList if not regex.search(s.name)]

-def summarize(requestContext, seriesList, intervalString):
+def summarize(requestContext, seriesList, intervalString, func='sum'):
   """
   Summarize the data into interval buckets of a certain size.

+ By default, the contents of each interval bucket are summed together. This is
+ useful for counters where each increment represents a discrete event and
+ retrieving a "per X" value requires summing all the events in that interval.
+
+ Specifying 'avg' instead will return the mean for each bucket, which can be more
+ useful when the value is a gauge that represents a certain value in time.
+
   Example:

   .. code-block:: none

- &target=summarize(counter.errors, "1hour") # errors per hour
+ &target=summarize(counter.errors, "1hour") # total errors per hour
     &target=summarize(nonNegativeDerivative(gauge.num_users), "1week") # new users per week
+ &target=summarize(queue.size, "1hour", "avg") # average queue size per hour
   """
   results = []
   delta = parseTimeOffset(intervalString)
@@ -1235,7 +1243,10 @@ def summarize(requestContext, seriesList, intervalString):
       bucket = buckets.get(bucketInterval, [])

       if bucket:
- newValues.append( sum(bucket) )
+ if func == 'avg':
+ newValues.append( float(sum(bucket)) / float(len(bucket)) )
+ else:
+ newValues.append( sum(bucket) )
       else:
         newValues.append( None )

diff --git a/webapp/graphite/render/functions.py b/webapp/graphite/render/functions.py
index fb979a3..76bda6a 100644
--- a/webapp/graphite/render/functions.py
+++ b/webapp/graphite/render/functions.py
@@ -1196,16 +1196,24 @@ def exclude(requestContext, seriesList, pattern):
   return [s for s in seriesList if not regex.search(s.name)]

-def summarize(requestContext, seriesList, intervalString):
+def summarize(requestContext, seriesList, intervalString, func='sum'):
   """
   Summarize the data into interval buckets of a certain size.

+ By default, the contents of each interval bucket are summed together. This is
+ useful for counters where each increment represents a discrete event and
+ retrieving a "per X" value requires summing all the events in that interval.
+
+ Specifying 'avg' instead will return the mean for each bucket, which can be more
+ useful when the value is a gauge that represents a certain value in time.
+
   Example:

   .. code-block:: none

- &target=summarize(counter.errors, "1hour") # errors per hour
+ &target=summarize(counter.errors, "1hour") # total errors per hour
     &target=summarize(nonNegativeDerivative(gauge.num_users), "1week") # new users per week
+ &target=summarize(queue.size, "1hour", "avg") # average queue size per hour
   """
   results = []
   delta = parseTimeOffset(intervalString)
@@ -1235,7 +1243,10 @@ def summarize(requestContext, seriesList, intervalString):
       bucket = buckets.get(bucketInterval, [])

       if bucket:
- newValues.append( sum(bucket) )
+ if func == 'avg':
+ newValues.append( float(sum(bucket)) / float(len(bucket)) )
+ else:
+ newValues.append( sum(bucket) )
       else:
         newValues.append( None )

Sorry for the triple post.

Note that my patch requires graphite trunk, where I just made another fix to summarize(): http://bazaar.launchpad.net/~graphite-dev/graphite/main/revision/510

Your copied consolidate function would require the same fixes.

Thanks, that looks much cleaner.

summarize() in trunk now has all these changes plus a few more

Released in 0.9.9