@pagopa/dx-savemoney

v0.2.5

Published

13 days ago

Azure resource analyzer for finding unused or cost-inefficient resources.

0High
0Medium
0Low

azure typescript finops DX

DX Save Money

A TypeScript library for analyzing CSP (Cloud Service Provider) resources to identify potential cost inefficiencies and underutilized resources. It operates in read-only mode and does not modify, tag, or delete any resources; instead, it generates detailed reports to support FinOps decisions.

Supported Cloud Providers

✅ Azure

Full support for Azure resource analysis with intelligent detection and flexible reporting.

🚧 AWS (Coming Soon)

AWS support is planned for future releases. The architecture is designed to support multiple CSPs with provider-specific analyzers.

Architecture

The SaveMoney tool follows a modular architecture designed for multi-CSP support:

flowchart LR
    subgraph cli["CLI Layer"]
        CMDs[other cmds]
        CLI[savemoney]
    end
    subgraph pkg["Package Layer - @pagopa/dx-savemoney"]
        Config[Config Loader]
        Azure[Azure Analyzer]
        AWS[AWS Analyzer<br/>Coming Soon...]
    end
    subgraph svc["Azure Services"]
        ARM[Azure Resource Manager]
        Monitor[Azure Monitor Metrics]
        Identity[Azure Identity]
    end
    subgraph rsc["Azure Resources"]
        direction LR
        VM[Virtual Machines]
        Disk[Managed Disks]
        NIC[Network Interfaces]
        IP[Public IPs]
        ASP[App Service Plans]
        PE[Private Endpoints]
        SA[Storage Accounts]
        CA[Container Apps]
        SS[Static Web Apps]
    end
    CLI --> Config
    Config --> Azure
    Config -.-> AWS
    Azure --> ARM
    Azure --> Monitor
    Azure --> Identity
    ARM --> rsc
    Monitor --> rsc
    style CLI fill:#0078d4,color:#fff
    style Azure fill:#0078d4,color:#fff
    style AWS fill:#ccc,color:#666
    style Config fill:#107c10,color:#fff

Installation

npm install @pagopa/dx-savemoney
# or
pnpm add @pagopa/dx-savemoney
# or
yarn add @pagopa/dx-savemoney

Azure

Main Features

Multi-Subscription Analysis: Scans multiple Azure subscriptions in a single command.
Intelligent Detection: Uses Azure Monitor metrics (e.g. CPU, network traffic, transactions) to scientifically identify inactive resources.
Orphaned Resource Identification: Detects commonly "forgotten" resources like unattached disks, unassociated public IPs, and unused network interfaces.
Flexible Reporting: Offers multiple output formats:
- table: A human-readable summary for the terminal.
- json: Standard format for integration with other tools.
- detailed-json: A comprehensive output with all resource metadata, ideal for in-depth analysis via AI or custom scripts.
- lint: A linter-style output grouped by resource, with risk icons and a summary — ideal for CI pipelines and quick triage.
Simplified Configuration: Supports configuration via files, command-line options, environment variables, or an interactive prompt.
Configurable Thresholds: All analysis thresholds (CPU%, memory, transaction counts, etc.) can be overridden via the thresholds section of the YAML config file.
Tag Filtering: Restrict the analysis to resources that match specific tag key-value pairs.

Analyzed Resources

The tool analyzes the following Azure resource types with specific detection methods and risk levels:

Generic Checks

All resources are also checked for:

Missing tags: Resources without tags are flagged as potentially unmanaged
Location mismatch: Resources not in the preferred location are reported

Prerequisites

Node.js: Version 22 or higher.
Azure Credentials: The library uses DefaultAzureCredential from @azure/identity, which supports various authentication methods:
- Azure CLI (az login)
- Managed Identity
- Environment variables
- Visual Studio Code
- And more...

Usage

Quick Start

import { azure, loadConfig } from "@pagopa/dx-savemoney";

// Load configuration (from file, env vars, or interactive prompt)
const config = await loadConfig("./config.yaml");

// Run analysis and generate report
await azure.analyzeAzureResources(config, "table");

Configuration Inputs

The tool requires the following configuration:

Output Formats

The tool supports multiple output formats for different use cases:

How to Load Configuration

The loadConfig() function loads configuration in the following priority order:

Configuration file (pass file path as parameter)
Environment variable (ARM_SUBSCRIPTION_ID)
Interactive prompt (if no other configuration is found)

Example:

// From file
const config1 = await loadConfig("./config.yaml");

// From environment variable or prompt
const config2 = await loadConfig();

Configuration File Example

azure:
  subscriptionIds:
    - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  preferredLocation: italynorth
  timespanDays: 30
  verbose: false
  thresholds: # optional — omit to use built-in defaults
    vm:
      cpuPercent: 5
    storage:
      transactionsPerDay: 50

Thresholds Configuration

All numeric thresholds used during analysis can be overridden by adding a thresholds section inside the azure block of your config YAML. Only the fields you want to change are required — all others keep their built-in defaults.

Example (full override, config.yaml):

azure:
  subscriptionIds:
    - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  thresholds:
    vm:
      cpuPercent: 5
      networkInBytesPerDay: 10485760
    appService:
      cpuPercent: 10
      memoryPercent: 20
      premiumCpuPercent: 15
    containerApp:
      cpuNanoCores: 5000000
      memoryBytes: 52428800
      networkBytes: 100000
    storage:
      transactionsPerDay: 50
    publicIp:
      bytesInDDoS: 1048576
    staticSite:
      siteHits: 500
      bytesSent: 5242880

Default threshold values:

Usage Examples

Tag Filtering

import { azure, loadConfig } from "@pagopa/dx-savemoney";

const config = await loadConfig("./config.yaml");
// Analyze only resources tagged with environment=prod AND team=platform
await azure.analyzeAzureResources(
  {
    ...config,
    filterTags: new Map([
      ["environment", "prod"],
      ["team", "platform"],
    ]),
  },
  "lint",
);

Basic Usage

import { azure, loadConfig } from "@pagopa/dx-savemoney";

// Load from config file
const config = await loadConfig("./config.yaml");
await azure.analyzeAzureResources(config, "table");

Custom Configuration

import { azure } from "@pagopa/dx-savemoney";
import type { AzureConfig } from "@pagopa/dx-savemoney";

const config: AzureConfig = {
  subscriptionIds: ["sub-id-1", "sub-id-2"],
  preferredLocation: "italynorth",
  timespanDays: 30,
  verbose: true,
};

await azure.analyzeAzureResources(config, "json");

Generate Detailed Report

import { azure, loadConfig } from "@pagopa/dx-savemoney";

const config = await loadConfig();
// Generate detailed JSON with full resource metadata
await azure.analyzeAzureResources(config, "detailed-json");

Using Environment Variables

import { loadConfig, azure } from "@pagopa/dx-savemoney";

// Set environment variables
// ARM_SUBSCRIPTION_ID=sub1,sub2

const config = await loadConfig(); // Will read from env vars
await azure.analyzeAzureResources(config, "json");

AWS (Coming Soon)

AWS support is planned for future releases with similar capabilities:

Multi-account analysis
Resource-specific detection algorithms
Flexible reporting formats
AWS-specific configuration options

The API will follow a similar pattern:

import { aws, loadAwsConfig } from "@pagopa/dx-savemoney";

const config = await loadAwsConfig("./aws-config.json");
await aws.analyzeAwsResources(config, "table");

Development

Type Checking

pnpm typecheck

Linting

pnpm lint        # Auto-fix issues
pnpm lint:check  # Check without fixing

Testing

pnpm test              # Run tests
pnpm test:watch        # Watch mode
pnpm test:coverage     # With coverage report

Formatting

pnpm format        # Format code
pnpm format:check  # Check formatting