FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

upbound/function-rds-metrics: A function for collecting an RDS instance metrics from CloudWatch · GitHub

/ function-rds-metrics Public
BranchesTags

Repository files navigation

function-rds-metrics

A Crossplane composition function for fetching Amazon RDS metrics from AWS CloudWatch and making them available in composition pipelines.

Overview

This function retrieves CloudWatch metrics for RDS database instances and writes them to pipeline context or XR status, enabling intelligent scaling decisions and monitoring workflows in Crossplane compositions.

Features

  • Dynamic Database Resolution: Supports both static database names and dynamic references to XR fields or pipeline context
  • Flexible Metric Selection: Fetch default or custom CloudWatch metrics for RDS instances
  • Pipeline Integration: Writes metrics to pipeline context for consumption by subsequent functions (e.g., function-claude for AI-driven scaling)
  • Multiple Output Targets: Store metrics in XR status or pipeline context

Input Schema

apiVersion: rdsmetrics.fn.crossplane.io/v1beta1
kind: Input
spec:
  # Database identifier (use either databaseName OR databaseNameRef)
  databaseName: "my-rds-instance"           # Static database name
  databaseNameRef: "xr.metadata.name"      # Dynamic reference to XR field
  
  # AWS configuration
  region: "us-west-2"                      # AWS region (optional, defaults to us-east-1)
  
  # Metrics configuration
  metrics:                                 # List of CloudWatch metrics to fetch (optional)
    - "CPUUtilization"
    - "DatabaseConnections"
    - "FreeableMemory"
    - "FreeStorageSpace"
  period: 300                             # Data granularity in seconds (optional, default: 300)
  
  # Output configuration
  target: "context.metricsResult"         # Where to store metrics (context.* or status.*)

Database Name References

The function supports dynamic database name resolution using references:

XR References

  • xr.metadata.name - Use the XR's metadata name (common pattern for database identifiers)
  • xr.spec.database.instanceId - Reference nested spec fields
  • xr.status.database.actualName - Reference nested status fields

Context References

  • context.databaseName - Reference pipeline context from previous functions

Default Metrics

When no metrics are specified, the function fetches these default CloudWatch metrics:

  • CPUUtilization - CPU usage percentage
  • DatabaseConnections - Number of active connections
  • FreeableMemory - Available memory in bytes
  • FreeStorageSpace - Available storage in bytes
  • ReadIOPS - Read I/O operations per second
  • WriteIOPS - Write I/O operations per second
  • ReadLatency - Read operation latency
  • WriteLatency - Write operation latency

Usage Examples

Basic Usage with Static Database Name

apiVersion: apiextensions.crossplane.io/v1
kind: Composition
spec:
  mode: Pipeline
  pipeline:
  - step: fetch-rds-metrics
    functionRef:
      name: function-rds-metrics
    input:
      apiVersion: rdsmetrics.fn.crossplane.io/v1beta1
      kind: Input
      databaseName: "my-production-db"
      region: "us-west-2"
      target: "status.metrics"
    credentials:
      - name: aws-creds
        source: Secret
        secretRef:
          namespace: crossplane-system
          name: aws-creds

Dynamic Database Name from XR Metadata

apiVersion: apiextensions.crossplane.io/v1
kind: Composition
spec:
  mode: Pipeline
  pipeline:
  - step: fetch-rds-metrics
    functionRef:
      name: function-rds-metrics
    input:
      apiVersion: rdsmetrics.fn.crossplane.io/v1beta1
      kind: Input
      databaseNameRef: "xr.metadata.name"
      region: "us-west-2"
      target: "context.metricsResult"

AI-Driven Scaling Pipeline

apiVersion: apiextensions.crossplane.io/v1
kind: Composition
spec:
  mode: Pipeline
  pipeline:
  - step: fetch-metrics
    functionRef:
      name: function-rds-metrics
    input:
      apiVersion: rdsmetrics.fn.crossplane.io/v1beta1
      kind: Input
      databaseNameRef: "xr.metadata.name"
      region: "us-west-2"
      metrics:
        - "CPUUtilization"
        - "DatabaseConnections"
        - "FreeableMemory"
      target: "context.rdsMetrics"
  
  - step: ai-scaling-decision
    functionRef:
      name: function-claude
    input:
      apiVersion: claude.fn.crossplane.io/v1beta1
      kind: Input
      prompt: "Analyze RDS metrics and recommend scaling actions"
      contextRef: "rdsMetrics"
      target: "status.scalingRecommendation"

Output Format

The function outputs metrics in this structure:

databaseName: "my-production-db"
region: "us-west-2"
timestamp: "2025-07-27T10:20:56Z"
metrics:
  CPUUtilization:
    value: 45.2
    unit: "Percent"
    timestamp: "2025-07-27T10:20:00Z"
  DatabaseConnections:
    value: 12
    unit: "Count"
    timestamp: "2025-07-27T10:20:00Z"
  FreeableMemory:
    value: 1073741824
    unit: "Bytes"
    timestamp: "2025-07-27T10:20:00Z"

Testing Examples

The example/ directory contains several testing scenarios:

Test Basic Metrics Fetch

crossplane render example/basic-metrics-query/xr.yaml example/basic-metrics-query/composition.yaml example/functions.yaml --function-credentials=example/secrets/aws-creds.yaml

Test Dynamic Database Name Resolution

crossplane render example/database-ref-from-xr/xr.yaml example/database-ref-from-xr/composition.yaml example/functions.yaml --function-credentials=example/secrets/aws-creds.yaml --include-context

Test Custom Metrics

crossplane render example/custom-metrics-query/xr.yaml example/custom-metrics-query/composition.yaml example/functions.yaml --function-credentials=example/secrets/aws-creds.yaml

AWS Credentials

The function requires AWS credentials with CloudWatch read permissions. Provide credentials as a Kubernetes secret:

apiVersion: v1
kind: Secret
metadata:
  name: aws-creds
  namespace: crossplane-system
type: Opaque
data:
  credentials: <base64-encoded-aws-credentials-file>

The credentials file should be in AWS CLI format:

[default]
aws_access_key_id = YOUR_ACCESS_KEY
aws_secret_access_key = YOUR_SECRET_KEY

Development

Building the Function

# Run code generation
go generate ./...

# Run tests
go test ./...

# Build the function's runtime image
docker build . --tag=function-rds-metrics

# Build a function package
crossplane xpkg build -f package --embed-runtime-image=function-rds-metrics

Local Development

For local development, use the Development runtime annotation:

apiVersion: pkg.crossplane.io/v1beta1
kind: Function
metadata:
  name: function-rds-metrics
  annotations:
    render.crossplane.io/runtime: Development

Then run the function locally:

go run . --insecure --debug

Integration with Other Functions

This function is designed to work in composition pipelines with other functions:

  • function-claude: Provides AI-driven analysis of RDS metrics for intelligent scaling decisions

Error Handling

The function implements robust error handling:

  • AWS Config Errors: Returns empty metrics but continues pipeline execution
  • Missing Database: Fails fast with clear error messages
  • CloudWatch API Errors: Logs errors but attempts to continue with available metrics
  • Invalid References: Provides detailed error messages for debugging

About

A function for collecting an RDS instance metrics from CloudWatch

Resources

Readme
Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases

Packages

Contributors

Languages

Back | FazBrowse Home | New Git URL