平台工程与开发者体验：构建自助式内部开发者平台

# Backstage组件配置（catalog-info.yaml）
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: user-service
  description: "用户管理服务"
  annotations:
    backstage.io/techdocs-ref: dir:.
    github.com/project-slug: my-org/user-service
    prometheus.io/rule: alertname="HighErrorRate",job="user-service"
spec:
  type: service
  lifecycle: production
  owner: team-backend
  system: e-commerce-platform
  providesApis:
    - user-api
  consumesApis:
    - payment-api
    - notification-api
---
apiVersion: backstage.io/v1alpha1
kind: API
metadata:
  name: user-api
  description: "用户管理API"
spec:
  type: openapi
  lifecycle: production
  owner: team-backend
  definition:
    $text: ./api/openapi.yaml

// Backstage插件开发示例
import { createPlugin, createRoutableExtension } from '@backstage/core-plugin-api';
import { rootRouteRef } from './routes';

export const deploymentPlugin = createPlugin({
  id: 'deployment',
  routes: {
    root: rootRouteRef,
  },
});

export const DeploymentPage = deploymentPlugin.provide(
  createRoutableExtension({
    name: 'DeploymentPage',
    component: () =>
      import('./components/DeploymentPage').then(m => m.DeploymentPage),
    mountPoint: rootRouteRef,
  }),
);

# 微服务模板定义
apiVersion: scaffolder.backstage.io/v1beta3
kind: Template
metadata:
  name: microservice-template
  title: "微服务模板"
  description: "创建标准化的微服务项目"
  tags:
    - go
    - microservice
    - recommended
spec:
  owner: platform-team
  type: service
  
  parameters:
    - title: 基本信息
      required:
        - name
        - owner
      properties:
        name:
          title: 服务名称
          type: string
          description: "服务名称（小写字母、数字、连字符）"
          pattern: '^[a-z0-9-]+$'
        
        owner:
          title: 负责团队
          type: string
          ui:field: OwnerPicker
          ui:options:
            allowedKinds:
              - Group
        
        description:
          title: 服务描述
          type: string
    
    - title: 技术栈
      required:
        - language
        - database
      properties:
        language:
          title: 编程语言
          type: string
          enum:
            - go
            - java
            - nodejs
            - python
        
        database:
          title: 数据库
          type: string
          enum:
            - postgresql
            - mysql
            - mongodb
        
        enableGrpc:
          title: 启用gRPC
          type: boolean
          default: false
  
  steps:
    - id: fetch-template
      name: 获取模板
      action: fetch:template
      input:
        url: ./skeleton
        values:
          name: ${{ parameters.name }}
          owner: ${{ parameters.owner }}
          description: ${{ parameters.description }}
          language: ${{ parameters.language }}
          database: ${{ parameters.database }}
          enableGrpc: ${{ parameters.enableGrpc }}
    
    - id: create-repo
      name: 创建代码仓库
      action: publish:github
      input:
        allowedHosts: ['github.com']
        repoUrl: github.com?owner=my-org&repo=${{ parameters.name }}
        defaultBranch: main
    
    - id: register
      name: 注册到服务目录
      action: catalog:register
      input:
        repoContentsUrl: ${{ steps['create-repo'].output.repoContentsUrl }}
        catalogInfoPath: '/catalog-info.yaml'
  
  output:
    links:
      - title: 代码仓库
        url: ${{ steps['create-repo'].output.remoteUrl }}
      - title: 服务目录
        icon: catalog
        entityRef: ${{ steps['register'].output.entityRef }}

# 数据库自助申请模板
apiVersion: scaffolder.backstage.io/v1beta3
kind: Template
metadata:
  name: database-provision
  title: "申请数据库"
  description: "自助申请PostgreSQL数据库实例"
spec:
  owner: platform-team
  type: infrastructure
  
  parameters:
    - title: 数据库配置
      required:
        - name
        - environment
        - size
      properties:
        name:
          title: 数据库名称
          type: string
        
        environment:
          title: 环境
          type: string
          enum:
            - development
            - staging
            - production
        
        size:
          title: 规格
          type: string
          enum:
            - small
            - medium
            - large
          enumNames:
            - "小型（2核4G，100GB）"
            - "中型（4核8G，500GB）"
            - "大型（8核16G，1TB）"
        
        backupEnabled:
          title: 启用自动备份
          type: boolean
          default: true
  
  steps:
    - id: provision
      name: 创建数据库
      action: terraform:apply
      input:
        modulePath: ./modules/postgresql
        variables:
          name: ${{ parameters.name }}
          environment: ${{ parameters.environment }}
          size: ${{ parameters.size }}
          backup_enabled: ${{ parameters.backupEnabled }}
    
    - id: notify
      name: 发送通知
      action: slack:send-message
      input:
        channel: '#infrastructure-requests'
        message: |
          数据库已创建：${{ parameters.name }}
          环境：${{ parameters.environment }}
          规格：${{ parameters.size }}
          连接信息已发送到申请者的邮箱
  
  output:
    text:
      - title: 连接信息
        content: |
          Host: ${{ steps.provision.outputs.host }}
          Port: ${{ steps.provision.outputs.port }}
          Database: ${{ steps.provision.outputs.database }}
          Username: ${{ steps.provision.outputs.username }}
          Password: (已发送到邮箱)

# devcontainer配置（.devcontainer/devcontainer.json）
{
  "name": "Go Microservice",
  "image": "mcr.microsoft.com/devcontainers/go:1.21",
  
  "features": {
    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
    "ghcr.io/devcontainers/features/kubectl-helm-minikube:1": {}
  },
  
  "postCreateCommand": "make dev-setup",
  
  "customizations": {
    "vscode": {
      "extensions": [
        "golang.go",
        "ms-azuretools.vscode-docker",
        "ms-kubernetes-tools.vscode-kubernetes-tools"
      ],
      "settings": {
        "go.toolsManagement.checkForUpdates": "local",
        "go.useLanguageServer": true,
        "go.gopath": "/go"
      }
    }
  },
  
  "forwardPorts": [8080, 5432, 6379],
  
  "portsAttributes": {
    "8080": { "label": "API Server" },
    "5432": { "label": "PostgreSQL" },
    "6379": { "label": "Redis" }
  }
}

# 标准化Makefile模板
.PHONY: dev test build deploy

# 开发环境
dev:
	docker-compose up -d
	go run cmd/server/main.go

# 测试
test:
	go test -v -race -coverprofile=coverage.out ./...
	go tool cover -html=coverage.out -o coverage.html

test-integration:
	go test -v -tags=integration ./test/integration/...

# 构建
build:
	docker build -t $(IMAGE_NAME):$(VERSION) .

# 部署
deploy-dev:
	kubectl apply -f k8s/dev/

deploy-staging:
	kubectl apply -f k8s/staging/

deploy-prod:
	@echo "请通过GitOps流程部署到生产环境"

# 代码质量
lint:
	golangci-lint run

format:
	gofmt -w .
	goimports -w .

# 数据库迁移
migrate-up:
	goose -dir migrations postgres "$(DB_URL)" up

migrate-down:
	goose -dir migrations postgres "$(DB_URL)" down

# Prometheus ServiceMonitor（自动创建）
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: ${service-name}-monitor
  labels:
    app: ${service-name}
spec:
  selector:
    matchLabels:
      app: ${service-name}
  endpoints:
    - port: metrics
      interval: 15s
      path: /metrics
---
# 默认告警规则
apiVersion: monitoring.coreos.com/v1
kind: PrometheusRule
metadata:
  name: ${service-name}-alerts
spec:
  groups:
    - name: ${service-name}
      rules:
        - alert: HighErrorRate
          expr: |
            rate(http_requests_total{service="${service-name}", status=~"5.."}[5m])
            /
            rate(http_requests_total{service="${service-name}"}[5m]) > 0.05
          for: 5m
          labels:
            severity: critical
          annotations:
            summary: "高错误率告警"
            description: "${service-name} 错误率超过5%"
        
        - alert: HighLatency
          expr: |
            histogram_quantile(0.95, rate(http_request_duration_seconds_bucket{service="${service-name}"}[5m])) > 1
          for: 5m
          labels:
            severity: warning
          annotations:
            summary: "高延迟告警"
            description: "${service-name} P95延迟超过1秒"

// 平台工程指标采集
interface PlatformMetrics {
  // 开发者效率指标
  leadTime: number;              // 从代码提交到生产部署的时间
  deploymentFrequency: number;   // 每周部署次数
  changeFailureRate: number;     // 变更失败率
  meanTimeToRecovery: number;    // 平均恢复时间
  
  // 平台使用指标
  selfServiceRate: number;       // 自助服务比例
  ticketVolume: number;          // 工单数量
  timeToFirstDeploy: number;     // 新服务首次部署时间
  
  // 开发者满意度
  developerNPS: number;          // 开发者NPS分数
  onboardingTime: number;        // 新员工上手时间
}

// 定期调研问卷
const surveyQuestions = [
  {
    question: "使用IDP部署新服务的体验如何？",
    type: "rating",
    scale: 1-5
  },
  {
    question: "平台文档是否清晰易懂？",
    type: "rating",
    scale: 1-5
  },
  {
    question: "你希望平台增加哪些功能？",
    type: "open-text"
  }
];