Module: Octo::Counter

Includes:
Helper
Included in:
ApiHit, CategoryHit, NewsfeedHit, NotificationHit, ProductHit, TagHit
Defined in:
lib/octocore-mongo/counter.rb,
lib/octocore-mongo/counter/helpers.rb

Defined Under Namespace

Modules: Helper

Constant Summary collapse

INDEX_KEY_PREFIX = 
:CounterIndex
COUNTER_KEY_PREFIX = 
:Counter
SEPARATOR = 
'_'
TYPE_MINUTE =

Define the different types of counters here. As a design decision you MUST ALWAYS keep the counters that can be created from subcounters in multiples. So for instance, you can not create a counter of type TYPE_MINUTE_36 from a counter of type TYPE_MINUTE_15. If you have to create a counter of type TYPE_MINUTE_36, consider creating subcounters like TYPE_MINUTE_9 and TYPE_MINUTE_4. Derive TYPE_MINUTE_9 from TYPE_MINUTE_4 and TYPE_MINUTE_4 from TYPE_MINUTE_1 NOTE:

IT IS VERY VERY IMPORTANT TO KEEP THE VALUES OF THESE COUNTERS IN ASCENDING ORDER. because it helps to define a concept of “max_type”

0
TYPE_MINUTE_30 = 
1
TYPE_HOUR = 
2
TYPE_HOUR_3 = 
3
TYPE_HOUR_6 = 
4
TYPE_HOUR_12 = 
5
TYPE_DAY = 
6
TYPE_DAY_3 = 
7
TYPE_DAY_6 = 
8
TYPE_WEEK = 
9

Constants included from Helper

Helper::METHOD_PREFIX

Instance Method Summary collapse

Methods included from Helper

counter_text, #generate_aggregators, #get_duration_for_counter_type, #get_fromtype_for_totype, #get_typecounters, #max_type, #method_names_type_counter, #string_to_const_val, #type_counters_method_names

Instance Method Details

#aggregate(ts = Time.now.floor) ⇒ Hash{Fixnum => Hash{ Obj => Fixnum }}

Aggregates all the counters available. Aggregation of only time specific

events can be done by passing the `ts` parameter.

Parameters:

  • ts (Time) (defaults to: Time.now.floor) —

    The time at which aggregation has to be done.

Returns:

  • (Hash{Fixnum => Hash{ Obj => Fixnum }}) —

    The counts of each object



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/octocore-mongo/counter.rb', line 164

def aggregate(ts = Time.now.floor)
  ts = ts.to_i
  aggr = {}
  # Find all counters from the index
  index_key = generate_index_key(ts, '*')
  counters = MongoMapper::Document.redis.keys(index_key)
  counters.each do |cnt|
    _tmp = cnt.split(SEPARATOR)
    _ts = _tmp[2].to_i
    aggr[_ts] = {} unless aggr.has_key?(_ts)

    clazz = _tmp[3]
    _clazz = clazz.constantize

    _attrs = _tmp[4.._tmp.length]

    args = {}
    _clazz.key_column_names.each_with_index do |k, i|
      args[k] = _attrs[i]
    end

    obj = _clazz.public_send(:get_cached, args)

    # construct the keys for all counters matching this patter
    _attrs << '*'
    counters_search_key = generate_key_prefix(_ts, clazz, _attrs)
    counter_keys = MongoMapper::Document.redis.keys(counters_search_key)
    counter_keys.each do |c_key|
      val = MongoMapper::Document.redis.get(c_key)
      if val
        aggr[_ts][obj] = aggr[_ts].fetch(obj, 0) + val.to_i
      else
        aggr[_ts][obj] = aggr[_ts].fetch(obj, 0) + 1
      end
    end
  end
  aggr

end

#aggregate!(ts = Time.now.floor) ⇒ Object

Aggregates and attempts to store it into the database. This would only

work if the class that extends Octo::Counter includes from
Cequel::Record



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/octocore-mongo/counter.rb', line 207

def aggregate!(ts = Time.now.floor)
  unless self.ancestors.include?MongoMapper::Document
    raise NoMethodError, "aggregate! not defined for this counter"
  end

  aggr = aggregate(ts)
  aggr.each do |_ts, counterVals|
    counterVals.each do |obj, count|
      args = gen_args_for_instance obj, count, _ts, TYPE_MINUTE
      counter = self.new args
      counter.save!
    end
  end
  call_completion_hook(TYPE_MINUTE, ts)
end

#aggregate_and_create(from_type, to_type, ts = Time.now.ceil) ⇒ Object 



83
84
85
86
87
88
89
90
 
# File 'lib/octocore-mongo/counter.rb', line 83

def aggregate_and_create(from_type, to_type, ts = Time.now.ceil)
  duration = get_duration_for_counter_type(to_type, ts)
  aggr = local_count(duration, from_type)
  sum = local_counter_sum(aggr)
  update_counters(aggr, sum, to_type, ts)
  # Post Update Hooks should go here
  call_completion_hook(to_type, ts)
end

#call_completion_hook(type, ts) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/octocore-mongo/counter.rb', line 92

def call_completion_hook(type, ts)
  # If this counter type has a corresponding trends_klass
  # it means that the trend for it must be calculated.
  # So, schedule the trend calculation right after this
  # is finished
  if self.instance_variables.include?(:@trends_klass)
    klass = self.instance_variable_get(:@trends_klass).constantize
    # make sure it responds to the aggregation method
    if klass.respond_to?(:aggregate_and_create)
      klass.send(:aggregate_and_create, type, ts)
    end
  end
end

#countables ⇒ Object

Define the columns necessary for counter model



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/octocore-mongo/counter.rb', line 36

def countables
  key :type, Integer
  key :ts, Time
  key :uid, String

  key :count, Integer

  generate_aggregators { |ts, method|
    totype = method_names_type_counter(method)
    fromtype = get_fromtype_for_totype(totype)
    aggregate_and_create(fromtype, totype, ts)
  }
end

#increment_for(obj) ⇒ Object

Increments the counter for a model.

Parameters:

  • obj (Object) —

    The model instance for whom counter would be incremented



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/octocore-mongo/counter.rb', line 53

def increment_for(obj)
  # decide the time of event asap
  ts = Time.now.ceil.to_i

  if obj.class.ancestors.include?MongoMapper::Document
    args = obj.key_attributes.collect { |k,v|  v.to_s }
    cache_key = generate_key(ts, obj.class.name, *args)

    val = Cequel::Record.redis.get(cache_key)
    if val.nil?
      val = 1
    else
      val = val.to_i + 1
    end

    ttl = (time_window + 1) * 60

    # Update a sharded counter
    MongoMapper::Document.redis.setex(cache_key, ttl, val)

    # Optionally, update the index
    index_key = generate_index_key(ts, obj.class.name, *args)
    index_present = MongoMapper::Document.redis.get(index_key).try(:to_i)
    if index_present != 1
      MongoMapper::Document.redis.setex(index_key, ttl, 1)
    end
  end

end

#local_count(duration, type) ⇒ Object

Does the counting from DB. Unlike the other counter that uses Redis. Hence

the name local_count

Parameters:

  • duration (Time) —

    A time/time range object

  • type (Fixnum) —

    The type of counter to look for



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/octocore-mongo/counter.rb', line 128

def local_count(duration, type)
  aggr = {}
  Octo::Enterprise.each do |enterprise|
    args = {
        enterprise_id: enterprise.id,
        ts: duration,
        type: type
    }
    aggr[enterprise.id.to_s] = {} unless aggr.has_key?(enterprise.id.to_s)
    results = where(args)
    results_group = results.group_by { |x| x.uid }
    results_group.each do |uid, counters|
      _sum = counters.inject(0) do |sum, counter|
        sum + counter.count
      end
      aggr[enterprise.id.to_s][uid] = _sum
    end
  end
  aggr
end

#local_counter_sum(aggr) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
 
# File 'lib/octocore-mongo/counter.rb', line 149

def local_counter_sum(aggr)
  sum = {}
  aggr.each do |enterprise_id, uidCounters|
    _sum = uidCounters.values.inject(0) do |s, count|
      s + count
    end
    sum[enterprise_id] = _sum
  end
  sum
end

#update_counters(aggr, sum, type, ts) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/octocore-mongo/counter.rb', line 106

def update_counters(aggr, sum, type, ts)
  aggr.each do |enterprise_id, uidCounters|
    uidCounters.each do |uid, count|
      counter = self.new({
                             enterprise_id: enterprise_id,
                             uid: uid,
                             count: count,
                             type: type,
                             ts: ts
                         })
      if counter.respond_to?(:obp)
        counter.obp = count.to_f/sum[enterprise_id]
      end
      counter.save!
    end
  end
end