DocsICP FilingConsole
Documentation

Create an APM Server instance

Updated at:
Copy as MD
Product
My Favorites

Alibaba Cloud Elasticsearch provides managed application performance monitoring (APM) Server instances. You can create these instances with a single click and then efficiently scale and configure them. A single APM Server node can typically process data from hundreds of APM agents. This topic describes how to create an APM Server instance.

Prerequisites

An Elasticsearch instance of version 7.10 has been created. For more information, see Create an Alibaba Cloud Elasticsearch instance.

  • The Elasticsearch instance must be in the same region and zone as the APM Server instance.

  • The Elasticsearch instance must be of the Advanced Edition to support the low-cost, high-volume data writes and storage required in APM scenarios. For more information, see Parameters on the purchase page (Advanced Edition).

Procedure

  1. Log on to the Alibaba Cloud Elasticsearch console.

  2. Go to the Application Performance Monitoring (APM) console.

    1. In the top navigation bar, select a region.

    2. In the left-side navigation pane, clickAPMApplication Performance Monitoring.

  3. On the APM Server Management page, click Create APM Server.

  4. On the purchase page, configure the parameters for the APM Server.

    Parameter

    Description

    Region

    The region where the APM Server instance resides. Currently, only China (Hangzhou), China (Shenzhen), China (Beijing), China (Shanghai), and China (Zhangjiakou) are supported. The regions that are available are displayed in the console.

    Zone

    The zone where the APM Server instance resides. The available zones are displayed on the page.

    Virtual Private Cloud (VPC)

    The VPC where the APM Server instance resides.

    Note

    The APM agent must be in the same VPC as the APM Server instance.

    Virtual Switch

    Only virtual switches that are in the selected zone and VPC are displayed. If no virtual switches are available, see Create a VPC with an IPv4 CIDR block to create one.

    Server Version

    Only 7.10.2 is supported.

    Server Node Specifications

    1-core 2 GB and 2-core 4 GB are supported.

    Number of Server Nodes

    Select the number of nodes for the APM Server instance.

    Instance Name

    The name must be 0 to 30 characters in length. It must start with a letter or a digit and can contain underscores (_) and hyphens (-).

    User Password Settings

    The access password for the APM Server instance.

    Associated Elasticsearch Instance

    Only Alibaba Cloud Elasticsearch instances of version 7.10 that are in the selected region and zone are displayed.

    ES Access Username

    The username for accessing the selected Elasticsearch instance. The default username is elastic. If you want to use a custom user, you must assign the required roles and permissions to the user. For more information, see Manage user permissions using Elasticsearch X-Pack roles.

    ES Access Password

    The password for the user. The password for the elastic user is set when you create the instance. If you forget the password, you can reset it. For information about the notes and steps for resetting the password, see Reset the access password of an instance.

    Important

    If the username or password is incorrect, or if the Elasticsearch cluster is unhealthy, the connectivity check for the Elasticsearch instance fails when you create the APM Server instance.

  5. Read and select the Terms of Service, and then click Buy Now.

  6. View the created APM Server instance.

    1. On the page that appears after the service is activated, click Management Console.

    2. On the APM Server Management page, you can view the APM Server instance that you created.

      On the APM Server Management page, you can modify the configuration file, change the instance configuration, and stop or delete the instance. For more information, see Manage an APM Server instance.

What to do next

Log on to the Kibana console of the Elasticsearch instance that is associated with the APM Server. For more information, see Log on to the Kibana console. Then, run the following script to enable the automatic creation of the APM onboarding index.

Note

  • After an APM Server instance is created, its service starts automatically. After the service starts, Elasticsearch automatically creates APM-related indexes, which you can view in the Kibana console. However, the name of the APM onboarding index does not comply with the naming conventions for automatically created indexes in Alibaba Cloud Elasticsearch. Therefore, you must manually enable the automatic creation of the APM onboarding index.

  • In the following script, 7.10.2 is the version number of your APM Server instance.

PUT _cluster/settings
{
  "persistent": {
    "action.auto_create_index":"+.*,+apm-7.10.2-onboarding-*,-*"
  }
}