APM Server 二进制文件

Elastic Stack

本指南将说明如何设置和配置 APM Server 二进制文件。

首先，请参阅 Elastic 支持矩阵，了解有关支持的操作系统和产品兼容性的信息。

您需要

• 用于存储和索引数据的 Elasticsearch。
• 用于使用 Applications UI 可视化的 Kibana。

我们建议您使用相同版本的 Elasticsearch、Kibana 和 APM Server。有关安装这些产品的更多信息，请参阅 安装 Elastic Stack。

×

要下载和安装 APM Server，请使用以下适用于您系统的命令。如果您使用 apt 或 yum，您可以 从我们的存储库安装 APM Server，以便更轻松地更新到最新版本。

deb:

curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-9.0.0-amd64.deb
sudo dpkg -i apm-server-9.0.0-amd64.deb

RPM:

curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-9.0.0-x86_64.rpm
sudo rpm -vi apm-server-9.0.0-x86_64.rpm

其他 Linux:

curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-9.0.0-linux-x86_64.tar.gz
tar xzvf apm-server-9.0.0-linux-x86_64.tar.gz

Mac:

curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-9.0.0-darwin-x86_64.tar.gz
tar xzvf apm-server-9.0.0-darwin-x86_64.tar.gz

Windows:

1. 从 下载页面 下载 APM Server Windows zip 文件。

2. 将 zip 文件的内容解压缩到 C:\Program Files 中。

3. 将 apm-server-<version>-windows 目录重命名为 APM-Server。

4. 以管理员身份打开 PowerShell 提示符（右键单击 PowerShell 图标并选择 以管理员身份运行）。如果您运行的是 Windows XP，则可能需要下载并安装 PowerShell。

5. 从 PowerShell 提示符处，运行以下命令以将 APM Server 安装为 Windows 服务

Docker:

有关部署 Docker 容器，请参阅 在 Docker 上运行。

通过编辑 apm-server.yml 配置文件来配置 APM。此文件的位置因平台而异——请参阅 安装布局 以获取帮助。

一个最小的配置文件可能如下所示

apm-server:
  host: "localhost:8200"
output.elasticsearch:
  hosts: ["localhost:9200"]
  username: "elastic"
  password: "changeme"

1. APM Server 侦听的 host:port。
2. 要连接到的 Elasticsearch host:port。
3. 此示例使用基本身份验证。此处提供的用户需要具有将事件发布到 Elasticsearch 所需的权限。要为此角色创建专用用户，请参阅 创建写入者角色。

所有可用的配置选项都在 配置 APM Server 中进行了概述。

在生产环境中，您会将 APM Server 放在自己的机器上，类似于您运行 Elasticsearch 的方式。您可以在与 Elasticsearch 相同的机器上运行它，但不建议这样做，因为这些进程将争夺资源。

要启动 APM Server，请运行

./apm-server -e

您应该看到 APM Server 启动。它将尝试连接到 localhost 端口 9200 上的 Elasticsearch，并公开端口 8200 上的代理 API。您可以在 apm-server.yml 中更改默认值，或者在命令行上提供不同的地址

./apm-server -e -E output.elasticsearch.hosts=ElasticsearchAddress:9200 -E apm-server.host=localhost:8200

对于 Debian 软件包和 RPM 安装，我们建议 apm-server 进程以非 root 用户身份运行。因此，这些安装方法会创建一个 apm-server 用户，您可以用来启动该进程。此外，只有当配置文件 归运行该进程的用户所有 时，APM Server 才会启动。

在这种情况下，要启动 APM Server，请运行

sudo -u apm-server apm-server [<argument...>]

默认情况下，APM Server 从 /etc/apm-server/apm-server.yml 加载其配置文件。有关完整的目录布局，请参阅 deb & rpm 默认路径。

// Android app's build.gradle file
plugins {
    id "com.android.application"
    id "co.elastic.apm.android" version "[latest_version]"
}

// Android app's build.gradle file
plugins {
    //...
    id "co.elastic.apm.android" version "[latest_version]"
}

elasticApm {
    // Minimal configuration
    serverUrl = "https://your.elastic.server"

    // Optional
    serviceName = "your app name"
    serviceVersion = "0.0.0"
    apiKey = "your server api key"
    secretToken = "your server auth token"
}

// Your Application class

class MyApp extends android.app.Application {

    @Override
    public void onCreate() {
        super.onCreate();
        ElasticApmAgent.initialize(this);
    }
}

go get -u go.elastic.co/apm/v2

# The APM integration host and port
export ELASTIC_APM_SERVER_URL=

# If you do not specify `ELASTIC_APM_SERVICE_NAME`, the Go agent will use the
# executable name. For example, if your executable is called "my-app.exe", then your
# service will be identified as "my-app".
export ELASTIC_APM_SERVICE_NAME=

# Secret tokens are used to authorize requests to the APM integration
export ELASTIC_APM_SECRET_TOKEN=

Package(
    dependencies:[
         .package(name: "apm-agent-ios", url: "https://github.com/elastic/apm-agent-ios.git", from: "1.0.0"),
    ],
  targets:[
    .target(
        name: "MyApp",
        dependencies: [
            .product(name: "ElasticApm", package: "apm-agent-ios")
        ]
    ),
])

import SwiftUI
import ElasticApm

class AppDelegate : NSObject, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
        var config = AgentConfigBuilder()
            .withServerUrl(URL(string:"http://127.0.0.1:8200"))
            .withSecretToken("<SecretToken>")
            .build()

        ElasticApmAgent.start(with: config)
        return true
    }
}

@main
struct MyApp: App {
    @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
    init() {
    }
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

import UIKit
import ElasticApm
@main
class AppDelegate: UIResponder, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
var config = AgentConfigBuilder()
                       .withServerUrl(URL(string:"http://127.0.0.1:8200"))
                       .withSecretToken("<SecretToken>")
                       .build()
        ElasticApmAgent.start(with: config)
        return true
    }
}

java -javaagent:/path/to/elastic-apm-agent-<version>.jar -Delastic.apm.service_name=my-cool-service -Delastic.apm.application_packages=org.example,org.another.example -Delastic.apm.server_url=http://127.0.0.1:8200 -jar my-application.jar

npm install elastic-apm-node --save

// Add this to the VERY top of the first file loaded in your app
var apm = require('elastic-apm-node').start({
  // Override service name from package.json
  // Allowed characters: a-z, A-Z, 0-9, -, _, and space
  serviceName: '',

  // Use if APM integration requires a token
  secretToken: '',

  // Use if APM integration uses API keys for authentication
  apiKey: '',

  // Set custom APM integration host and port (default: http://127.0.0.1:8200)
  serverUrl: '',
})

rpm -ivh <package-file>.rpm

dpkg -i <package-file>.deb

apk add --allow-untrusted <package-file>.apk

cd apm-agent-php
# for linux glibc - libc distributions (Ubuntu, Redhat, etc)
export BUILD_ARCHITECTURE=linux-x86-64
# for linux with musl - libc distributions (Alpine)
export BUILD_ARCHITECTURE=linuxmusl-x86-64
# provide a path to php-config tool
export PHP_CONFIG=php-config

# build extensions
make -f .ci/Makefile build

# run extension tests
PHP_VERSION=`$PHP_CONFIG --version | cut -d'.' -f 1,2` make -f .ci/Makefile run-phpt-tests

# install agent extensions
sudo cp agent/native/_build/${BUILD_ARCHITECTURE}-release/ext/elastic_apm-*.so `$PHP_CONFIG --extension-dir`

# install automatic loader
sudo cp agent/native/_build/${BUILD_ARCHITECTURE}-release/loader/code/elastic_apm_loader.so `$PHP_CONFIG --extension-dir`

extension=elastic_apm_loader.so
elastic_apm.bootstrap_php_part_file=<repo root>/agent/php/bootstrap_php_part.php

$ pip install elastic-apm

# Add the agent to the installed apps
INSTALLED_APPS = (
  'elasticapm.contrib.django',
  # ...
)

ELASTIC_APM = {
  # Set required service name. Allowed characters:
  # a-z, A-Z, 0-9, -, _, and space
  'SERVICE_NAME': '',

  # Use if APM integration requires a token
  'SECRET_TOKEN': '',

  # Set custom APM integration host and port (default: http://localhost:8200)
  'SERVER_URL': '',
}

# To send performance metrics, add our tracing middleware:
MIDDLEWARE = (
  'elasticapm.contrib.django.middleware.TracingMiddleware',
  #...
)

$ pip install elastic-apm[flask]

# initialize using environment variables
from elasticapm.contrib.flask import ElasticAPM
app = Flask(__name__)
apm = ElasticAPM(app)

# or configure to use ELASTIC_APM in your application settings
from elasticapm.contrib.flask import ElasticAPM
app.config['ELASTIC_APM'] = {
  # Set required service name. Allowed characters:
  # a-z, A-Z, 0-9, -, _, and space
  'SERVICE_NAME': '',

  # Use if APM integration requires a token
  'SECRET_TOKEN': '',

  # Set custom APM integration host and port (default: http://localhost:8200)
  'SERVER_URL': '',
}

apm = ElasticAPM(app)

gem 'elastic-apm'

# config/elastic_apm.yml:

# Set service name - allowed characters: a-z, A-Z, 0-9, -, _ and space
# Defaults to the name of your Rails app
service_name: 'my-service'

# Use if APM integration requires a token
secret_token: ''

# Set custom APM integration host and port (default: http://localhost:8200)
server_url: 'http://localhost:8200'

# config.ru

app = lambda do |env|
  [200, {'Content-Type' => 'text/plain'}, ['ok']]
end

# Wraps all requests in transactions and reports exceptions
use ElasticAPM::Middleware

# Start an instance of the Agent
ElasticAPM.start(service_name: 'NothingButRack')

run app

# Gracefully stop the agent when process exits.
# Makes sure any pending transactions are sent.
at_exit { ElasticAPM.stop }

# config/elastic_apm.yml:

# Set service name - allowed characters: a-z, A-Z, 0-9, -, _ and space
# Defaults to the name of your Rack app's class.
service_name: 'my-service'

# Use if APM integration requires a token
secret_token: ''

# Set custom APM integration host and port (default: http://localhost:8200)
server_url: 'http://localhost:8200'

<script src="https://<your-cdn-host>.com/path/to/elastic-apm-rum.umd.min-<version>.js" crossorigin></script>
<script>
  elasticApm.init({
    serviceName: '<instrumented-app>',
    serverUrl: '<apm-server-url>',
  })
</script>

<script>
  ;(function(d, s, c) {
    var j = d.createElement(s),
      t = d.getElementsByTagName(s)[0]

    j.src = 'https://<your-cdn-host>.com/path/to/elastic-apm-rum.umd.min-<version>.js'
    j.onload = function() {elasticApm.init(c)}
    t.parentNode.insertBefore(j, t)
  })(document, 'script', {serviceName: '<instrumented-app>', serverUrl: '<apm-server-url>'})
</script>

npm install @elastic/apm-rum --save

import { init as initApm } from '@elastic/apm-rum'

const apm = initApm({

  // Set required service name (allowed characters: a-z, A-Z, 0-9, -, _, and space)
  serviceName: '',

  // Set custom APM integration host and port (default: http://localhost:8200)
  serverUrl: 'http://localhost:8200',

  // Set service version (required for sourcemap feature)
  serviceVersion: ''
})

一旦您至少有一个 APM Agent 向 APM Server 发送数据，您就可以开始在 Kibana Applications UI 中可视化您的数据。

×

我们为基于 APT 和 YUM 的发行版提供存储库。请注意，我们提供二进制包，但不提供源代码包。

我们使用 PGP 密钥 D88E42B4, Elasticsearch Signing Key, 指纹为

4609 5ACC 8548 582C 1A26 99A9 D27D 666C D88E 42B4

来签名我们所有的包。它可从 https://pgp.mit.edu 获得。

要为 APT 添加 apm-server 存储库

1. 下载并安装公共签名密钥

   wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
   

2. 在继续之前，您可能需要在 Debian 上安装 apt-transport-https 包

   sudo apt-get install apt-transport-https
   

3. 将存储库定义保存到 /etc/apt/sources.list.d/elastic-9.0.0.list

   echo "deb https://artifacts.elastic.co/packages/9.0.0-prerelease/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elastic-9.0.0-prerelease.list
   

   警告

   要添加 Elastic 存储库，请确保使用示例中显示的 echo 方法。不要使用 add-apt-repository，因为它会添加一个 deb-src 条目，但我们不提供源代码包。

   如果您错误地添加了 deb-src 条目，您将看到如下错误

   Unable to find expected entry 'main/source/Sources' in Release file (Wrong sources.list entry or malformed file)
   

4. 运行 apt-get update，存储库即可使用。例如，您可以通过运行以下命令安装 APM Server

   sudo apt-get update && sudo apt-get install apm-server
   

5. 要配置 APM Server 在启动时自动启动，请运行

   sudo systemctl enable apm-server
   

要为 YUM 添加 apm-server 存储库

1. 下载并安装公共签名密钥

   sudo rpm --import https://packages.elastic.co/GPG-KEY-elasticsearch
   

2. 在您的 /etc/yum.repos.d/ 目录中创建一个带有 .repo 扩展名的文件（例如，elastic.repo）并添加以下行

   [elastic-9.0.0]
   name=Elastic repository for 9.0.0 packages
   baseurl=https://artifacts.elastic.co/packages/9.0.0/yum
   gpgcheck=1
   gpgkey=https://artifacts.elastic.co/GPG-KEY-elasticsearch
   enabled=1
   autorefresh=1
   type=rpm-md
   

   您的存储库可以使用了。例如，您可以通过运行以下命令安装 APM Server

   sudo yum install apm-server
   

3. 要配置 APM Server 在启动时自动启动，请运行

   sudo systemctl enable apm-server
   

APM Server 的 Docker 镜像可从 Elastic Docker 注册表中获得。基本镜像为 ubuntu:22.04。

所有已发布的 Docker 镜像和标签的列表可在 www.docker.elastic.co 上获得。

这些镜像可以根据 Elastic 许可免费使用。它们包含开源和免费的商业功能，以及对付费商业功能的访问。开始 30 天试用 以试用所有付费商业功能。有关 Elastic 许可级别的信息，请参阅订阅页面。

获取 APM Server for Docker 就像针对 Elastic Docker 注册表发出 docker pull 命令，然后选择性地验证镜像一样简单。

1. 拉取 Docker 镜像

   docker pull docker.elastic.co/apm/apm-server:9.0.0
   

   或者，您可以使用强化的 Wolfi 镜像

   docker pull docker.elastic.co/apm/apm-server-wolfi:9.0.0
   

2. 验证 Docker 镜像

   wget https://artifacts.elastic.co/cosign.pub
   cosign verify --key cosign.pub docker.elastic.co/apm/apm-server:9.0.0
   

   cosign 命令以 JSON 格式打印检查结果和签名有效负载

   Verification for docker.elastic.co/apm/apm-server:9.0.0 --
   The following checks were performed on each of these signatures:
     - The cosign claims were validated
     - Existence of the claims in the transparency log was verified offline
     - The signatures were verified against the specified public key
   

Docker 镜像提供了几种配置 APM Server 的方法。传统方法是通过卷挂载提供配置文件，但也可以创建一个包含您的配置的自定义镜像。

下载此示例配置文件作为起点

curl -L -O https://raw.githubusercontent.com/elastic/apm-server/master/apm-server.docker.yml

在 Docker 上配置 APM Server 的一种方法是通过卷挂载提供 apm-server.docker.yml。使用 docker run，可以像这样指定卷挂载。

docker run -d \
  -p 8200:8200 \
  --name=apm-server \
  --user=apm-server \
  --volume="$(pwd)/apm-server.docker.yml:/usr/share/apm-server/apm-server.yml:ro" \
  docker.elastic.co/apm/apm-server:9.0.0 \
  --strict.perms=false -e \
  -E output.elasticsearch.hosts=["elasticsearch:9200"] <1>

1. 替换您的 Elasticsearch 主机和端口。
2. 如果您使用的是 Elastic Cloud Hosted，请使用前面显示的语法，用 Cloud ID 和 elastic 密码替换 -E output.elasticsearch.hosts 行。

之前下载的 apm-server.docker.yml 应该针对您的环境进行自定义。有关更多详细信息，请参阅配置 APM Server。编辑配置文件并对其进行自定义以匹配您的环境，然后重新部署您的 APM Server 容器。

可以将您的 APM Server 配置嵌入到自定义镜像中。以下是一个实现此目的的 Dockerfile 示例

FROM docker.elastic.co/apm/apm-server:9.0.0
COPY --chmod=0644 --chown=1000:1000 apm-server.yml /usr/share/apm-server/apm-server.yml