Skip to content
Metrics
Metrics

Metrics

Out of the box, Breezz Metrics comes with predefined metrics—such as Daily API Requests or Permission Set Usage—allowing you to monitor platform boundaries immediately. Additionally, it offers extensible custom calculator tools to measure business-specific data and track activity within the Breezz Framework itself.

Breezz Metrics Configuration

Basic metrics settings can be managed directly in the Breezz Setup tab.

Navigate to Breezz Setup → Metrics → Metric Setup.

Metrics Setup

General Setup Fields

  • Enable Metrics: Toggle (Yes / No) to globally enable or disable the metrics background calculation system.
  • Metrics Lifespan: Value in days determining how long metric data records are retained in the system before being automatically purged.
  • Breezz Metric Clean-Up Job Interval: Execution interval in hours for the automated cleanup job. Can be disabled if needed.
  • Number of Records in Metric Clean-Up Job: Defines the batch size processed per execution by the cleanup job.

Registering a Custom Metric

To define a new metric, navigate to Breezz Setup → Metrics and click New.

Metrics New

Configuration Fields

  • Metrics Calculation Type: Selects the calculation engine for the metric:
    • Custom: Uses an Apex class implementing forvendi.Metrics.MetricCalculator.
    • Count SOQL Query: Executes a custom SOQL COUNT() query.
    • Count Package Async Future Usage: Tracks Breezz async future callout executions.
    • Count Package Async Queueable Usage: Tracks Breezz async Queueable jobs.
    • Count Package Async Batches Usage: Tracks Breezz Batch Apex runs.
    • Count Package Licenses Usage: Tracks managed package User License usage.
    • Check Package Expiration: Monitors expiration dates for managed packages.
    • Count User Licenses Usage: Tracks standard Salesforce User Licenses.
    • Count Permission Set Licenses Usage: Tracks active Permission Set Licenses.
    • Platform Limits Usage: Tracks standard Salesforce system limits.
    • Async Job Stats: Aggregates statistics for selected asynchronous jobs.
  • Metric API Name: The unique developer name for the metric.
  • Enable Measurement: Toggle to activate or suspend automatic calculation after deployment.
  • Execution Interval: Determines how frequently the metric is recalculated.
  • Metrics Calculator Class Name: (Required for Custom and SOQL Query types) Defines the Apex class implementing the calculator interface (e.g., forvendi.Metrics.CountQueryMetricsCalculator).
  • Group Name: Assigns a category/group to cluster related metrics.
  • Parameters: Additional parameters passed to custom calculator classes.
  • Warning Threshold: Warning limit threshold before reaching an error state.
  • Error Threshold: Maximum acceptable limit before marking the metric in an error state.
  • Default Limit: Default baseline value used during calculations to verify custom limit states.

Disabling Metrics

To turn off any metric that is no longer needed, navigate to Metrics, search for the metric using the search bar or filters, click the multi-menu action button, and select Disable.

Disable Metrics

Custom Metrics Calculator

Like most Breezz components, metrics are fully extensible. Custom metric implementations require an Apex class that extends forvendi.Metrics.MetricCalculator.

Breezz includes a built-in code generator for custom calculators. You can access it by navigating to Metrics → Generate Metrics Calculator Code in the top right corner.

Metrics Calculator

Example