Logging Request Error Events

Captures and log errors that occur during HTTP requests. It helps with tracking and debugging failed network interactions.

Usage

eventPublisher.logRequestErrorEvent({
  eventId: "ApiRequestError",
  eventDescription: "Failed API Request",
  request: request?.body,
  response: response,
  url: config.url,
  errorMessage: response?.message,
  method: "GET",
  status: Number(code),
  sectionName: "EverydayEssentials",
  subSectionName: "Shop",
  userId: "02412345332",
  userEmail: "[email protected]",
  userName: "Addo Odame",
  userLocationLat: 37.7749,
  userLocationLong: 122.4194,
  userLocationName: "Kokomlele",
  userGender: "M",
  userCountry: "GH",
  extrasObject: {
    zone: "Adenta-Lakeside",
    station: "Madina",
  },
});

TIP

For detailed instructions on setting up the event publisher, refer to the documentation.

Object Properties

Parameter Name	Description
eventId	The unique identifier for the event. This should always be in PascalCase
eventDescription	A description of the event.
url	The URL of the request.
method	The HTTP method of the request.
status	The HTTP status code of the response.
request	The request object.
response	The response object.
errorMessage	Error stack trace string
sectionName	The name of the section where the event occurred.
subSectionName	The name of the subsection where the event occurred.
userId	The unique identifier for the user. This is usually the user's phone number
userEmail	The email of the user.
userName	The name of the user.
userLocationLat	The latitude of the user's location.
userLocationLong	The longitude of the user's location.
userLocationName	The name of the user's location.
userGender	The gender of the user.
userCountry	The country of the user.
extrasObject	An object containing extra data for the event. These are product specific details that you'll want to record for every event