Fluent Commerce Docs

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

Content in this track:

Fluent Big Inventory - Features Overview

Getting Started with Fluent Big Inventory

How to Submit Inventory Batches

Metrics usage for Platform Observability

End Of Track

Content in this track: How Metrics works

Essential knowledge

Author:

Kirill Gaiduk

Changed on:

9 July 2024

Overview

This document is intended to describe to implementers Metrics technical details within the Fluent Big Inventory product.Pre-requisites:

You should have knowledge of Metrics
You should have knowledge of OMX Workflow Framework.
You should have knowledge of Events.
You should have knowledge of GraphQL.

Key points

All customers' Metrics are isolated in the dedicated workspaces.
Metrics are captured from the Fluent APIs, Orchestration Engine (Rubix), Batch Pre-Processing, and Inventory Feeds.
Use `metricInstant` and `metricRange` GraphQL queries to retrieve the Metrics data.

Metrics Data Segregation

All customers' Metrics are isolated on the Fluent platform due to the Metrics Data Segregation. The purpose of data segregation is to:

Ensure data security, privacy, and compliance;
Maintain the Metrics' data integrity;
Prevent unauthorized access from different customers.

Metrics Data multi-tenancy solution principals:

One Metrics workspace per customer per environment.
One Metrics workspace is responsible for managing the Metrics Data for only one customer:
- writing,
- storing,
- querying.
One Metrics workspace stores the Metrics for all the Retailers associated with one customer/account.

Metrics Managing Flow

Metrics managing flow includes the following steps:1. We instrument the Application Source Code to capture the Platform Metrics as activity occurs.Two primary applications play pivotal roles in the Inventory Processing flow:

Fluent APIs act as an entry point, accepting external HTTP API requests from the customer.
The Metrics captured for Fluent APIs pertain to the requests that:
- the Fluent platform has “received”,
- or the ones customers have “sent”.
Orchestration engine (Rubix) processes the customer’s business logic by executing Orchestration event requests.
The Metrics captured here relate to the Fluent platform's requests “processed”.

Note

For more details, check the Metrics usage for Platform Observability.

2. The Metrics data is routed (through the Metrics Collector) to each customer-specific Metrics workspace by remote writing endpoint based on the `account_id` label value. The Metrics data is stored in the Metrics workspace and ready for query.

Note

Find the Metrics that are currently available in the Available Metrics section described in the Metrics usage for Platform Observability article.

Metrics Data Access Management

Metrics API is introduced as part of GraphQL API.
GraphQL API provides the authorization functionality:
- Validation of the user token correctness.
- Validation if the user has been granted the accessible roles/permissions.

Info

`METRICS_VIEW` permission has been created for the Metrics data access management.

The introduction of GraphQL API as a proxy guarantees that all the Metrics queries requested by one user always belong to one specific customer/account rather than all customers' Metrics being accessible by any users.

Info

Metrics API query operations could be utilized in OMX UX Framework Manifest directly.

Metrics API Querying Flow

Metrics API querying flow includes the following steps:1. Two Metrics GraphQL queries are available for customers to retrieve the Metrics data:

`metricInstant`
`metricRange`

Info

GraphQL API receives the request by calling the Metrics GraphQL query with the user token.

2. GraphQL API identifies the account ID for the user from:

The user token,
and `fluent.account` request header.

Then Metrics API queries the corresponding Metrics workspace by the account ID.3. After the Metrics API gets the Metrics workspace, it:

Sends the PromQL (Prometheus Query Language) the user provides to the Metrics workspace.
Receives the response from the Metrics workspace.
Maps the response back to Metrics API schema (check the Metrics API Schema section in the Getting Started with Metrics API).
Returns the Metrics query result to the user.

Note

For more details, check the Getting Started with Metrics API.

Related content

Metrics Overview

Edited 533 days ago

This document is intended to introduce the Metrics and describe their place within the Fluent Big Inventory product.Pre-requisites:

You should have knowledge of the Inventory.
You should have knowledge of OMX Workflow Framework.
You should have knowledge of Events.
You should have knowledge of GraphQL.

Getting Started with Metrics API

Edited 597 days ago

This guide is intended to provide implementers with information about the Metrics API within the Fluent Big Inventory product, describing its functionalities and utilization principles within the Fluent Platform.Pre-requisites:

You should have knowledge of How Metrics works.
You should have knowledge of Metrics usage for Platform Observability.
You should have knowledge of GraphQL.
You should configure your User role with `METRICS_VIEW` permission for Metrics data access.

Metrics usage for Platform Observability

Edited 597 days ago

This document is intended to describe to implementers which Metrics are available within the Fluent Big Inventory product and what kind of data they provide to achieve Platform Observability.Pre-requisites:

You should have knowledge of How Metrics works.
You should have knowledge of Events.
You should have knowledge of Fluent APIs.

Kirill Gaiduk

Knowledge Tracks Related To This Topic

All about Big Inventory

Fluent Big Inventory - Features Overview

Getting Started with Fluent Big Inventory

Inventory Ingestion

Inventory Batch

How to Submit Inventory Batches

Fluent Big Inventory Web App

Metrics Overview

How Metrics works

Metrics usage for Platform Observability

Inventory Feeds

How do Inventory Feeds work

Content in this track:

Fluent Big Inventory - Features Overview

Getting Started with Fluent Big Inventory

Inventory Ingestion

Inventory Batch

How to Submit Inventory Batches

Fluent Big Inventory Web App

Metrics Overview

How Metrics works

Metrics usage for Platform Observability

Inventory Feeds

How do Inventory Feeds work

End Of Track

How Metrics works

How Metrics works

Overview

Key points

Metrics Data Segregation

Metrics Managing Flow

Metrics Data Access Management

Metrics API Querying Flow

Related content

Metrics Overview

Getting Started with Metrics API

Metrics usage for Platform Observability

Kirill Gaiduk

Knowledge Tracks Related To This Topic

Building Blocks

By Type

Helpful Resources

Quick Links