🥯
Everything
  • Best Practices and Guidelines
    • ChatGPT Prompts
    • Documentation Guideline
    • GitBook Spaces
    • GitHub Guideline
    • Internal Usage
  • Tools
    • End to End Order Flow
      • Order Creation
      • Order Import
      • Order Brokering
      • Order Fulfillment
      • Order Fulfillment Notification
    • Git
      • How to Create Issue on Git
    • Jira
      • Feature Request on Jira
    • Launchpad
      • Fulfillment
        • Stuck Orders in Fulfillment App
      • Job Manager
        • Check Job Frequencies
        • Job Runtime Error
        • Mismatch Time Zone
    • Napita
      • Glossary
      • Schedule Processors
      • View and Manage Processors
      • Flow Definitions
      • Verify Processor Properties
      • Bulletins
      • Data Provenance
      • Troubleshooting
        • Data Export Errors
        • Queue Errors
        • Fetch Put SFTP Retry
    • Netsuite
      • Managing Saved Searches
    • Ofbiz
      • Orders
        • Multicurrency Sales Orders
        • POS Order Refresh Failure
        • Pre-Order Catalog Sync
        • Reindex Order after Solr Down Time
      • Products
        • Product Duplication
      • Inventory
        • Add New Variance Reason
      • Data Manager Configuration
        • Create a Job Using Data Manager Configuration
        • SFTP Issue
    • Shopify
      • How to Access Shopify POS APP
      • How to Create Draft Order in Shopify
    • Tathya
      • Database Configuration
        • Additional Settings
      • Charts Creation
        • Selecting Database & Schema
        • View & Save Chart
        • Charts Access
        • Create Multiple Charts
        • LogInsight Charts
      • Understanding Dashboards
        • Configuring Dashboards
        • Dashboards Access
        • Dashboard Options
        • Dashboard Customizations
        • Link Configuration
        • Set Multi-Day Filters
      • Configuring Alerts & Reports
        • Creating Alerts
        • Creating Reports
        • Alternate Interfaces to Schedule Reports
      • Creating Roles
        • List & Modify Roles
      • Creating User
        • Creating LDAP Account
        • Tathya Authentication
        • Listing User in Tathya
        • User Permissions
      • Troubleshoting
        • Reporting Discrepancies
        • Tathya login Issue
      • How to
        • How to Create User on Tathya
        • How to Create Alpha Role on Tathya
        • How to Request for the Report
  • Client Communication
    • Templated Replies
    • Ticket and Release Mangemnet
  • Monitoring
    • Sanity Checklist
    • System Monitoring Guide
  • Hotwax Deployment & Versions
    • HotWax Commerce Deployment
    • Launch Machine
    • Update OMS Version
    • Rollback OMS Version
    • Optional Plugins
Powered by GitBook
On this page
  • Key Monitoring Tasks
  • 1. Client Dashboard Monitoring (Order Sync, Inventory, Fulfillment)
  • 2. Job Monitoring
  • 3. Reset Inventory File Processing
  • 4. Napita (NiFi) Monitoring
  • Handling and Escalating Issues
Edit on GitHub
Export as PDF
  1. Monitoring

System Monitoring Guide

By actively monitoring our systems, we can quickly detect potential issues and address them before they become more serious problems. Continuous system monitoring allows us to track performance, identify irregularities, and resolve bottlenecks in real-time. System monitoring helps minimize downtime, enhance user experience, and prevent disruptions to business processes.

Key Monitoring Tasks

1. Client Dashboard Monitoring (Order Sync, Inventory, Fulfillment)

Monitoring the Client's Operational Dashboard is important to ensure the system works correctly. This involves checking if orders are being imported accurately, identifying orders that have been approved but not fulfilled for an extended period, and tracking the number of orders that have gone into unfillable parking.

Frequency: 3 times a day (9 AM, 3 PM, 8 PM)

Steps:

Order Sync Dashboard:

  • Check all order sync dashboards on Tathya to ensure no orders were missed during import.

  • Verify that no order has been in the created state for more than 3 hours.

Inventory and Fulfillment Dashboards:

  • Ensure there are no unexpected errors in the charts.

  • To know more about reports click here.

We need to check these dashboards for all clients.

Instance-Specific Dashboards:

Instance
Dashboards

KREWE / UCG / Mephisto / Gorjana

Order Sync

CARIUMA / PERRYELLIS / E-BIKE

Monitoring Dashboard

ADOC

ADOC-Integrations

NEWERA

NEC-Integration / NEC - Order Overview

  • Monitor dashboards for issues such as missing order attributes, Shopify order import errors, and Shopify fulfillment errors,Duplicate Orders Report.

  • Each instance has specific order attributes to monitor (e.g., Municipio for all ADOC instances ,Canton for ADOC-CR, Signified_Approved for UCG).


2. Job Monitoring

We need to monitor jobs because it can create issues if a job takes more than 45 minutes. Additionally, if an instance goes down while a job is running, it can get stuck in a running status. It is also important to identify and troubleshoot the reason if a job fails frequently. Jobs can be monitored via the Job Manager App or Job Monitoring Dashboard on Tathya.

Frequency: 3 times a day (9 AM, 3 PM, 8 PM)

Scenario: If the Job is Stuck in Running Status

Steps:

  • Update the status of the job from running to failed by editing the information from the web tools. The status ID is from the job sandbox.

  • Note that the reset inventory file from external systems may take longer but should not exceed 45 minutes.

Scenario: If the Job Continuously Fails

  • Check if any job has failed multiple times.

  • Determine the reason for failure, especially if it is uncommon, and troubleshoot accordingly.

  • The retry count of the job on the dashboad indicates how many times the job has failed.

  • The processPendingDataManager job which runs in every 5 minutes can be ignored if it fails once or twice a day. However, if it keeps failing multiple times, it should be monitored for potential issues.

Failed Files:

  • Investigate any file failures.

  • Troubleshoot and report any uncommon failures.

Scenario: Data Manager Logs Monitoring

  • The Data Manager Logs record details of file processing from external systems, including log ID, user, import time, imported file, error records, and the file's processing start and end times.

    Frequency: Daily

    Steps:

    Pending and Running Files:

    • Reports have been set up for each client on Tathya.

    • Check logs for all clients to ensure no files are pending or running for too long.

    • If a file has been running for 2 hours or more, inform the person responsible for that client. Inventory files are an exception, as they contain large volumes of data and take longer to process.

    • For any pending files, check if an inventory file or any other ongoing file is in progress that might be preventing the pending files from proceeding.

    Failed Files:

    • Investigate any file failures.

    • Troubleshoot and report any uncommon failures.

3. Reset Inventory File Processing

Reset inventory files come from an external system and set the inventory for products in the OMS. Resetting the inventory is essential to maintain an accurate inventory count.

Frequency: Daily, primarily checked at 3 PM

File Location:

  • WMS/ERP Systems: Navigate to Hamburger Menu -> MDM -> EXIM -> Imports -> Warehouse -> RESET INVENTORY.

  • Shopify: Navigate to Hamburger Menu -> MDM -> EXIM -> Shopify Jobs -> MDM -> Shopify Inventory Sync MDM.

Steps:

File Reception:

  • Confirm whether the reset inventory file has been received from the external system.

  • Check for invalid file formats or records. If the file is invalid, report the issue to the client.

File Timing: Ensure all inventory files are processed by the following times:

Instance
Process by Time

KREWE

1 PM

UCG

3 PM

Gorjana

3 PM

ADOC

3 PM

NEWERA

10 PM / 9 AM

  • If the file has not been received by the above timings:

    • Verify that the file has been placed at the SFTP location.

    • If the file is not found, contact the client to inquire about the delay.

    • If the file is found, wait till it processes.


4. Napita (NiFi) Monitoring

Napita is a data integration tool designed to automate data flow between systems in real-time. HotWax Commerce uses Napita to transform and export data. Sometimes, files placed at the SFTP location by Shopify may face issues during Napita's transformation process.

  • For troubleshooting such issues, refer to the Napita Troubleshoot Document.

In Apache NiFi, the ways to monitor and debug errors are:

  • Grafana: If an error is detected, Grafana can send a mail alert to notify administrators. When Grafana sends an email alert, the content of the email typically includes information that helps to understand the context of the alert and troubleshoot the issue further.

Administrators added in Grafana mailing list can only view the mail for monitorring.

  • Viewing Errors via NiFi Summary and Processor Logs: NiFi Summary (located in the NiFi UI) provides a high-level view of all processors and their status. You can use this view to quickly identify which processors are experiencing issues.

    • You can fetch error logs or statuses using these processor:

      • InvokeHTTP

      • PutSFTP

      • FetchSFTP

    • Check daily if any processor has stopped and inform or discuss it with the person responsible for that client.

    • You can check the processor at: https://napita.hotwax.io/nifi/

    • You can double-click on the Processor to open it and view which process groups are stopped.


Handling and Escalating Issues

When encountering an issue, the first step is to attempt resolution independently using available knowledge, tools, and resources. If the problem persists, escalate it by consulting with your mentor. For new issues, document the troubleshooting process and create a ticket for tracking the troubleshooting steps. Also, create a ticket in the OMS Backlog if any development work is needed for the issue.

Always inform the client as soon as an issue arises, letting them know that it is being investigated (e.g., "We have identified an issue and are looking into it"). Once the issue is resolved, update the client with the outcome. If the issue is critical, also explain the cause to keep them informed (e.g., "The issue occurred due to...").

PreviousSanity ChecklistNextHotWax Commerce Deployment

Last updated 6 days ago

Login and look for the relevant Process Group. For example, in the image below, a red square block inside the process group indicates 53 processors are stopped.