MonetizationOS Docs

Observability

A key value add in MonetizationOS is that we offer full observability for every event processed through our system.

You can view these logs by navigating to the Observability section from the main navigation.

This page is separated into three tabs: Events, Users, and Metrics

Events

The Events section provides a list of all access checks, actions, and third party events processed through our system.

Events List

On the overview screen you will see an events list. Each event shows:

  • Status: Whether the event was handled successfully (green), handled with errors (amber), or failed (red)
  • Event: Whether this was a surface decision, action, custom endpoint or third party event. Note: Third party events will provide details of the event. For example, Stripe event: charge.refund.updated
  • Source: Whether the request came from a human or a bot. Bot sources display a verified tick for verified bots and details about where the bot came from (e.g., Stripe, ChatGPT)
  • User: The identifier of the end user, when known
  • Environment: The environment where the call was processed, for example, Preview or Live
  • Time: The date and timestamp of the call.

By default, the list provided is a static list of events, loaded at the time you reach the Observability page.

If you wish to refresh the list with the most up-to-date events, click 'Now'.

If you wish to view live events as they occur, click 'Start Listening' at the bottom of the page.

You can search for specific events using the search bar, specify an environment in the 'All Environments' drop down, and filter between all events, humans, or bots.

Event Details

Clicking a specific event will open up an Event Details sheet.

At the top you will see a timestamp for the event, along with the type of event, and the environment in which the event took place.

Surface Decision Events

The Event Details sheet for Surface Decisions is broken into four tabs: Details, Workflows, Request & Response, and Execution Flow.

Details

The details tab includes cards for About the Session, Bot Detections (when applicable), Location, Features, and Plans.

About the Session

  • Authenticated Status: Whether the user was authenticated or unauthenticated at the time the request was made
  • Identifiers: The user id from the call, and email address of the user, if known
  • User Type: Whether the user was anonymous, registered, or a customer

Bot Detections (displayed when source is a bot)

  • Product: The specific bot product, e.g., ChatGPT User
  • Operator: The organization operating the bot, e.g., OpenAI
  • Category: The type of bot, e.g., AI Assistant
  • Verified: Whether the bot was verified

Location

  • Country Code: The country where the call originated
  • City: The city where the call originated
  • Continent: The continent where the call originated
  • Read Data Location: The operating region where the data was read from
  • Write Data Locations: The region(s) where data was written to, when applicable

Features

  • Any features and feature properties returned in the request

Plans

  • Any plans returned in the request

Workflows

The Workflows tab details any workflows that were triggered as a result of the request.

The data seen here includes:

  • Execution Time
  • Execution Status
  • Workflow Response
  • Logs, including warnings and errors

Request & Response

The Request & Response tab details the full request made to our system, and the subsequent response.

Execution Flow

The Execution Flow tab visually details the flow of triggers, actions and events from an orchestration workflow. Clicking on a node within the execution flow will navigate you to the relevant event in the observability stream.

Action Events

The Event Details sheet for Action events is broken into four tabs: Details, Workflows, Input & Output, and Execution Flow.

Details

The details tab includes cards for Action, About the Session, and Bot Detections (when applicable).

Action

  • Action: The name of action that was taken, as configured by you in the 'Actions' section
  • Trigger: The trigger type used for the action - e.g. on decision, customer added, etc

About the Session

  • Identifiers: The user id from the call, and email address of the user, if known
  • Authenticated Status: Whether the user was authenticated or unauthenticated at the time the request was made

Bot Detections (displayed when source is a bot)

  • Product: The specific bot product, e.g., ChatGPT User
  • Operator: The organization operating the bot, e.g., OpenAI
  • Category: The type of bot, e.g., AI Assistant
  • Verified: Whether the bot was verified

Workflows

The Workflows tab details any workflows that were triggered as a result of the request.

The data seen here includes:

  • Execution Time
  • Execution Status
  • Workflow Result
  • Logs, including warnings and errors

Input & Output

The Input & Output tab details the full input and output of the action

Execution Flow

The Execution Flow tab visually details the flow of triggers, actions and events from an orchestration workflow. Clicking on a node within the execution flow will navigate you to the relevant event in the observability stream

Third Party Event Details

The Event Details sheet for Third Party Events includes the following information:

Details

The details tab includes cards for Details, About the User, and Location

Details:

  • Integration: The name of the integration the event was triggered through
  • Event Type: The specific third party event that was triggered

About the User:

  • Identifiers: Such as the customer id or email address of the user

Location:

  • Write Data Locations: The region(s) where data was written to, when applicable

Please note: About the User and Location will only display when the event was relevant to a specific customer, such as a customer's details being updated

Execution Flow

The Execution Flow tab visually details the flow of triggers, actions and events from an orchestration workflow. Clicking on a node within the execution flow will navigate you to the relevant event in the observability stream

Users

The Users tab provides a view of all human sessions that have run through MonetizationOS.

Users List

On the overview screen you will see a list of all human user sessions. Each line shows:

  • Identifier: The ID or email address used to identify a session
  • Type: Whether a user was anonymous or authenticated
  • Environment Type: Whether the user was seen in a Preview, Live, or other type of environment
  • Brands: The brand associated with this session
  • Created: The date and time a session was created

By default, the list provided is a static list of users, loaded at the time you reach the Users tab.

If you wish to refresh the list with the most up-to-date users, click 'Refresh'.

You can search for specific users using the search bar. A filter allows you to hide anonymous or authenticated users, and you can specify an environment in the 'All Environments' drop down.

User Details

Clicking a specific user will open up an User Details sheet.

At the top you will see the user's identifier, whether it is an anonymous or authenticated session, and the environment type the session was seen on. You will also see four tabs: Details, Events, Counters, and Custom Data.

Details

The details tab shows the following:

Session Information:

  • Identifier: The ID or email address used to identify a session
  • Session Type: Whether a user was anonymous or authenticated
  • Last State Change: The date and time a user's state was last changed
  • First Seen: The date and time a user was first seen

Linked Identities:

  • View all the identities that have been linked to this user in the Links section. For each linked identity, you can see:
    • User: The identifier of the linked user, along with the relationship type (e.g., Converted From, Converted To, Related To)
    • Sharing: Whether any data was copied between users when the link was created (e.g., Copied Once, None), with tooltips explaining the sharing behavior
    • Linked On: The date and time the link was established
    • Brands: The brand associated with the linked identity

Plans:

  • Current Active Plans: A list of all plans currently active for a user, including the plan name, grant method, grant source, and relevant brands

Plan History:

  • Journey Start: The date and time a user was first granted a plan
  • Last Change: The date and time a user's plans last changed
  • Plan Changes: The number of plan changes a user has had
  • Plan History: A journey map of a user's relevant plan grants and state changes, including details like the plan name, grant method, grant source and event
  • Linked user: The linked user selector shows a merged plan history across identities, displaying only plan state changes recorded before the link was established for source users and after the link was established for target users

Events

The events tab provides a list of all events associated with a user, including the status of the event, environment, type, and date and time.

Clicking into an event will open a sheet with more event details, as described in the Event Details section above.

The list is static, and loaded at the point of navigating to the tab. Click the 'Now' button for a refreshed list.

Counters

The counters tab details the counter usage consumed by the user. It can be aggregated either hourly, or daily.

The graph shows counter usage over time across any meterable feature property.

Custom Data

The custom data tab shows any data that has been stored against this user in the MonetizationOS system.

Metrics

The Metrics tab provides a view of your usage dashboard, with the ability to toggle between specific environments.

The dashboard shows:

  • Your API requests this month
  • Your total number of 3rd party events processed this month. For example, webhooks from Stripe
  • The number of requests remaining on your MonetizationOS plan
  • A graph visualizing the total number of Access Checks, 3rd Party Events, and Counter Updates. This graph can be toggled between showing events per day, or per month.
  • Your total number of anonymous sessions
  • Your total number of authenticated users
  • Your authenticated ratio this month, calculated as the percentage of authenticated users against the total number of sessions
  • A graph visualizing your new users this month, including data for anonymous, authenticated, and total number of sessions. This graph can be toggled between the last 2 days and last 30 days of data.

Please note: This data is based on a calendar month, which may not directly align with your billing cycle. To view your monthly charges and bill, navigate to Plans & Billing.