Events

Many events in Candlepin are emitted when the event occurs. This is not the case, however, for subscriptions. Subscriptions can expire or become active due to the date ranges on the entitlement certificate.

Have Candlepin poll the database intermittently. When the polling discovers an entitlement that has passed a date threshold the event will be emitted by the polling process but with the timestamp of the threshold event. For example, if a certificate expires at noon and we poll at 12:30, the event would be emitted at 12:30 but be timestamped noon.

Candlepin will also need to emit a new event describing compliance status. The compliance status event will include a full copy of the consumer and all the consumer’s entitlements but with the certificates and keys redacted. The compliance event will be sent after other events that require status recalculation:

  • create consumer (if the consumer has installed product IDs)
  • create entitlement
  • modify entitlement (make sure a SKU change triggers a modify entitlement)
  • delete entitlement
  • subscription becomes active
  • subscription expires
  • consumer modified (facts, guest IDs, installed product IDs, etc.)
  • rules change (it may not be worth pursuing, but technically a rules change could mean any system’s status just changed and we would need to recalculate them all.)

In the case of a complex autobind only one compliance status event should be sent.

Candlepin will also store the latest compliance snapshot to reduce overhead. Retaining the latest compliance status could also allow us to stop calculating compliance on every GET consumer API call.

The changes to the event framework will require Candlepin to keep track of events and only emit them if the database transaction commits successfully.

By using native filtering functionality available in QPid, Gutterball will control the events that it listens for.

Gutterball will store every compliance snapshot and the time it was calculated. Reports will look for the most recent snapshot before report time.

Reporting API

Gutterball will expose a REST API for running a predefined set of reports, returning the results as JSON.

Planned Reports

See the planned supported reports.

Last modified on 24 March 2016