com.criteo.publisher.csm

Class CsmBidLifecycleListener

java.lang.Object

com.criteo.publisher.csm.CsmBidLifecycleListener

All Implemented Interfaces:

BidLifecycleListener

public class CsmBidLifecycleListener
extends java.lang.Object
implements BidLifecycleListener

Update metrics files accordingly to received events.

This follows specifications given by Client Side Metrics.

Constructor Summary

Constructors

Constructor and Description
CsmBidLifecycleListener(MetricRepository repository, MetricSendingQueueProducer sendingQueueProducer, Clock clock, Config config, java.util.concurrent.Executor executor)

Method Summary

Modifier and Type	Method and Description
void	onBidCached(com.criteo.publisher.model.CdbResponseSlot bidCached) Callback invoked when a bid is cached.
void	onBidConsumed(com.criteo.publisher.model.CacheAdUnit adUnit, com.criteo.publisher.model.CdbResponseSlot consumedBid) On bid consumption, the metric associated to the bid is updated.
void	onCdbCallFailed(CdbRequest request, java.lang.Exception exception) On CDB call failed, metrics corresponding to the requested slots are updated.
void	onCdbCallFinished(CdbRequest request, CdbResponse response) When the CDB call ends successfully, metrics corresponding to requested slots are updated accordingly to the response.
void	onCdbCallStarted(CdbRequest request) On CDB call start, each requested slot is tracked by a new metric.
void	onSdkInitialized() SDK initialization is caused either by a fresh or restart of the application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CsmBidLifecycleListener

public CsmBidLifecycleListener(@NonNull
                               MetricRepository repository,
                               @NonNull
                               MetricSendingQueueProducer sendingQueueProducer,
                               @NonNull
                               Clock clock,
                               @NonNull
                               Config config,
                               @NonNull
                               java.util.concurrent.Executor executor)

Method Detail

onSdkInitialized

public void onSdkInitialized()

SDK initialization is caused either by a fresh or restart of the application. As a consequence, the in-memory bid-cache is lost and the metrics associated to the previously cached bids will never be updated again. In this case, all previously stored metrics are moved to the sending queue.

Specified by:

onSdkInitialized in interface BidLifecycleListener

onCdbCallStarted

public void onCdbCallStarted(@NonNull
                             CdbRequest request)

On CDB call start, each requested slot is tracked by a new metric. The metrics marks the timestamp of this event and wait for further updates.

Specified by:

onCdbCallStarted in interface BidLifecycleListener

Parameters:

request - Request sent to CDB

onCdbCallFinished

public void onCdbCallFinished(@NonNull
                              CdbRequest request,
                              @NonNull
                              CdbResponse response)

When the CDB call ends successfully, metrics corresponding to requested slots are updated accordingly to the response.

If there is no response for a slot, then it is a no bid. The metric marks the timestamp of this event and, as no consumption of this no-bid is expected, the metric is tagged as finished and ready to send.

If there is a matching invalid slot, then it is considered as an error. The metric is not longer updated and is flagged as ready to send.

If there is a matching valid slot, then it is a consumable bid. The metric marks the timestamp of this event, and waits for further updates (via consumption).

Specified by:

onCdbCallFinished in interface BidLifecycleListener

Parameters:

request - Request that was sent to CDB

response - Response coming from CDB

onCdbCallFailed

public void onCdbCallFailed(@NonNull
                            CdbRequest request,
                            @NonNull
                            java.lang.Exception exception)

On CDB call failed, metrics corresponding to the requested slots are updated.

If the failure is a timeout, then all metrics are flagged as having a timeout.

Then, since no further updates are expected, all metrics are flagged as ready to send.

Specified by:

onCdbCallFailed in interface BidLifecycleListener

Parameters:

request - Request that was sent to CDB

exception - Exception representing the failure of the call

onBidConsumed

public void onBidConsumed(@NonNull
                          com.criteo.publisher.model.CacheAdUnit adUnit,
                          @NonNull
                          com.criteo.publisher.model.CdbResponseSlot consumedBid)

On bid consumption, the metric associated to the bid is updated.

If the bid has not expired, then the bid managed to go from CDB to the user. The metric marks the timestamp of this event.

Since this is the end of the bid lifecycle, the metric does not expect further updates and is flagged as ready to send.

Specified by:

onBidConsumed in interface BidLifecycleListener

Parameters:

adUnit - ad unit representing the bid

consumedBid - bid that was consumed

onBidCached

public void onBidCached(@NonNull
                        com.criteo.publisher.model.CdbResponseSlot bidCached)

Description copied from interface: BidLifecycleListener

Callback invoked when a bid is cached.

Specified by:

onBidCached in interface BidLifecycleListener

Parameters:

bidCached - bid that was cached