stackify/retrace

Stackify Retrace Container 镜像文档

镜像概述和主要用途

Stackify Retrace Container旨在解决无法在Docker主机系统安装Stackify Linux Agent时，通过Docker或Kubernetes容器环境部署Retrace的需求。Retrace是应用性能监控工具，该容器化方案支持在容器集群中实现Retrace的集成与运行，适用于Docker和Kubernetes环境。

核心功能和特性

• 跨环境支持：兼容Docker容器和Kubernetes集群部署
• 多语言集成：支持Java、PHP、NodeJS、Ruby、.Net Core等多种应用类型的Stackify Profiler
• 数据共享机制：通过卷挂载实现Retrace容器与应用容器间的数据共享
• Kubernetes适配：提供DaemonSet配置确保集群节点全覆盖，包含RBAC权限配置
• 自动重启：Docker部署支持--restart always确保服务持续运行

使用场景和适用范围

适用于无法在Docker主机安装Stackify Linux Agent的容器化环境，需对应用进行性能监控的场景，包括独立Docker容器部署和Kubernetes集群部署。

使用方法和配置说明

Kubernetes部署指南

设置Retrace守护进程集（DaemonSet）

通过以下配置部署Retrace DaemonSet，确保集群中每个节点运行Retrace容器。

1. 替换占位符：将YOUR_ACTIVATION_KEY、YOUR_ENVIRONMENT_NAME、YOUR_KUBERNETES_CLUSTER_NAME替换为实际值
2. 镜像调整：如需使用私有仓库，更新image: stackify/retrace为私有仓库地址

yaml
---
apiVersion: v1
kind: ServiceAccount
metadata:
  name: stackify
  namespace: default
automountServiceAccountToken: true
---
apiVersion: rbac.authorization.k8s.io/v1beta1
kind: ClusterRole
metadata:
  name: stackify
rules:
- apiGroups: [""]
  resources:
    - "pods"
    - "services"
  verbs: ["get", "list"]
---
apiVersion: rbac.authorization.k8s.io/v1beta1
kind: ClusterRoleBinding
metadata:
  name: stackify
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: stackify
subjects:
- kind: ServiceAccount
  name: stackify
  namespace: default
---
apiVersion: apps/v1
kind: DaemonSet
metadata:
  name: stackify-retrace
spec:
  template:
    metadata:
      labels:
        app: stackify-retrace
    spec:
      serviceAccountName: stackify
      containers:
        - name: stackify-retrace
          image: stackify/retrace
          securityContext:
            runAsUser: 0
          env:
            - name: STACKIFY_KEY
              value: "YOUR_ACTIVATION_KEY"
            - name: STACKIFY_ENV
              value: "YOUR_ENVIRONMENT_NAME"
            - name: STACKIFY_K8S_CLUSTER_NAME
              value: "YOUR_KUBERNETES_CLUSTER_NAME"
          volumeMounts:
            - name: hostfs
              mountPath: /hostfs
              readOnly: true
            - name: stackify
              mountPath: /var/stackify
              readOnly: false
      volumes:
        - name: hostfs
          hostPath:
            path: /
        - name: stackify
          hostPath:
            path: /var/stackify
            type: DirectoryOrCreate

故障排除

Google Cloud环境

确保用户具有创建ServiceAccount的权限：

bash
kubectl create clusterrolebinding cluster-admin-binding --clusterrole=cluster-admin --user $(gcloud config get-value account)

Kubernetes版本<1.9

将DaemonSet的apiVersion修改为：

yaml
apiVersion: extensions/v1beta1

配置应用Pod

为应用Pod配置Stackify卷和卷挂载，集成对应语言的Stackify Profiler（忽略"Install Retrace"步骤）。

支持的应用类型及Profiler文档：

• Java
• PHP
• NodeJS
• Ruby
• .Net Core

Pod配置示例：

1. 为每个Pod定义stackify卷：

yaml
volumes:
  - name: stackify
    hostPath: 
      path: /var/stackify
      type: DirectoryOrCreate

2. 为每个容器定义卷挂载：

yaml
volumeMounts:
  - mountPath: /usr/local/stackify
    name: stackify

完整应用Pod配置示例：

yaml
apiVersion: v1
kind: ReplicationController
metadata:
  name: pod-name
spec:
  replicas: 1
  selector:
    app: app-name
  template:
    metadata:
      name: template-name
      labels:
        app: app-name
    spec:
      containers:
      - name: container-name
        image: application-image
        volumeMounts:
          - mountPath: /usr/local/stackify
            name: stackify
      volumes:
        - name: stackify
          hostPath: 
            path: /var/stackify
            type: DirectoryOrCreate

验证部署

向应用发送请求，在Retrace仪表板中确认监控数据正常显示。

Docker部署指南

创建Stackify卷

bash
docker volume create stackify

启动Retrace容器

bash
docker run -d --restart always \
 -e "STACKIFY_KEY=YOUR_ACTIVATION_KEY" \
 -e "STACKIFY_ENV=YOUR_ENVIRONMENT_NAME" \
 -v stackify:/var/stackify \
 -v /:/hostfs:ro \
 --user 0:0 \
 stackify/retrace:latest 

注意：替换YOUR_ACTIVATION_KEY和YOUR_ENVIRONMENT_NAME为实际值

启动应用容器

配置应用容器挂载stackify卷，集成对应语言的Stackify Profiler（忽略"Install Retrace"步骤）：

bash
docker run -v stackify:/usr/local/stackify [application-image]

验证部署

向应用发送请求，在Retrace仪表板中确认监控数据正常显示。