View Source PhoenixAnalytics.Services.PubSub (PhoenixAnalytics v0.3.2)

A module for handling PubSub operations in Phoenix Analytics.

This module provides a robust and efficient interface for subscribing to and broadcasting events related to request analytics. It leverages Phoenix.PubSub under the hood to manage pub/sub functionality, enabling seamless communication across distributed systems and allowing for load-balanced application sharing of requests.

Summary

Functions

broadcast(event)

Broadcasts an event to all subscribers of the request topic.

name()

Returns the name of the PubSub server.

subscribe()

Subscribes the current process to the request topic.

Functions

broadcast(event)

@spec broadcast(PhoenixAnalytics.Entities.RequestLog.t()) :: :ok | {:error, term()}

Broadcasts an event to all subscribers of the request topic.

This function sends the provided event to all processes that have subscribed to the request topic. It's typically used to distribute information about new requests.

In case of Postgres backend local broadcast is used to avoid any data duplication across nodes.

Parameters

event: A PhoenixAnalytics.Entities.RequestLog struct representing the event to be broadcasted.

Examples

iex> request_log = %PhoenixAnalytics.Entities.RequestLog{request_id: "123", path: "/api/users"}
iex> PhoenixAnalytics.Services.PubSub.broadcast(request_log)
:ok

Return Value

Returns :ok if the broadcast is successful.

Errors

May return {:error, term()} if there's an issue with broadcasting the message.

name()

@spec name() :: atom()

Returns the name of the PubSub server.

This function provides the atom used to identify the PubSub server. It's useful when you need to reference the PubSub server in other parts of your application.

Examples

iex> PhoenixAnalytics.Services.PubSub.name()
:pa_pubsub

Return Value

Returns the atom :pa_pubsub.

subscribe()

@spec subscribe() :: :ok | {:error, term()}

Subscribes the current process to the request topic.

This function allows a process to receive messages broadcasted to the request topic. After subscribing, the process will receive tuples of the form {:request_sent, event} whenever a new event is broadcasted.

iex> PhoenixAnalytics.Services.PubSub.subscribe()
:ok

Returns :ok if the subscription is successful.

May raise an error if the PubSub server is not available or if there's an issue with the subscription.