create-a-metric.md

Create a metric

yaml definition

    erDiagram
        metric {
            string metric_id       "The unique identifier for the metric (e.g., 'identity_dormant')."
            string title           "A brief title describing the metric."
            string description     "Detailed description of what the metric measures."
            string category        "Category to which this metric belongs (e.g., Identity Management)."
            float  slo             "Target Service Level Objective (e.g., 0.99)."
            float  slo_min         "Minimum acceptable Service Level Objective (e.g., 0.98)."
            float  weight          "Weight assigned to the metric for aggregation (e.g., 0.8)."
            string query           "The SQL or logic used to calculate the metric."
        }

Loading

Example file

metric_id: identity_dormant
title: "Identity - Inactive Identities"
description: |
  Ensure that all user accounts are active and in use.
category: "Identity Management"
slo: 0.99       # Between 98% and 99% triggers a warning
slo_min: 0.98   # Below 98% is critical
weight: 0.8     # the weight this metric has when being aggregated
query: |
  select
    profile.login as resource,
    'user' as resource_type,
    last_login  as detail,
    case
      when datediff('day',cast(last_login as date),current_date()) < 90 then 1
      else 0
    end as compliance
  from
    {{ ref('okta_users') }}
  where
    status = 'ACTIVE'

The query

The query is a jinja template. I've been inpspired by dbt, but don't be fooled - it is not dbt. The only function useful is {{ ref }} which is loosly doing the same thing. When you need to write a query, you can use the ref statement to reference a downloaded json file.

When writing a query, the following must be adhered to.

• The query MUST return resource,compliance,detail,resource_type.

Query definition

    erDiagram
        metric {
            string resource       "The unique identifier for the resource."
            float  compliance     "Specifies the percentage compliance between 0 and 1"
            string detail         "Additional detail to support remediation of any non-compliance"
            string resource_type  "The resource type, used to map against the asset register"
        }

Loading