similarweb/finala

Finala

镜像概述和主要用途

Finala是一款云资源扫描工具，旨在分析和报告云环境中浪费及未使用的资源，帮助用户减少不必要的支出。该工具基于YAML配置文件（无需编写代码），可通过默认配置或自定义YAML文件进行资源检测，并将报告结果存储到指定位置。目前主要支持AWS云服务，未来将扩展更多云平台支持。

核心功能和特性

支持的AWS服务

• RDS
• EC2（包括ELB、ALB、EBS）
• DynamoDB
• ElasticCache
• DocumentDB
• IAM用户最后活动
• Lambda
• Neptune
• Kinesis
• RedShift

核心特性

• 基于YAML配置：无需代码，通过YAML文件定义资源检测规则
• 多组件架构：包含API、UI、Notifier和Collector四大组件
• 可视化仪表板：直观展示资源分析结果
• 通知功能：支持Slack通知，及时推送资源利用率低的警报
• 多账户多区域支持：可配置多个AWS账户和区域进行扫描
• 自定义检测规则：支持根据 CloudWatch 指标定义资源利用率阈值

使用场景和适用范围

• AWS成本优化：识别未充分利用或闲置的资源，降低云支出
• 资源利用率监控：持续监控EC2、RDS等核心服务的使用情况
• 未使用资源清理：发现长期闲置的资源（如零连接的RDS、零流量的ELB）
• 多账户管理：集中管理多个AWS账户的资源使用情况
• 团队协作：通过Slack通知让团队及时了解资源优化机会

使用方法和配置说明

组件说明

Finala由以下四个核心组件构成：

• API：RESTful API服务器，接收Collector的事件数据并为UI提供服务。配置文件示例：https://github.com/similarweb/finala/blob/master/configuration/api.yaml

• UI：用户界面，以可视化方式展示资源分析结果。

• Notifier：通知组件，支持多种通知方式（目前仅支持Slack），向指定通知组推送"利用率低"的资源报告。配置文件示例：https://github.com/similarweb/finala/blob/master/configuration/notifier.yaml

• Collector：收集并分析资源数据，根据https://github.com/similarweb/finala/blob/master/configuration/collector.yaml%E4%B8%AD%E5%AE%9A%E4%B9%89%E7%9A%84%E9%98%88%E5%80%BC%E6%A3%80%E6%B5%8B%E8%B5%84%E6%BA%90%E5%88%A9%E7%94%A8%E7%8E%87%E3%80%82%E6%94%AF%E6%8C%81%E9%85%8D%E7%BD%AE%E5%A4%9A%E4%B8%AAAWS%E8%B4%A6%E6%88%B7%E5%92%8C%E5%8C%BA%E5%9F%9F%E3%80%82

配置文件详解

AWS账户和区域配置

在collector.yaml中配置AWS账户和区域：

yaml
providers:
  aws:
  - name: <ACCOUNT_NAME>
    # 若未设置以下变量，将使用环境变量
    access_key: <ACCESS_KEY>
    secret_key: <SECRET_KEY>
    session_token: "" # 可选，默认不设置
    regions:
      - <REGION>

资源检测规则配置

可通过YAML定义资源检测规则，以下是常用示例：

1. 检测CPU利用率低于5%的EC2实例（过去7天）

yaml
ec2:
  - description: EC2 CPU利用率 
    metrics:
    - name: CPUUtilization
      statistic: Maximum
    period: 24h 
    start_time: 168h # 24h * 7d
    constraint:
      operator: "<"
      value: 5

2. 检测过去7天零连接的RDS实例

yaml
rds:
  - description: 数据库连接数
    metrics:
    - name: DatabaseConnections
      statistic: Sum
    period: 24h  
    start_time: 168h # 24h * 7d
    constraint:
      operator: "=="
      value: 0

3. 检测过去7天零流量的ELB

yaml
elb:
  - description: 负载均衡器请求数
    metrics:
    - name: RequestCount
      statistic: Sum
    period: 24h 
    start_time: 168h # 24h * 7d 
    constraint:
      operator: "=="
      value: 0   

4. 检测DynamoDB预配置RCU与实际消耗RCU差异超过10%

yaml
dynamodb:
  - description: 预配置读容量单位利用率
    metrics:
    - name: ConsumedReadCapacityUnits
      statistic: Sum
    - name: ProvisionedReadCapacityUnits
      statistic: Sum
    period: 24h 
    start_time: 168h # 24h * 7d
    constraint:
      formula: ConsumedReadCapacityUnits / ProvisionedReadCapacityUnits * 100
      operator: "<"
      value: 10

部署方式

使用Kubernetes部署

参考https://github.com/similarweb/finala-helm%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E9%83%A8%E7%BD%B2%E8%AF%B4%E6%98%8E%E3%80%82

使用Docker Compose本地运行

shell
docker-compose up

UI将暴露在8080端口，可通过[***]

组件单独运行

Collector

shell
go run main.go collector -c ./configuration/collector.yaml

Notifier

shell
go run main.go notifier -c ./configuration/notifier.yaml

API

shell
go run main.go api -c ./configuration/api.yaml

UI

shell
cd ui 
npm run dev

或

shell
make build-ui
go run main.go ui -c ./configuration/ui.yaml

界面展示

仪表板

!https://raw.githubusercontent.com/similarweb/finala/master/docs/dashboard.png

未使用RDS报告

!https://raw.githubusercontent.com/similarweb/finala/master/docs/resource.jpg

通知示例

!https://raw.githubusercontent.com/similarweb/finala/master/docs/slack.png