Struct ServerEvent 

pub struct ServerEvent { /* private fields */ }

An event sent from the server to GA4 (Measurement Protocol), as a queue job so a slow or failing request never holds up the page. Needs GA4_MEASUREMENT_ID and GA4_API_SECRET; outside production it’s only logged.

Implementations

impl ServerEvent

pub fn new(client_id: Option<String>, name: &str) -> Self

client_id from GaClientId; without one a random id is used, so the event still counts but isn’t linked to the visitor’s session.

pub fn param(self, key: &str, value: impl Serialize) -> Self

Adds a parameter; a value that can’t be serialized becomes null.

pub fn user_id(self, id: impl ToString) -> Self

Links the event to your own user id (GA4 User-ID).

pub fn payload(&self) -> Value

The JSON body sent to /mp/collect.

Trait Implementations

impl Clone for ServerEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServerEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServerEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Job for ServerEvent

const NAME: &'static str = "renox:analytics"

A stable name; stored with each job, so don’t rename it while jobs are queued.

async fn handle(self, ctx: JobContext) -> Result

Does the work; an error fails the attempt (retried unless Error::permanent).

const QUEUE: &'static str = "default"

Its queue; queue:work --queue high,default drains queues in order.

const MAX_ATTEMPTS: u32 = 3

Runs before the job is moved to failed_jobs.

const TIMEOUT: Duration = _

How long one attempt may run.

const ENCRYPTED: bool = false

Store the payload encrypted with APP_KEY (it holds personal data or secrets). The worker decrypts it; failed_jobs keeps it encrypted.

const UNIQUE_FOR: Option<Duration> = None

While a job with the same Job::unique_id is queued or running, dispatching another returns the queued one’s id instead, for up to this long (the claim is dropped when the job finishes).

fn backoff(attempt: u32) -> Duration

Wait before retrying after the given failed attempt (1-based).

fn unique_id(&self) -> String

What makes two jobs “the same” for Job::UNIQUE_FOR, e.g. the order id. Empty (the default) makes every job of the type the same.

fn middleware(&self) -> Vec<Middleware>

Conditions checked before each attempt; a job that can’t run yet is put back without using up an attempt.

fn failed( self, ctx: JobContext, error: String, ) -> impl Future<Output = ()> + Send

Runs once the job has failed for good (attempts used up, or a permanent error), with the last error, e.g. to tell the user. ctx is the last attempt’s: the state, the job’s id, the attempt, its batch.

impl Serialize for ServerEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.