Get started with Managed Service for OpenTelemetry

Updated at:

Managed Service for OpenTelemetry accepts trace data from OpenTelemetry, Jaeger, Zipkin, and SkyWalking clients. This guide walks you through activating the service, retrieving your authentication token, and connecting your application to start sending traces.

Prerequisites

Retrieve your authentication token

After you activate the service, retrieve a token to authenticate the trace data your application sends. The steps differ between the new and old console versions.

New console

  1. Log on to the Managed Service for OpenTelemetry console.

  2. In the left-side navigation pane, click Integration Center.

  3. In the Open Source Frameworks section, click the OpenTelemetry card or the card for the client you want to use.

  4. In the panel that appears, copy your token.

    In the panel that appears, complete the following configuration: select a region, for example, China (Hangzhou). For the connection method, select the private endpoint for applications deployed in an Alibaba Cloud production environment, or the public endpoint for other applications. For the report method, select HTTP (recommended) or gRPC. After the configuration is complete, obtain the endpoint URL in the Access point information section. For example, if you report data over HTTP, copy the private endpoint. The endpoint URL contains the token.

Old console

  1. Log on to the Managed Service for OpenTelemetry console.

  2. In the left-side navigation pane, click Cluster Configurations, then click the Access point information tab.

  3. Select a region at the top of the page, then turn on the Show Token switch in the Cluster Information section.

  4. In the Client section, select OpenTelemetry or the client you want to use.

  5. Copy the endpoint from the Related Information column.

    Taking OpenTelemetry as an example, the Related Information column displays the following access point information:

    • Report data over HTTP: A public endpoint and a private endpoint are provided. The URL is in the following format: http://tracing-analysis-dc-{region}.aliyuncs.com/adapt_{token}/api/otlp/traces.

    • Report data over gRPC: A public endpoint (port 8090), a private endpoint (port 8090), and the authentication token are provided.

    • Tip at the bottom: If you use Golang to report data, remove http:// from the endpoint.

Token usage by protocol

How your application passes the token depends on the protocol:

  • HTTP-based protocols (OpenTelemetry HTTP, Jaeger HTTP, Zipkin HTTP): The token is embedded in the endpoint URL.

  • gRPC-based protocols (OpenTelemetry gRPC, Jaeger gRPC, SkyWalking gRPC): Set Authentication=<token> in the gRPC metadata.

Connect your application

Choose an endpoint

Each region provides two endpoint types:

  • Private endpoint: For applications deployed in an Alibaba Cloud production environment.

  • Public endpoint: For applications running outside Alibaba Cloud.

Supported protocols and ports

All protocols share the same endpoint domain. Port number and URL path distinguish each protocol.

PortProtocolURL path
8090OpenTelemetry gRPCN/A
80OpenTelemetry HTTP/api/otlp/traces
80Jaeger HTTP/api/traces
80Jaeger Remote Sampling/api/sampling
80Zipkin HTTP v1/api/v1/spans
80Zipkin HTTP v2/api/v2/spans
443OpenTelemetry HTTPS/api/otlp/traces
443Jaeger HTTPS/api/traces
443Jaeger Remote Sampling (HTTPS)/api/sampling
443Zipkin HTTPS v1/api/v1/spans
443Zipkin HTTPS v2/api/v2/spans
1883Jaeger gRPCN/A
1883SkyWalking gRPCN/A
8000SkyWalking v8 gRPCN/A

Regions and endpoints

Note

For applications deployed in an Alibaba Cloud production environment, use a private endpoint. Otherwise, use a public endpoint.

RegionRegion IDPrivate endpointPublic endpoint
China (Hangzhou)cn-hangzhoutracing-analysis-dc-hz-internal.aliyuncs.comtracing-analysis-dc-hz.aliyuncs.com
China (Shanghai)cn-shanghaitracing-analysis-dc-sh-internal.aliyuncs.comtracing-analysis-dc-sh.aliyuncs.com
China (Qingdao)cn-qingdaotracing-analysis-dc-qd-internal.aliyuncs.comtracing-analysis-dc-qd.aliyuncs.com
China (Beijing)cn-beijingtracing-analysis-dc-bj-internal.aliyuncs.comtracing-analysis-dc-bj.aliyuncs.com
China (Zhangjiakou)cn-zhangjiakoutracing-analysis-dc-zb-internal.aliyuncs.comtracing-analysis-dc-zb.aliyuncs.com
China (Hohhot)cn-huhehaotetracing-cn-huhehaote-internal.arms.aliyuncs.comtracing-cn-huhehaote.arms.aliyuncs.com
China (Ulanqab)cn-wulanchabutracing-cn-wulanchabu-internal.arms.aliyuncs.comtracing-cn-wulanchabu.arms.aliyuncs.com
China (Shenzhen)cn-shenzhentracing-analysis-dc-sz-internal.aliyuncs.comtracing-analysis-dc-sz.aliyuncs.com
China (Heyuan)cn-heyuantracing-cn-heyuan-internal.arms.aliyuncs.comtracing-cn-heyuan.arms.aliyuncs.com
China (Guangzhou)cn-guangzhoutracing-cn-guangzhou-internal.arms.aliyuncs.comtracing-cn-guangzhou.arms.aliyuncs.com
China (Chengdu)cn-chengdutracing-cn-chengdu-internal.arms.aliyuncs.comtracing-cn-chengdu.arms.aliyuncs.com
China (Hong Kong)cn-hongkongtracing-analysis-dc-hk-internal.aliyuncs.comtracing-analysis-dc-hk.aliyuncs.com
Japan (Tokyo)ap-northeast-1tracing-analysis-dc-jp-internal.aliyuncs.comtracing-analysis-dc-jp.aliyuncs.com
Singaporeap-southeast-1tracing-analysis-dc-sg-internal.aliyuncs.comtracing-analysis-dc-sg.aliyuncs.com
Malaysia (Kuala Lumpur)ap-southeast-3tracing-ap-southeast-3-internal.arms.aliyuncs.comtracing-ap-southeast-3.arms.aliyuncs.com
Indonesia (Jakarta)ap-southeast-5tracing-analysis-dc-indonesia-internal.aliyuncs.comtracing-analysis-dc-indonesia.aliyuncs.com
Germany (Frankfurt)eu-central-1tracing-analysis-dc-frankfurt-internal.aliyuncs.comtracing-analysis-dc-frankfurt.aliyuncs.com
UK (London)eu-west-1tracing-analysis-dc-lundun-internal.aliyuncs.comtracing-analysis-dc-lundun.aliyuncs.com
US (Silicon Valley)us-west-1tracing-analysis-dc-usw-internal.aliyuncs.comtracing-analysis-dc-usw.aliyuncs.com
US (Virginia)us-east-1tracing-us-east-1-internal.arms.aliyuncs.comtracing-us-east-1.arms.aliyuncs.com

Network requirements for non-Alibaba Cloud applications

If your application runs outside Alibaba Cloud, make sure the following ports and domains are reachable from your network before sending trace data.

Ports to allow:

PortProtocol
8090OpenTelemetry gRPC
80OpenTelemetry HTTP, Jaeger HTTP
443OpenTelemetry HTTPS, Jaeger HTTPS, Zipkin HTTPS
1883Jaeger gRPC, SkyWalking gRPC
8000SkyWalking v8 gRPC

Domains to allow: Use the public endpoint domain for your region from the Regions and endpoints table above.