Vaultx.Config (Vaultx v0.7.0)

View Source

Modern configuration management system for VaultX.

This module provides the main interface to the configuration system, delegating to specialized modules for specific functionality.

Architecture

  • Config: Main configuration interface (this module)
  • Builder: Configuration building and environment merging
  • Validator: Configuration validation and error checking
  • Optimizer: Performance and security optimization suggestions
  • Diagnostics: Health monitoring and diagnostics

Usage Examples

# Get configuration
config = Vaultx.Config.get()

# Get specific values
url = Vaultx.Config.get_value(:url)

# Validate configuration
:ok = Vaultx.Config.validate()

# Get health status
status = Vaultx.Config.health_status()

Summary

Types

config_analysis()

Functions

analyze()

Performs comprehensive configuration analysis.

diagnose()

Provides backward-compatible diagnose function for legacy code.

feature_enabled?(feature)

Modern feature management with intelligent analysis.

features_status()

Gets comprehensive feature status with recommendations.

get()

Gets the complete configuration.

get_health_status()

Gets the configuration health status.

get_value(key, default \\ nil)

Gets a specific configuration value by key.

get_values(keys)

Gets multiple configuration values efficiently.

has_value?(key)

Checks if a configuration key exists and has a non-nil value.

health_status()

Provides a comprehensive health check of the configuration system.

validate()

Validates the current configuration.

validate_and_optimize()

Validates and provides optimization recommendations.

Types

config_analysis()

@type config_analysis() :: %{
  valid: boolean(),
  issues: [map()],
  suggestions: [map()],
  performance_score: float(),
  security_score: float(),
  connectivity_status: atom(),
  environment_compatibility: map()
}

Functions

analyze()

@spec analyze() :: {:ok, config_analysis()}

Performs comprehensive configuration analysis.

Examples

iex> {:ok, analysis} = Vaultx.Config.analyze()
iex> analysis.valid
true

diagnose()

@spec diagnose() :: %{
  valid: boolean(),
  warnings: [String.t()],
  errors: [String.t()],
  recommendations: [String.t()]
}

Provides backward-compatible diagnose function for legacy code.

This function converts the modern analysis format to the legacy format expected by existing code.

Examples

iex> Vaultx.Config.diagnose()
%{
  valid: true,
  warnings: [],
  errors: [],
  recommendations: []
}

feature_enabled?(feature)

@spec feature_enabled?(atom()) :: boolean()

Modern feature management with intelligent analysis.

This provides enhanced feature detection and recommendations.

features_status()

@spec features_status() :: %{
  enabled: [atom()],
  disabled: [atom()],
  recommendations: [String.t()]
}

Gets comprehensive feature status with recommendations.

get()

@spec get() :: map()

Gets the complete configuration.

This is the primary configuration access method that provides a clean, validated configuration map.

get_health_status()

@spec get_health_status() :: :healthy | :degraded | :unhealthy | :critical

Gets the configuration health status.

This provides a quick health assessment without complex analysis.

Examples

iex> Vaultx.Config.get_health_status()
:healthy

get_value(key, default \\ nil)

@spec get_value(atom(), any()) :: any()

Gets a specific configuration value by key.

Examples

iex> Vaultx.Config.get_value(:url)
"https://vault.example.com:8200"

iex> Vaultx.Config.get_value(:timeout, 60_000)
30000

get_values(keys)

@spec get_values([atom()]) :: %{required(atom()) => any()}

Gets multiple configuration values efficiently.

Examples

iex> Vaultx.Config.get_values([:url, :timeout, :ssl_verify])
%{url: "https://vault.example.com:8200", timeout: 30000, ssl_verify: true}

has_value?(key)

@spec has_value?(atom()) :: boolean()

Checks if a configuration key exists and has a non-nil value.

health_status()

@spec health_status() :: :healthy | :degraded | :unhealthy | :critical

Provides a comprehensive health check of the configuration system.

validate()

@spec validate() :: :ok | {:error, [String.t()]}

Validates the current configuration.

Examples

iex> Vaultx.Config.validate()
:ok

iex> Vaultx.Config.validate()
{:error, ["URL is required", "Invalid timeout value"]}

validate_and_optimize()

@spec validate_and_optimize() :: {:ok, map()}

Validates and provides optimization recommendations.

Examples

iex> {:ok, result} = Vaultx.Config.validate_and_optimize()
iex> result.optimization_potential
:low