cyber-metrics

The cyber-metrics project is responsible for extracting raw data from data sources, and generating security metrics. Once the metrics are produced, the data is sent to the Cyber Dashboard.

Collectors

• How to run an Extraction
• Writing a collector
• List of Collectors

Metrics

• List of Metrics

Overview

The cyber-metrics program is responsible for generating the cyber metrics used by the dashboard tooling. It has the following key requirements

• Download the raw data from the source systems (collectors)
• Generate pre-defined metrics based off yaml configuration
• Upload the generated metrics to a destination (postgres, or the dashboard API)

Architecture

graph LR

    slack:::external
    source[Source]:::external
    collector[Collector]:::theme
    env([Environment variables]):::config
    json[(json)]:::data

    env --> collector
    source --> collector

    collector --> slack

    yaml([metric definition]):::config
    parquet[(parquet)]:::data
    postgres[(postgres)]:::data
    metric:::theme

    collector --> json

    yaml --> metric
    json --> metric
    metric --> parquet
    metric --> postgres
    metric --> slack
    
    classDef external stroke:#0f0
    classDef theme stroke:#00f
    classDef data stroke:#f00
    classDef config stroke:#ff0

Loading