Prometheus Adapter 使用教程

1. 项目的目录结构及介绍

Prometheus Adapter 是一个 Kubernetes 自定义指标 API 的实现，使用 Prometheus 作为数据源。项目的目录结构如下：

prometheus-adapter/
├── cmd
│   └── config-gen
│       └── main.go
├── docs
│   └── walkthrough.md
├── pkg
│   ├── api
│   ├── config
│   ├── metrics
│   └── provider
├── Dockerfile
├── Makefile
├── README.md
└── go.mod

• cmd/config-gen: 包含用于生成配置文件的工具。
• docs: 包含项目的文档，如使用教程和示例。
• pkg: 包含项目的主要代码，如 API、配置、指标和提供者等。
• Dockerfile: 用于构建 Docker 镜像。
• Makefile: 包含项目的构建和测试命令。
• README.md: 项目的主文档。
• go.mod: Go 模块文件，定义项目的依赖。

2. 项目的启动文件介绍

项目的启动文件位于 cmd 目录下。主要的启动文件是 cmd/config-gen/main.go，它用于生成配置文件。

package main

import (
    "flag"
    "fmt"
    "os"

    "github.com/kubernetes-sigs/prometheus-adapter/cmd/config-gen/app"
)

func main() {
    var rateInterval string
    var labelPrefix string

    flag.StringVar(&rateInterval, "rate-interval", "5m", "The interval to use for rate calculations")
    flag.StringVar(&labelPrefix, "label-prefix", "kube", "The prefix to use for labels")

    flag.Parse()

    config, err := app.GenerateConfig(rateInterval, labelPrefix)
    if err != nil {
        fmt.Fprintf(os.Stderr, "error generating config: %v\n", err)
        os.Exit(1)
    }

    fmt.Println(config)
}

这个文件定义了命令行参数，并调用 app.GenerateConfig 函数生成配置文件。

3. 项目的配置文件介绍

Prometheus Adapter 的配置文件用于定义如何从 Prometheus 获取指标，并将其暴露给 Kubernetes。配置文件的示例如下：

rules:
  default: false
  custom:
  - seriesQuery: 'http_requests_total{namespace!="",pod!=""}'
    resources:
      overrides:
        namespace: {resource: "namespace"}
        pod: {resource: "pod"}
    name:
      matches: "http_requests_total"
    metricsQuery: 'sum(rate(<<.Series>>{<<.LabelMatchers>>}[5m])) by (<<.GroupBy>>)'

• rules: 定义如何发现和暴露指标。
• seriesQuery: 用于从 Prometheus 查询指标。
• resources: 定义如何将指标与 Kubernetes 资源关联。
• name: 定义指标的名称。
• metricsQuery: 定义如何计算指标。

通过这个配置文件，Prometheus Adapter 可以将 Prometheus 中的指标暴露给 Kubernetes，以便在 HPA（Horizontal Pod Autoscaler）中使用。