You need to enable JavaScript to run this app.
文档中心
应用性能监控全链路版

应用性能监控全链路版

复制全文
下载 pdf
常见问题
如何使用接入中心?
复制全文
下载 pdf
如何使用接入中心?
接入中心不仅可以快速获取 App Key 等应用接入相关配置信息,而且提供详细的应用接入步骤指南和配置示例,本文以 Java 应用为例为您介绍如何参考接入中心指引快速接入应用。
背景信息
应用性能监控提供以下 3 种接入方式,可根据应用语言和实际场景选择合适的接入方式:
  • 通过 OpenTelemetry 接入(推荐):在 VKE 集群中安装 apmplus-opentelemetry-collectorapmplus-server-agent 组件,通过 VKE 集群快速开启数据上报。其中,提供自动注入和手动 SDK 埋点两种 OpenTelemetry 数据上报配置。
  • 自动注入:组件安装完成后,在对应服务的工作负载配置中增加 annotation 即可完成配置。例如:在 Java 应用对应服务 Deployment Yaml 配置的 spec.template.metadata.annotations 位置增加 instrumentation.apmplus.volcengine.com/inject-java: 'true' 注解。更多说明示例参见:通过探针自动接入数据
  • 手动 SDK 埋点:组件安装完成后,使用已经获取的 Collector endpoint 地址上报数据。更多说明示例参见:通过 SDK 手动接入数据
  • 通过 Skywalking、Zipkin 或 Jaeger 接入:获取 APMPlus endpoint 地址和 App Key,通过域名上报数据到 APMPlus。
  • 本地代码直接配置上传数据:获取 APMPlus endpoint 地址和 App Key,通过域名上报数据到 APMPlus。
前提条件
  • 若通过 OpenTelemetry 方式接入,确保已经在 VKE 集群中成功安装 apmplus-opentelemetry-collectorapmplus-server-agent 组件。组件安装相关详细说明参见:安装组件
操作步骤
步骤一:获取配置信息
获取 App Key 信息
虽然认证信息 App Key 不区分接入的服务类型和数据采集方式,但不同工作区的认证信息 App Key 各不相同。可参考以下步骤获取 App Key:
  1. 单击 点击进入服务列表,进入服务管理页面。
  1. 在左侧导航栏选择 接入中心,并指定工作区,在服务接入信息中获取 App Key。
获取 annotation 信息
若通过 OpenTelemetry 方式自动注入数据,需要在对应服务的 Yaml 配置 spec.template.metadata.annotations 位置增加 annotation。不同语法对应的 annotation 不同,常见 annotation 如下:
语法
注解(annotation)
Java
instrumentation.apmplus.volcengine.com/inject-java: 'true'
Python
instrumentation.apmplus.volcengine.com/inject-python: 'true'
Nodejs
instrumentation.apmplus.volcengine.com/inject-nodejs: 'true'
以 Java 应用自动注入为例,annotation 在 Yaml 中的位置如下:
apiVersion: apps/v1
kind: Deployment
metadata:
name: simple-java
labels:
app: simple-java
spec:
replicas: 1
selector:
matchLabels:
app: simple-java
template:
metadata:
labels:
app: simple-java
annotations:
instrumentation.apmplus.volcengine.com/inject-java: 'true'
spec:
containers:
- name: simple-java
image: java_demo_simple
imagePullPolicy: Always
env:
- name: CONTAINER_RUNTIME
value: "k8s"
获取 Collector endpoint 信息
若通过 OpenTelemetry 方式接入应用,在 VKE 集群中成功安装 apmplus-opentelemetry-collectorapmplus-server-agent 组件后,将自动安装 collector 并暴露 Collector endpoint 信息,供数据上报使用。
不同地域对应的 Collector endpoint 地址相同,但不同协议对应的 Collector endpoint 地址不同,详情如下:
协议
Collector endpoint
HTTP 协议
https://apmplus-opentelemetry-gateway-service-http.apmplus-opentelemetry-operator:4318
Grpc 协议
apmplus-opentelemetry-gateway-service-grpc.apmplus-opentelemetry-operator:4317
获取 APMPlus endpoint 信息
若无法使用 VKE 环境,无法安装 apmplus 相关组件,可使用 APMPlus endpoint,通过域名直接上报数据到应用性能监控。
说明
  • {region} 表示地域 ID,使用前确保已经替换为真实信息。不同地域的 ID 参见:开服地域
  • 通过域名直接上报数据到应用性能监控时,确保 header 中携带:"X-ByteAPM-AppKey": ${app_key}
  • 通过公网接入时,不同协议对应的 APMPlus endpoint 地址如下。
协议
APMPlus endpoint
HTTP 协议
https://apmplus-{region}.volces.com/api/otlp
Grpc 协议
apmplus-{region}.volces.com:4317
  • 通过 VPC 接入时,不同协议对应的 APMPlus endpoint 地址如下。
协议
APMPlus endpoint
HTTP 协议
https://apmplus-{region}.ivolces.com/api/otlp
Grpc 协议
apmplus-{region}.ivolces.com:4317
步骤二:查看接入指南
  1. 前往接入中心,根据实际场景使用的服务语言,选择合适的接入方式。
  1. 单击目标接入方式卡片中的 接入 按钮,查看目标接入方式支持的 监控系统数据采集方式
  1. 选择合适的数据采集方式后,根据接入指南提供的步骤逐步操作,即可完成数据上报和应用接入。
说明
接入指南中的配置代码中可能存在变量参数,需要替换成真实环境中的参数值才能正常使用。
后续操作
可参考接入中心中提供的接入指南进行应用接入,也可参考接入文档进行应用接入。不同语言的接入方式存在差异,更多详细介绍参见:接入指南
最近更新时间:2026.06.12 11:29:15
这个页面对您有帮助吗?
有用
有用
无用
无用